Skip to content

[Feature Request] Distributed Tracing doc improvements #2095

@noahfalk

Description

@noahfalk

dotnet/docs#23313 added a bunch of distributed tracing doc updates but there is still much more we could do. This tracks suggestions:

  • Add examples and pictures of more realistic collected distributed
    trace information to help developers internalize why it might be useful
    to them.
  • Add a diagnostic guide showing how distributed tracing assists in
    resolving a realistic production issue.
  • Ensure the getting started guides for collection transfer smoothly to
    remote pages in the AppInsights and OpenTelemetry docs
    • There was a spot I wanted to link to supported OpenTelemetry
      exporters but there is no anchor that goes solely to that
      information.
  • Flesh out the instrumentation guidance to answer more questions
    developers may encounter such as:
    • naming conventions for Activity
    • when to use DisplayName
    • how to log exceptions
    • how to propagate IDs to and from network protocols
    • how to migrate pre-existing Activity instrumentation to use ActivitySource
  • Add performance analysis and guidance to reassure developers that
  • Activity instrumentation + OpenTelemetry are serious about high
    performance workloads.
  • Discuss more conceptual topics and/or go into greater depth about
    some areas:
    • Hierarchical vs. W3C ID.
    • Format of a W3C ID
    • Describe sampling options in ActivityListener
    • Explain why some activities are uncapturable with ActivityListener
      and require workarounds with DiagnosticListener.
  • Roadmap for handling issues around custom propagators, supporting
    protocol updates, and suppressing undesired automatic Activity creation

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation related issueenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions