Tracing

Background

Kitex provides interfaces that allow developers to extend the implementation, choose the right tool to fit their monitoring ecosystem, and users can easily implement requested full-link monitoring in a microservices architecture. Such monitoring is essential for debugging, performance analysis, and troubleshooting.

Custom Tracer

The framework provides a Tracer interface, which you can implement to create a custom tracer:

type Tracer interface {
	Start(ctx context.Context) context.Context
	Finish(ctx context.Context)
}

For detailed documentation, refer to the Monitoring Extension section.

Custom Tracking Events

Kitex provides some default tracking events, such as RPC call start, RPC call end, etc. For more information about built-in tracking events, please refer to the Instrumentation section. Additionally, you can manually add more tracking data to collect more detailed trace information. Tracking events are recorded by creating and ending spans, which can be done using the native API of the corresponding component.

For example, using OpenTelemetry:

ctx, span := otel.Tracer("client").Start(ctx, "root")
defer span.End()

For more information, see OpenTelemetry Creating Spans.