v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

traces

Get span details.

Get details of a span with the given identifier.

get/v1/tracing/traces/{traceId}/spans/{spanId}

Path parameters

traceIdstring required

Identifier of the trace the span belongs to.

spanIdstring required

Identifier of the span to get the details.

Response

Details of the span with the given identifier.

idstring required

Identifier of the span.

parentIdstring

Identifier of the parent span, if any. If the span has no parent it's considered a root span.

operationNamestring required

The name of the operation given to the span.

resourcestring

The name of the resource attached to the span.

servicestring

The name of the service this span is part of.

serviceColorstring

Color hex code assigned to the service.

serviceTypestring

Defines type of service.

durationinteger required

Number of nanoseconds the span lasted.

startedAtstring date-time required

Date and time the span was started in the ISO 8601 / RFC3339 format.

kindstring

Span kind describes the relationship between the Span, its parents, and its children in a Trace. Possible values: CLIENT, SERVER, PRODUCER, CONSUMER, INTERNAL.

remoteServicestring

Name of the possible remote span's service.

remoteServiceColorstring

Color hex code assigned to the remote service.

remoteServiceTypestring

Defines type of service.

numberOfLinksinteger

Number of span links in this span.

errorMessagestring

Produced error message (could be a stack trace, database error code, ..)

fieldsobject

Fields attached to this span.

logsstring[]

Logs attached to this span.

Example response

{
  "id": "00000000002317A9",
  "parentId": "000000000003C7BE",
  "operationName": "retrieveAccount",
  "resource": "http.request",
  "service": "user-service",
  "serviceColor": "#fa41c6",
  "serviceType": "HTTP",
  "duration": 212957153,
  "startedAt": "2019-11-22T09:00:00Z",
  "status": {
    "code": "OK",
    "message": "404"
  },
  "kind": "SERVER",
  "remoteService": "external-service",
  "remoteServiceColor": "#fa41c6",
  "remoteServiceType": "HTTP",
  "info": {
    "type": "TraceHttpSpanInfo"
  },
  "numberOfLinks": 2,
  "errorMessage": "Exception in thread \"local[9]\" java.lang.OutOfMemoryError: Java heap space\n    at my.app.force.fields.SpaceShipForceField.main(SpaceShipForceField.java:17)\n",
  "fields": {
    "component": {
      "type": "StringTracingValue",
      "value": "http"
    },
    "http.request.method": {
      "type": "StringTracingValue",
      "value": "GET"
    },
    "url.full": {
      "type": "StringTracingValue",
      "value": "https://example.com/v1/users/123"
    },
    "http.response.status_code": {
      "type": "StringTracingValue",
      "value": "200"
    }
  },
  "criticalPathContribution": {
    "duration": 12957153,
    "fraction": 0.4
  },
  "logs": [
    "[19/Dec/2019:10:58:21 +0000] 'GET /v1/users/123 HTTP/1.1' 200 8215 'http://111.111.11.1/' 'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_11_1) AppleWebKit/111.11 (KHTML, like Gecko) Chrome/11.1.1111.11 Safari/111.11'",
    "[19/Dec/2019:10:58:24 +0000] 'GET /logo.png HTTP/1.1' 404 555 'http://111.111.11.1/' 'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_11_1) AppleWebKit/111.11 (KHTML, like Gecko) Chrome/11.1.1111.11 Safari/111.11'"
  ],
  "events": [
    {
      "timestamp": "2021-04-19T17:36:57.47623Z",
      "name": "domContentLoadedEventStart",
      "attributes": [
        {
          "attributeName": "message_details",
          "attributeValue": {
            "type": "BooleanAttributeValue"
          }
        }
      ]
    }
  ],
  "links": [
    {
      "traceId": "00000000002317A9",
      "spanId": "000000000003C7BE"
    }
  ]
}