OpenTelemetry

To add flag evaluation information to OpenTelemetry spans, first add the Telemetry package from NuGet:

dotnet add package LaunchDarkly.ServerSdk.Telemetry
COPY

Next, import the LaunchDarkly.Sdk.Server.Hooks and LaunchDarkly.Sdk.Server.Telemetry namespaces. Then you can create a new tracing hook and reference it in the configuration options when you initialize the SDK client.

Here's how:

using LaunchDarkly.Sdk.Server.Hooks;
using LaunchDarkly.Sdk.Server.Telemetry;
var config = Configuration.Builder("sdk-key-123abc")
  .Hooks(Components.Hooks()
    .Add(TracingHook.Default())
  ).Build();
var client = new LdClient(config);
COPY

When this configuration is set, the SDK adds span events for each call to a *Variation* method to your active span. The span event information contains details of each flag evaluation, including the flag key and the context key. This information is available in Release guardian, and accessible in your observability tools.

Optionally, you can configure the tracing hook to:

• create new spans that contain span events with flag evaluation information, rather than adding the events to the active span. The new spans are nested in the current active span, and are not active.
• include the flag's evaluated flag value in the span event.

Here's how:

using LaunchDarkly.Sdk.Server.Hooks;
using LaunchDarkly.Sdk.Server.OpenTelemetry;
var config = Configuration.Builder("sdk-key-123abc")
  .Hooks(Components.Hooks()
    .Add(TracingHook.Builder()
      .CreateActivities()
      .IncludeVariant()
      .Build()
    )
  ).Build();
var client = new LdClient(config);
COPY

In the .NET (server-side) SDK, the tracing hook is implemented using Microsoft's System.Diagnostics APIs. Therefore, some of the terminology it uses differs from the OpenTelemetry standard. For example, the tracing hook in the .NET (server-side) SDK uses the method CreateActivities(), rather than CreateSpans(), to enable child spans.

To learn more, read TracingHookBuilder and ConfigurationBuilder.

To add flag evaluation information to OpenTelemetry spans, import the ldhooks package. Then, create a new tracing hook and reference it in the configuration options when you initialize the SDK client.

Here's how:

import (
  ld "github.com/launchdarkly/go-server-sdk/v7"
  "github.com/launchdarkly/go-server-sdk/v7/ldhooks"
  "github.com/launchdarkly/go-server-sdk/ldotel"
)
var config ld.Config
client, _ = ld.MakeCustomClient("sdk-key-123abc",
  ld.Config{
    Hooks: []ldhooks.Hook{ldotel.NewTracingHook()},
  }, 5*time.Second)
COPY

When this configuration is set, the SDK adds span events for each call to a *Variation*Ctx method to your active span.

The span event information contains details of each flag evaluation, including the flag key and the context key. This information is available in Release guardian, and accessible in your observability tools.

The *Variation*Ctx methods are the same as the *Variation* methods, except that they also require a Go context. For example, BoolVariationCtx and BoolVariationDetailCtx are the same as the BoolVariation and BoolVariationDetail methods, except that they also require a Go context. This Go context is used in the hook implementation. If you are using hooks, you must update your variation calls to use the Ctx methods.

Optionally, you can configure the tracing hook to:

• create new spans that contain span events with flag evaluation information, rather than adding the events to the active span. The new spans are nested in the current active span, and are not active.
• include the flag's evaluated flag value in the span event.

Here's how:

import (
  ld "github.com/launchdarkly/go-server-sdk/v7"
  "github.com/launchdarkly/go-server-sdk/v7/ldhooks"
  "github.com/launchdarkly/go-server-sdk/ldotel"
)
var config ld.Config
client, _ = ld.MakeCustomClient("sdk-key-123abc",
  ld.Config{
    Hooks: []ldhooks.Hook{ldotel.NewTracingHook(ldotel.WithSpans(), ldotel.WithVariant())},
  }, 5*time.Second)
