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

Send "meta.span_type" field with root spans #127

Merged
merged 4 commits into from
Jul 11, 2022

Conversation

istathar
Copy link
Member

The "meta.kind" field should be populated with a value to ensure the Home screen and Traces are managed to their fullest extent. https://docs.honeycomb.io/working-with-your-data/settings/definitions/#metadata-kind

In consultation with Honeycomb, we've confirmed a value of of "root" should be set for root spans:

Kind is a way to annotate spans within a trace so that edges between components can be identified later. Values can be:

  • root - the start of a trace, as you say another way to mark the start in addition to a span having no parent
  • subroot - the first span from a service within a trace, used in some of Honeycombs built-ins to show you different services within a single environment
  • leaf - some of the beelines mark spans that are the last event from a service (maybe the end of a trace, maybe an end to a sub-process, or maybe the last span before an interaction with another service)
  • mid - not a root, subroot, or leaf; an interstitial event between a service's beginning of participation in a trace and the end

It's not yet clear just how much value these provide. This patch adds "root" for when we send a span without a parent span.

@istathar istathar self-assigned this May 22, 2022
@istathar istathar marked this pull request as ready for review July 11, 2022 15:58
@istathar istathar added improvement New feature or request core-telemetry Issues involving sending telemetry to an observability service labels Jul 11, 2022
@istathar istathar changed the title Send "meta.kind" field with root spans Send "meta.span_type" field with root spans Jul 11, 2022
@istathar
Copy link
Member Author

Having "root" is actually kind of nice. Merging.

@istathar istathar merged commit 0f6c025 into aesiniath:main Jul 11, 2022
@istathar istathar deleted the span-metadata branch July 11, 2022 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-telemetry Issues involving sending telemetry to an observability service improvement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant