Nesta página

APM span object

The following objects are directly related to the apmspan API.

Each property corresponds to a column in the otel_traces table of the telemetry data source. For the list of columns, see Supported telemetry data columns.

APM span

The APM span object represents a span (a single operation within a trace, such as an HTTP request, a database query, or a function call).

Spans form a hierarchy, starting from the root span, which represents the first operation of the request. Every other span is a child span of the span during which its operation was started.

The APM span object has the following properties:

Property Type Description
timestamp integer Unix time (in nanoseconds) when the span started.

Property behavior:
- read-only
traceid string ID of the trace that the span belongs to.

Property behavior:
- read-only
spanid string ID of the span.

Property behavior:
- read-only
parent_spanid string ID of the parent span.
Empty for the root span.

Property behavior:
- read-only
trace_state string Additional data, if any, that tracing tools attach to the trace (see W3C Trace Context).

Property behavior:
- read-only
span_name string Name of the operation that the span represents (e.g., mysqli_query).

Property behavior:
- read-only
span_kind string Role of the span.

Possible values:
Unspecified - span kind is not specified;
Internal - operation performed within an application;
Server - handling of an incoming request;
Client - outgoing request;
Producer - creation of an asynchronous operation (e.g., sending a message);
Consumer - processing of an asynchronous operation.

Property behavior:
- read-only
service_name string Name of the service that produced the span (e.g., zabbix-frontend), taken from the OpenTelemetry service.name resource attribute.

Property behavior:
- read-only
resource_attributes object Key-value resource attributes of the span (e.g., host.name: eabf8c2a5ddc).

Property behavior:
- read-only
scope_name string Name of the instrumentation scope that produced the span.

Property behavior:
- read-only
scope_version string Version of the instrumentation scope.

Property behavior:
- read-only
span_attributes object Key-value span attributes of the span (e.g., db.system: mysql).

Property behavior:
- read-only
duration integer Nanoseconds of the duration of the span.

Property behavior:
- read-only
status_code string Status of the operation that the span represents.

Possible values:
Unset - no explicit status has been assigned to the span;
Ok - the operation was completed successfully;
Error - the operation was completed with an error.

Property behavior:
- read-only
status_message string Additional information, if any, about the status of the span.

Property behavior:
- read-only
events array Array of event objects of the span, that is, notable points in time during the operation (e.g., exceptions).

Property behavior:
- read-only
links array Array of link objects of the span, which point to related spans in the same or another trace.

Property behavior:
- read-only