Skip to content

Trace Data Collection

Guance currently supports collectors using the Opentracing protocol for trace data collection. After enabling the trace data reception service in DataKit, by completing the instrumentation in the code, DataKit will automatically handle data format conversion and collection, and finally report it to Guance.

Data Collection

DataKit currently supports collecting tracing data from third-party tools such as DDTrace, Apache Jaeger, OpenTelemetry, Skywalking, and Zipkin.

Collection Prerequisites

  1. Install DataKit;

  2. Configure all relevant collectors for trace data collection.

Collector Configuration

DDTrace

OpenTelemetry

Pinpoint

Field Description

DataKit converts the collected data into Guance trace data format based on different collectors while preserving tags and metrics. Below is a description of commonly used fields:

Field Name Description
host Hostname, default global tag.
source The source of the trace; if collected via Zipkin, this value is zipkin; if via Jaeger, it is jaeger, and so on.
service Service name; it is recommended that users specify the name of the business system generating this trace data through this tag.
parent_id ID of the previous span.
operation Operation name of the current span, or Span name.
span_id Unique ID of the current span.
trace_id Unique ID representing the current trace.
span_type Type of Span, currently supports: entry, local, exit, unknow.
  • entry span indicates the span created when entering a service, i.e., the endpoint where the service provides calls to other services. Most spans should be entry spans. Only calls where the span is of type entry are independent requests.
  • local span indicates that this span has no relation to remote calls and is created during local method calls, for example, an ordinary Java method.
  • exit span indicates the span created when leaving a service, such as when initiating a remote call or producing messages in a message queue.
  • unknow span indicates unknown Spans.
    		•
    endpoint Target address of the request, the network address the client uses to access the target service, for example, 127.0.0.1:8080, default: null.
    message Raw data collected before trace conversion.
    duration Duration of the current trace span.
    status Status of the trace: info (information), warning (warning), error (error), critical (critical), ok (success).
    env Environment to which the trace belongs, e.g., use dev for development environment, prod for production environment, and users can define their own environments.

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

    Feedback

    Is this page helpful? ×