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

vParquet3 documentation improvemens #2893

Merged
merged 7 commits into from
Sep 7, 2023

Conversation

stoewer
Copy link
Contributor

@stoewer stoewer commented Sep 6, 2023

What this PR does:

A number of small documentation improvements related to vParquet3

Which issue(s) this PR fixes:

Fixes grafana/tempo-squad#307

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

The term 'dedicated columns' is still used descriptively in some cases
This helps to distinguish them from vParquet3 dedicated attribute
columns

Mention the OTEL semantics in the section about well-known attributes
@@ -1,20 +1,20 @@
---
title: Dedicated columns
description: Learn how to use dedicated columns to improve query performance.
title: Dedicated attribute columns
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good name update.

@@ -232,12 +258,12 @@ For speed and ease-of-use, we are projecting several values to columns at the tr
* Root service/span names/StartTimeUnixNano - These are selected properties of the root span in each trace (if there is one). These are used for displaying results in the Grafana UI. These properties are computed at ingest time and stored once for efficiency, so we don't have to find the root span.
* `DurationNanos` - The total trace duration, computed at ingest time. This powers the min/max duration filtering in the current Tempo search and is more efficient than scanning the spans duration column. However, it may go away with TraceQL or we could decide to change it to span-level duration filtering too.

## Dedicated columns
## Well-known attributes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes to the two names helps clarify and differentiate these capabilities. Thank you for making these changes.

Copy link
Contributor

@knylander-grafana knylander-grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for making these updates. It helps clarify the differences between the capabilities.

@knylander-grafana knylander-grafana added the type/docs Improvements or additions to documentation label Sep 6, 2023
@stoewer stoewer enabled auto-merge (squash) September 6, 2023 22:53
@stoewer stoewer merged commit a2b5c60 into grafana:main Sep 7, 2023
@stoewer stoewer deleted the vparquet3-improve-docs branch October 25, 2023 13:49
@stoewer stoewer mentioned this pull request Nov 13, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants