Skip to content

APM Data Collection

Guance APM data collection currently supports collectors that use the Opentracing protocol. After enabling the APM data receiving service in DataKit, by completing the code instrumentation for the collector, DataKit will automatically perform data format conversion and collection, ultimately reporting it to Guance.

Data Collection

DataKit currently supports collecting Tracing data from third parties such as DDTrace, Apache Jaeger, OpenTelemetry, Skywalking, and Zipkin.

Prerequisites for Collection

  1. Install DataKit.

  2. Configure all collectors related to APM data collection.

Collector Configuration

DDTrace

OpenTelemetry

Pinpoint

Field Descriptions

DataKit will convert the reported data into the Guance APM data format based on the collector used, preserving tags and metrics. Below are common field descriptions:

Field Name Description
host Hostname, a default global tag
source The source of the trace. For example, if collected via Zipkin, the value is zipkin; if via Jaeger, it is jaeger, and so on.
service The name of the service. It is recommended that users specify the name of the business system that generated this trace data using this tag.
parent_id The ID of the previous span of the current span
operation The operation name of the current span, which can also be understood as the Span name.
span_id The unique ID of the current span
trace_id The unique ID representing the current trace
span_type The type of Span. Currently supported: entry, local, exit, unknow
  • entry span represents a span created upon entering a service, i.e., an endpoint of that service that provides call requests to other services. Most spans should be entry spans. Only calls where the span is of type entry constitute an independent request.
  • local span indicates that the span has no relation to remote calls and is created during local method calls, such as an ordinary Java method.
  • exit span represents a span created upon leaving a service, for example, when initiating a remote call or when a message queue produces a message.
  • unknow span represents an unknown Span type.
    		•
    endpoint The target address of the request. The network address used by the client to access the target service, e.g., 127.0.0.1:8080. Default: null
    message The raw data collected before the trace conversion
    duration The duration of the current trace span
    status The trace status: info (hint), warning (warning), error (error), critical (critical), ok (success)
    env The environment to which the trace belongs. For example, dev can represent the development environment, prod the production environment. Users can define this themselves.

    For more field lists, please refer to DataKit Tracing Data Structure.

    Feedback

    Is this page helpful? ×