Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Tracing

  • how-to
    +
    Tracing Couchbase Distributed ACID transactions.

    If configured, detailed telemetry on each transaction can be output that is compatible with various external systems including OpenTelemetry and its predecessor OpenTracing. This telemetry is particularly useful for monitoring performance.

    See the SDK Request Tracing documentation for how to configure this.

    Tracing should currently be regarded as 'developer preview' functionality, as the spans and attributes output may change over time.

    Parent Spans

    The application may wish to indicate that the transaction is part of a larger span — for instance, a user request. It can do this by passing that as a parent span.

    This can be done using the SDK’s RequestTracer abstraction as so:

    val span = cluster.env.core.requestTracer.requestSpan("your-span-name", null)
cluster.transactions.run((ctx: TransactionAttemptContext) => {
  Success()
}, Some(TransactionOptions().parentSpan(span)))

    Or if you have an existing OpenTelemetry span you can easily convert it to a Couchbase RequestSpan and pass it to the SDK:

    val span = Span.current // this is a span created by your code earlier

val wrapped = OpenTelemetryRequestSpan.wrap(span)
cluster.transactions.run((ctx: TransactionAttemptContext) => {
  Success()
}, Some(TransactionOptions().parentSpan(wrapped)))