Skip to content

[Bug]: [Docs] Use Open Telemetry and Activity Traces #3037

@illegitimis

Description

@illegitimis

What happened?

Official docs:

fail to mention the add-telemetry CLI verb and incorrectly point to dab configure.

Workaround: write dab config json manually.

CLI that works:

dab add-telemetry \
-c dab-config.json \
--otel-enabled true \
--otel-endpoint "http://localhost:4317"\
--otel-protocol "grpc"

Version

Microsoft.DataApiBuilder 1.6.84+353838b9799e489f3c1e52f95fc595a12b75946c

What database are you using?

Azure SQL

What hosting model are you using?

Local (including CLI)

Which API approach are you accessing DAB through?

REST

Relevant log output

# Enables or disables OpenTelemetry
# dab configure --otel-enabled true ❌ Option 'otel-enabled' is unknown.
# dab configure -c dab-config.04.json --runtime.telemetry.open-telemetry.enabled true ❌ Option 'runtime.telemetry.open-telemetry.enabled' is unknown.
### runtime.telemetry.open-telemetry.endpoint,null,OpenTelemetry collector URL
# dab configure --otel-endpoint "http://otel-collector:4317"
### runtime.telemetry.open-telemetry.exporter-protocol,"grpc",OpenTelemetry protocol ("grpc" or "httpprotobuf")
# dab configure --otel-protocol "grpc"
### runtime.telemetry.open-telemetry.service-name,"dab",OpenTelemetry service name
# dab configure --otel-service-name "dab"
### runtime.telemetry.open-telemetry.headers,{},OpenTelemetry export headers
# dab configure --otel-headers
# runtime.telemetry.log-level.namespace,null,Namespace-specific log level override

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingtriageissues to be triaged

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions