SignalFx Developers Guide

Introduction

The SignalFx API provides access to features of the SignalFx environment. Using the API, you can do the following:

  • Send metrics and metrics metadata to SignalFx

  • Update existing metrics

  • Send custom events to SignalFx

  • Create, retrieve, update, and delete charts, dashboards, and dashboard groups

  • Create, retrieve, update, and delete detectors that notify you of anomalies in the metrics you monitor

  • Send APM traces to SignalFx, and retrieve tracing data and service maps

  • Analyze metrics using SignalFlow

  • Integrate third-party web services, authentication services, and notification services with SignalFx

  • Manage your SignalFx instance (your organization)

Example: Send data to SignalFx

To do anything with the web UI or the API, you first need some data to look at. Although the most common mechanism for sending data to SignalFx is to use one of our integrations or libraries, you can also send data via the API. SignalFx persists this data for further use.

So, to experiment with SignalFx, start by sending some data, as shown in the following curl command:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
$ curl --request POST \
  --header "Content-Type: application/json" \
  --header "X-SF-TOKEN: <ORG_TOKEN>" \
  --data \
  '{ "gauge": [{
       "metric": "memory.free",
       "dimensions": { "host": "server1" },
       "value": 42
  }]}' \
  https://ingest.<REALM>.signalfx.com/v2/datapoint

Notes:

  • Replace <ORG_TOKEN> with an org token for your organization (in the web UI, an org token is called an access token). To learn how to obtain an access token, see the topic Working with access tokens in the product documentation.

  • When you send a REST request, you need to use the endpoint specific to your SignalFx realm. Replace <REALM> with the name of your realm, which you can find on your profile page in the SignalFx web UI. If you don’t include a realm and use https://ingest.signalfx.com/v2/datapoint, SignalFx interprets the endpoint as pointing to the us0 realm.

Start here

Regardless of what you want to do, start by reading Calling the API, which describes:

  • How to send requests to the API

  • How to authenticate with the API

  • Authorization considerations

  • General notes

Choose your task

Use the API to do the following:

Send data

As noted in Example: Send data to SignalFx, SignalFx ingests several types of data, and you can send it in several ways. To learn more:

Create and modify charts and dashboards

Create and modify the following:

  • Charts that display metrics

  • Dashboards and dashboard groups that organize your charts

To learn more, see Charts and Dashboards.

Create and modify anomalous condition detectors

Create and modify SignalFx components that watch for conditions you specify in incoming data. When the component detects a condition, it does the following:

  • Sets an alert flag

  • Sends you a message using third-party systems you configure

  • Records an event

  • Starts recording an incident

    Detectors also take action when the original condition is no longer true. The detector clears the alert, records another event, and sends you a message.

Retrieve metrics

Retrieve metrics stored in SignalFx. You can also retrieve metadata for your metrics. To learn more, see Retrieving Data.

Retrieve tracing data

Retrieve traces, spans, and servicemaps for trace data ingested by SignalFx. To learn more, see APM Tracing.

Retrieve events and incidents

Retrieve events and incidents created by detectors. To learn more, see Retrieving Data.

Integrate third-party systems

Use scripts or programs to integrate web service hosts, single sign-on (SSO) systems, and alerting systems. To learn more, see Integrations.

Analyze data

Do statistical analysis and computations on incoming metrics, using the SignalFlow engine. To learn more, see Using SignalFlow.

Manage your organization

Perform the following tasks to manage your SignalFx "account":

  • Add members to your account (your organization)

  • Create teams that have access to a particular dashboard or dashboard group (or both)

  • Manage org-level authentication tokens.

To learn more, see Administration.

© Copyright 2019 SignalFx.

Third-party license information