Quickstart

This guide will help you on how to setup Tracing mechanism using GL Observability.

1

Choose your Backend

A backend is the destination where your traces data is sent for storage, visualization, and analysis. This guide will use Sentry backend. For more details about backend, see Backend Configuration.

from gl_observability import SentryBackendConfig

backend_config = SentryBackendConfig(
    dsn="<your-sentry-dsn>",
    environment="<project-environment>",
    release="<release-version>",
    send_default_pii=True,
    disable_sentry_distributed_tracing=False
)

2

(Optional) Initialize Sampler

Sampler can be used to reduce traces collected. See Sampler for more details.

from opentelemetry.sdk.trace.sampling import TraceIdRatioBased

trace_sampler = TraceIdRatioBased(1.0)

3

Initialize Telemetry with Instrumentation

The example code activate instrumentation for FastAPI, Langchain, HTTPX, and Requests library. For more details, see Initialization Configuration.

from gl_observability import init_telemetry, TelemetryConfig, FastAPIConfig

app = FastAPI()
fastapi_config = FastAPIConfig(app=app)

otel_config = TelemetryConfig(
    attributes={"service.name": "..."},
    backend_config=backend_config,
    trace_sampler=trace_sampler,
    fastapi_config=fastapi_config,
    use_langchain=True,
    use_httpx=True,
    use_requests=True,
    log_trace_context=True,
)
init_telemetry(otel_config)

4

Next Step

You can start adding instrumentation into your code. See more details about Instrumentation.