COPY

To learn more, read Config.

To add flag evaluation information to OpenTelemetry spans, import the LaunchDarkly Java Otel Hook package. Then, create a new tracing hook and reference it in the configuration options when you initialize the SDK client.

Here's how:

import com.launchdarkly.integrations.TracingHook;
TracingHook tracingHook = new TracingHook.Builder().build();
LDConfig config = new LDConfig.Builder()
    .hooks(
        Components.hooks().setHooks(Collections.singletonList(tracingHook)))
    .build();
LDClient client = new LDClient("sdk-key-123abc", config);
COPY

When this configuration is set, the SDK adds span events for each call to a *Variation* method to your active span. The span event information contains details of each flag evaluation, including the flag key and the context key. This information is available in Release guardian, and accessible in your observability tools.

Optionally, you can configure the tracing hook to:

• create new spans that contain span events with flag evaluation information, rather than adding the events to the active span. The new spans are nested in the current active span, and are not active.
• include the flag's evaluated flag value in the span event.

Here's how:

import com.launchdarkly.integrations.TracingHook;
TracingHook tracingHook = new TracingHook.Builder().withSpans().withVariant().build())
LDConfig config = new LDConfig.Builder()
    .hooks(
        Components.hooks().setHooks(Collections.singletonList(tracingHook)))
    .build();
LDClient client = new LDClient("sdk-key-123abc", config);
COPY

To learn more, read LDConfig.Builder.

To add flag evaluation information to OpenTelemetry spans, import the TracingHook package. Then, create a new tracing hook and reference it in the configuration options when you initialize the SDK client.

Here's how:

import * as ld from '@launchdarkly/node-server-sdk';
import { TracingHook } from '@LaunchDarkly/node-server-sdk-otel';
const options: ld.LDOptions = {
  hooks: [new TracingHook()]
}
const client = ld.init('sdk-key-123abc', options);
COPY

When this configuration is set, the SDK adds span events for each call to a *Variation* method to your active span. The span event information contains details of each flag evaluation, including the flag key and the context key. This information is available in Release guardian, and accessible in your observability tools.

Optionally, you can configure the tracing hook to:

• create new spans that contain span events with flag evaluation information, rather than adding the events to the active span. The new spans are nested in the current active span, and are not active.
• include the flag's evaluated flag value in the span event.

Here's how:

import * as ld from '@launchdarkly/node-server-sdk';
import { TracingHook } from '@LaunchDarkly/node-server-sdk-otel';
const options: ld.LDOptions = {
  hooks: [new TracingHook({spans: true, includeVariant: true})]
}
const client = ld.init('sdk-key-123abc', options);
COPY

To learn more, read LDOptions.

To add flag evaluation information to OpenTelemetry spans, create a new tracing hook and reference it in the configuration options when you initialize the SDK client.

Here's how:

require 'ldclient-otel'
config = LaunchDarkly::Config.new(hooks: [LaunchDarkly::Otel::TracingHook.new])
client = LaunchDarkly::LDClient.new("sdk-key-123abc", config);
COPY

When this configuration is set, the SDK adds span events for each call to a *Variation* method to your active span. The span event information contains details of each flag evaluation, including the flag key and the context key. This information is available in Release guardian, and accessible in your observability tools.

Optionally, you can configure the tracing hook to:

• create new spans. The new spans are nested in the current active span, and are not active. The span events with flag evaluation information are still added to the parent span.
• include the flag's evaluated flag value in the span event.

Here's how:

require 'ldclient-otel'
tracing_hook_options = LaunchDarkly::Otel::TracingHookOptions.new(add_spans: true, include_variant: true)
hook = LaunchDarkly::Otel::TracingHook.new(tracing_hook_options)
config = LaunchDarkly::Config.new(hooks: [hook])
client = LaunchDarkly::LDClient.new("sdk-key-123abc", config);
COPY

To learn more, read Config.