New Relic · Schema

Span

A single distributed trace span in New Relic format

AnalysisAnalyticsAPMDevOpsInfrastructureMonitoringObservabilityPerformancePlatform

Properties

Name Type Description
id string Unique identifier for this span (16 hex characters)
trace.id string Trace ID that groups all spans in a distributed trace
timestamp integer Unix epoch timestamp in milliseconds when the span started
attributes object Span attributes
View JSON Schema on GitHub

JSON Schema

trace-api-span-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/new-relic/refs/heads/main/json-schema/trace-api-span-schema.json",
  "title": "Span",
  "description": "A single distributed trace span in New Relic format",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for this span (16 hex characters)",
      "example": "500123"
    },
    "trace.id": {
      "type": "string",
      "description": "Trace ID that groups all spans in a distributed trace",
      "example": "500123"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix epoch timestamp in milliseconds when the span started",
      "example": 1718153645993
    },
    "attributes": {
      "type": "object",
      "description": "Span attributes",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the operation represented by this span"
        },
        "parent.id": {
          "type": "string",
          "description": "The span ID of the parent span"
        },
        "duration.ms": {
          "type": "number",
          "description": "Duration of the span in milliseconds"
        },
        "service.name": {
          "type": "string",
          "description": "Name of the service that generated this span"
        },
        "error": {
          "type": "boolean",
          "description": "Whether the span represents an error"
        },
        "db.statement": {
          "type": "string",
          "description": "Database query statement if applicable"
        },
        "http.url": {
          "type": "string",
          "description": "HTTP URL for outbound calls"
        },
        "http.method": {
          "type": "string",
          "description": "HTTP method for outbound calls"
        },
        "http.statusCode": {
          "type": "integer",
          "description": "HTTP response status code"
        }
      },
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      },
      "example": {
        "name": "example-resource-01",
        "parent.id": "500123",
        "duration.ms": 0.42,
        "service.name": "myService",
        "error": true,
        "db.statement": "example_string",
        "http.url": "https://portal.example.com/path/abc123",
        "http.method": "example_string",
        "http.statusCode": 200
      }
    }
  },
  "required": [
    "id",
    "trace.id"
  ]
}