Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE REQ] Document ActivitySource names or naming conventions #31921

Closed
Tracked by #39432
lmolkova opened this issue Oct 20, 2022 · 0 comments · Fixed by #39959
Closed
Tracked by #39432

[FEATURE REQ] Document ActivitySource names or naming conventions #31921

lmolkova opened this issue Oct 20, 2022 · 0 comments · Fixed by #39959
Labels
Client This issue points to a problem in the data-plane of the library. Docs OpenTelemetry OpenTelemetry instrumentation (not Monitor-specific)

Comments

@lmolkova
Copy link
Member

lmolkova commented Oct 20, 2022

Library name

All

Please describe the feature.

Users sometimes what to enable specific ActivitySources and exclude others. We only document Azure.* and don't give any guidance on source names beyond that.

E.g. storage one is Azure.Storage, appconfig one is Azure.Data.AppConfiguration and eventhubs is Azure.Messaging.EventHubs.

In some cases, they are defined explicitly (EventHubs), but in most cases, the name corresponds to the namespace in which derived ClientOptions are defined.

The convention: <packageName>.<className>.

E.g. ServiceBus should have the following sources

  • Azure.Messaging.ServiceBus.ServiceBusReceiver
  • Azure.Messaging.ServiceBus.Message
  • Azure.Messaging.ServiceBus.ServiceBusSender
  • Azure.Messaging.ServiceBus.ServiceBusProcessor

It's recommended to enable Azure SDK tracing in one of the following ways:

  • AddSource("Azure.*) - all activities
  • AddSource("<packageName>.*)
    • all activities from specific library such as Azure.Messaging.ServiceBus
    • no activities for HTTP requests (they are coming from Azure.Core.Http and need to be enabled additionally)
  • AddSource("<packageName>.<clientName>") - activities from individual clients (e.g. when Azure.Messaging.ServiceBus.ServiceBusProcessor is used, receiver activities won't be reported)
@lmolkova lmolkova added Client This issue points to a problem in the data-plane of the library. Docs OpenTelemetry OpenTelemetry instrumentation (not Monitor-specific) labels Oct 20, 2022
@lmolkova lmolkova changed the title [FEATURE REQ] Document ActivitySource names or conventions [FEATURE REQ] Document ActivitySource names or naming conventions Oct 20, 2022
@lmolkova lmolkova mentioned this issue Oct 20, 2023
10 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Feb 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs OpenTelemetry OpenTelemetry instrumentation (not Monitor-specific)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant