Documentation on dependency logging not up to date

[meersschautarnaud]

Describe the bug
Looking at the documentation on how to log a service bus dependency it shows a method that is obsolete. Next to that in the new methods, you need to provide a dependencyId which is a bit confusing since correlation is normally handled by Arcus itself, but this is probably another discussion.

Additional context

• Version: 2.5

[stijnmoreels]

Hi Arnaud, thx for the issue.

I can see your confusion. This, however, is not a mistake or bug but was done on purpose. Tracking dependencies happens in two parts:

• Adding correlation information to the sent message (ex. in Azure Service Bus, the ApplicationProperties)
• Logging dependency with correlation information (ex. Azure Service Bus dependency with dependency ID)

In order for Arcus to know how the called dependency is calling itself, a dependency ID has to be passed while logging the dependency.

We are working on a set of extensions that extends the ServiceBusSender which will do these two steps for you: https://github.com/arcus-azure/arcus.messaging/blob/master/docs/preview/02-Features/04-service-bus-extensions.md but this isn't yet released, though, the published releases already has everything to do this yourself.
If you're interested in this extension, we can already provide you with a preview release to experiment with this.

Service-to-service correlation is a very complex topic to get right, so we are working also on several user guides to help consumers in this process. 👍

[stijnmoreels]

We could, however, add the dependencyId to every method in the docs so people know that this is the recommended approach. 👍
Something you would want to pick up?

[meersschautarnaud]

@stijnmoreels thank you for the explanation, I would like to pick this up and update the docs 😃

[stijnmoreels]

@stijnmoreels thank you for the explanation, I would like to pick this up and update the docs 😃

Great! Thx for the help!
Let us know if you have any questions.

[stijnmoreels]

@meersschautarnaud , letting you know that with the new Arcus telemetry in Web API/Messaging, we can now automatically track Microsoft dependencies (HTTP, SQL, all Azure dependencies...) without any additional Arcus dependency tracking.