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

Add spec for instrumenting Azure services #426

Merged
merged 15 commits into from
Jul 19, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions specs/agents/tracing-instrumentation-azure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Azure services spans

We describe how to instrument some of Azure's services in this document.
Some of the services can use existing specs. When there are differences or additions, they have been noted below.

### Azure Service Bus

Azure Service Bus is a message broker service. The [messaging spec](tracing-instrumentation-messaging.md) can
be used for instrumenting Azure Service Bus, but the follow specifications supersede those of the messaging spec.

#### Typing

- Spans:
- `span.subtype`: `azureservicebus`

#### Additional actions

Azure Service Bus supports actions that should be traced in addition to `SEND` and `RECEIVE`:

- `SCHEDULE`

Message published to the bus, but not visible until some later point.

- `RECEIVEDEFERRED`

Message received from the bus, but marked as deferred on the bus, then later retrieved with receive deferred.

#### Naming

Messages can be sent to queues and topics, and can be received from queues and topic subscriptions.

Transaction and span names should* follow these patterns:
russcam marked this conversation as resolved.
Show resolved Hide resolved

For send and schedule,

`AzureServiceBus SEND|SCHEDULE to <QUEUE-NAME>|<TOPIC-NAME>`

For receive and receive deferred,

`AzureServiceBus RECEIVE|RECEIVEDEFERRED from <QUEUE-NAME>|<TOPIC-NAME>/Subscriptions/<SUBSCRIPTION-NAME>`