Consumers

Use this section to find example declarations and notes for supported consumers.

Splunk

Splunk

Required information:
  • Host: The address of the Splunk instance that runs the HTTP event collector (HEC).
  • Protocol: Check if TLS is enabled within the HEC settings Settings > Data Inputs > HTTP Event Collector.
  • Port: Default is 8088, this can be configured within the Global Settings section of the Splunk HEC.
  • API Key: An API key must be created and provided in the passphrase object of the declaration, refer to Splunk documentation for the correct way to create an HEC token.

Note

To see more information about using the HEC, see Splunk HTTP Event Collector documentation.

Example Declaration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
 {
     "My_Consumer": {
         "class": "Telemetry_Consumer",
         "type": "Splunk",
         "host": "192.0.2.1",
         "protocol": "http",
         "port": "8088",
         "passphrase": {
             "cipherText": "apikey"
         }
     }
 }

Microsoft Azure Log Analytics

Microsoft Azure

Required Information:
  • Workspace ID: Navigate to Log Analytics workspace > Advanced Settings > Connected Sources.
  • Shared Key: Navigate to Log Analytics workspace > Advanced Settings > Connected Sources and use the primary key.

Note

To see more information about sending data to Log Analytics, see HTTP Data Collector API documentation.

Example Declaration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 {
     "My_Consumer": {
         "class": "Telemetry_Consumer",
         "type": "Azure_Log_Analytics",
         "workspaceId": "workspaceid",
         "passphrase": {
             "cipherText": "sharedkey"
         }
     }
 }

Example Dashboard:

azure_log_analytics_dashboard

AWS Cloud Watch

Amazon Web Services

Required information:
  • Region: AWS region of the cloud watch resource.
  • Log Group: Navigate to Cloud Watch > Logs
  • Log Stream: Navigate to Cloud Watch > Logs > Your_Log_Group_Name
  • Access Key: Navigate to IAM > Users
  • Secret Key: Navigate to IAM > Users

Note

To see more information about creating and using IAM roles, see AWS Identity and Access Management (IAM) documentation.

Example Declaration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
 {
     "My_Consumer": {
         "class": "Telemetry_Consumer",
         "type": "AWS_CloudWatch",
         "region": "us-west-1",
         "logGroup": "f5telemetry",
         "logStream": "default",
         "username": "accesskey",
         "passphrase": {
             "cipherText": "secretkey"
         }
     }
 }

AWS S3

Amazon Web Services

Required Information:
  • Region: AWS region of the S3 bucket.
  • Bucket: Navigate to S3 to find the name of the bucket.
  • Access Key: Navigate to IAM > Users
  • Secret Key: Navigate to IAM > Users

Note

To see more information about creating and using IAM roles, see AWS Identity and Access Management (IAM) documentation.

Example Declaration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
 {
     "My_Consumer": {
         "class": "Telemetry_Consumer",
         "type": "AWS_S3",
         "region": "us-west-1",
         "bucket": "bucketname",
         "username": "accesskey",
         "passphrase": {
             "cipherText": "secretkey"
         }
     }
 }

Graphite

Graphite

Required Information:
  • Host: The address of the Graphite system.
  • Protocol: Check Graphite documentation for configuration.
  • Port: Check Graphite documentation for configuration.

Note

To see more information about installing Graphite, see Installing Graphite documentation. To see more information about Graphite events, see Graphite Events documentation.

1
2
3
4
5
6
7
8
9
 {
     "My_Consumer": {
         "class": "Telemetry_Consumer",
         "type": "Graphite",
         "host": "192.0.2.1",
         "protocol": "http",
         "port": "80"
     }
 }