Create a DSP connection to SignalFx
To send data from a data pipeline in the to a SignalFx endpoint, you must first create a connection using the Connector for SignalFx. You can then use the connection in the Send Metrics Data to SignalFx or Send Trace Data to SignalFx sink functions to send data from your pipeline to your SignalFx endpoint.
Prerequisites
Before you can create the SignalFx connection, you must have the following:
- One of the following types of values for indicating your SignalFx endpoint:
- A public realm name, which is typically used with cloud-based SignalFx installations that are accessible via publicly available realm names. For example,
us1
. - A URL, which is typically used with non-public SignalFx endpoints. For example,
mysignalfx.myhostname.com
. - A comma-separated list of URLs, which is typically used with the SignalFx API and Ingest endpoints. For example,
api.myhostname.com,ingest.myhostname.com
.
IP addresses are not supported.
- A public realm name, which is typically used with cloud-based SignalFx installations that are accessible via publicly available realm names. For example,
- An organization-level access token for authenticating to your SignalFx endpoint. Search for "Work with access tokens" in the SignalFx Infrastructure Monitoring manual for more information about SignalFx access tokens.
If you don't have these credentials, ask your SignalFx administrator for assistance.
Steps
- In DSP, select the Connections tab and then click Create New Connection.
- Select Connector for SignalFx and then click Next.
- Complete the following fields:
Field Description Connection Name A unique name for your SignalFx connection. Description (Optional) A description of your SignalFx connection Endpoint Type The SignalFx endpoint type. - Set to
public_realm
to use a SignalFx public realm as an endpoint. - Set to
URL
to use a hostname as an endpoint. - Set to
multi_URL
to use the SignalFx API and Ingest hostnames as an endpoint.
This setting is case sensitive. All other values will fail validation.
Endpoint The SignalFx endpoint. - If Endpoint Type is set to
public_realm
, enter the SignalFx public realm. For example,us1
. - If Endpoint Type is set to
URL
, enter the hostname. For example,mysignalfx.myhostname.com
. IP addresses are not supported. - If Endpoint Type is set to
multi_URL
, enter the SignalFx API and Ingest hostnames as a comma separated list. For example,api.myhostname.com,ingest.myhostname.com
. IP addresses are not supported.
Org Token Your organization-level SignalFx access token used to authenticate to the SignalFx endpoint. - Set to
- Click Save.
Any credentials that you upload are transmitted securely by HTTPS, encrypted, and securely stored in a secrets manager.
If you're editing a connection that's being used by an active pipeline, you must reactivate that pipeline after making your changes. When you reactivate a pipeline, you must select where you want to resume data ingestion. See Using activation checkpoints to activate your pipeline in the Use the Data Stream Processor manual for more information.
You can now use your connection in one of the SignalFx sink functions at the end of your data pipeline to send data to SignalFx.
- For instructions on how to build a data pipeline, see the Building a pipeline chapter in the Use the manual. If you're planning to send metrics data to SignalFx, make sure that your data uses a compatible schema. See Formatting data into the SignalFx metrics schema.
- For information about the sink function for sending metrics data, see Send data to SignalFx (metrics) in the Function Reference manual.
- For information about the sink function for sending trace data, see Send data to SignalFx (trace) in the Function Reference manual.
Connecting SignalFx to your DSP pipeline | Formatting data into the SignalFx metrics schema |
This documentation applies to the following versions of Splunk® Data Stream Processor: 1.2.0, 1.2.1-patch02
Feedback submitted, thanks!