Splunk® Data Stream Processor

Function Reference

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Get data from Amazon CloudWatch

Use the Amazon CloudWatch source function to get metric events data from Amazon CloudWatch.

Prerequisites

Before you can use this function, you must create a connection. See Create a DSP connection to Amazon CloudWatch in the Connect to Data Sources and Destinations with the manual. When configuring this source function, set the connection_id argument to the ID of that connection.

Function output schema

This function outputs data pipeline metric events using the metrics schema.

For each metric in the body field, the function includes the following dimensions in addition to the ones that are part of the original payload:

  • AccountID: The ID of the AWS account associated with the metric. This dimension is omitted if the account ID cannot be retrieved.
  • Region: The AWS region associated with the metric.

The following is an example of a typical record from the read_from_aws_cloudwatch_metrics function:

{
"attributes": {
      "default_dimensions": {}
      },
"body": [
      {
      "dimensions": {
           "AccountID": "123412341234",
           "BucketName": "my-test-bucket",
           "FilterId": "EntireBucket",
           "Region": "us-east-1"
           },
      "name": "AWS/S3.4xxErrors.Maximum",
      "type": "g",
      "unit": "Count",
      "value": 0
      },
      {
      "dimensions": {
           "AccountID": "123412341234",
           "BucketName": "my-test-bucket",
           "FilterId": "EntireBucket",
           "Region": "us-east-1"
           },
      "name": "AWS/S3.4xxErrors.Sum",
      "type": "g",
      "unit": "Count",
      "value": 0
      }
      ],
"host": "aws_test_server",
"id": "2823738566644596",
"nanos": 0,
"source": "us-east-1:AWS/S3",
"sourcetype": "aws:cloudwatch:metrics",
"timestamp": 1598819400000
}

Required arguments

connection_id
Syntax: string
Description: The ID of your Amazon CloudWatch connection.
Example: "576205b3-f6f5-4ab7-8ffc-a4089a95d0c4"

Optional arguments

initial_position
Syntax: LATEST | TRIM_HORIZON
Description: The position in the data stream where you want to start reading data. Defaults to LATEST.
  • LATEST: Start reading data from the latest position on the data stream.
  • TRIM_HORIZON: Start reading data from the very beginning of the data stream.
Example: "LATEST"

SPL2 example

When working in the SPL View, you can write the function using arguments in this exact order.

| from read_from_aws_cloudwatch_metrics("my-connection-id", "TRIM_HORIZON") |... ;

Alternatively, you can use named arguments to declare arguments in any order. The following SPL2 example uses named arguments to specify the initial_position argument before the connection_id argument:

| from read_from_aws_cloudwatch_metrics(initial_position: "TRIM_HORIZON", connection_id: "my-connection-id") |... ;

If you want to use a mix of unnamed and named arguments in your functions, you need to list all unnamed arguments in the correct order before providing the named arguments.

Limitations of the Amazon CloudWatch source function

The Amazon CloudWatch source function uses scheduled data collection jobs to ingest data. See Limitations of scheduled data collection jobs for information about limitations that apply to all scheduled data collection jobs.

Last modified on 14 April, 2021
PREVIOUS
Get data from Ingest service
  NEXT
Get data from Amazon Kinesis Data Stream

This documentation applies to the following versions of Splunk® Data Stream Processor: 1.2.0, 1.2.1


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters