Update tracing documentation to add details about manual instrumentation

[swagatbora90]

Add a Manual instrumentation section in docs/tracing.md and added details about how to use the tracing APIs to manual instrument spans in containerd.

Also added a section to list the naming conventions to follow.

Signed-off-by: Swagat Bora sbora@amazon.com

[k8s-ci-robot]

Hi @swagatbora90. Thanks for your PR.

I'm waiting for a containerd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[swagatbora90]

/cc @jterry75 @mxpv PTAL

[k8s-ci-robot]

@swagatbora90: GitHub didn't allow me to request PR reviews from the following users: PTAL.

Note that only containerd members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @jterry75 @mxpv PTAL

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[dims]

@swagatbora90 one tiny NIT. LGTM otherwise. i was also curious about what to do when one component hands off to another asynchronously, but we can do that later. thanks!

[swagatbora90]

@swagatbora90 one tiny NIT. LGTM otherwise. i was also curious about what to do when one component hands off to another asynchronously, but we can do that later. thanks!

For correlation of two components that are related asynchronously, otel does provide a mechanism to add links between two spans https://opentelemetry.io/docs/concepts/signals/traces/#span-links. Go implementation https://github.com/open-telemetry/opentelemetry-go/blob/main/sdk/trace/span.go#L634. I have not used it myself though. Do you have any specific components in mind?

[swagatbora90]

@dims @mxpv I have addressed your comments. PTAL

[dims]

LGTM

[jterry75]

Thanks for adding!

[swagatbora90]

Hello maintainers, is this PR okay to merge?

[estesp]

@swagatbora90 can you push this PR with no changes; seems the CI runs are too old to have the "restart" buttons anymore 🤷🏻‍♂️

[samuelkarp]

Close/reopen to try and trigger CI again.

[mxpv]

@swagatbora90 could you try to rebase this PR against latest main. I believe this will make CI happier.