SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Send Tracing Data API

API for sending tracing data to SignalFx

Send Tracing Data

Sends tracing data to SignalFx

post /trace

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://ingest.eu0.signalfx.com/v1.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://ingest.signalfx.com/v1, SignalFx interprets the endpoint as pointing to the us0 realm.

https://ingest.{realm}.signalfx.com/v1/trace

Sends tracing data to SignalFx. The API accepts output from the following tracing frameworks:

  • Zipkin JSON v1 and JSON v2:
    • Set the Content-Type header parameter for the request to application/json.
    • In your request body, send an array of Span objects. You can find the format of a JSON v2 Span in the REST API documentation for the Zipkin v2 API hosted on SwaggerHub.
  • Jaeger Thrift:
    • Set the Content-Type header parameter to application/x-thrift.
    • In your request body, send a list of Span structs. You can find the format of a Span struct in the file jaeger.thrift, in the GitHub repo for Jaeger tracing.
header Parameters
X-SF-TOKEN
required
string

Authentication token. Must be an org token (referred to as an access token in the web UI)

Content-Type
required
string

Format of the request payload:

  • For Zipkin JSON1 and JSON2 data, use application/json
  • For Jaeger Thrift data, use application/x-thrift

Responses

200

Successful submittal of span data

Response Schema: application/json
invalid
object

Key-value pairs containing information about invalid spans:

  • key: String containing the reason the span was invalid
  • value: Array of span IDs that were invalid for this reason
valid
integer <int64>

Count of valid spans received

400

The request exceeded the organization's ingest quota

401

Authorization failure. One of the following occurred:

  • The request didn't contain a token.
  • The specified token wasn't an org token.
  • The specified token was invalid.
  • The administrator who created the token doesn't have authorization to ingest tracing data.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "invalid":
    {
    },
  • "valid": 0
}

© Copyright 2019 SignalFx.

Third-party license information