Skip to content

docs: add standalone trace docs #1719

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

docs: add standalone trace docs #1719

wants to merge 9 commits into from

Conversation

sunng87
Copy link
Member

@sunng87 sunng87 commented May 6, 2025

What's Changed in this PR

Describe the change in this PR

Add a standalone section for trace.

  • Add a new ingestion/query chapter, moved OpenTelemetry Traces to this chapter
  • Included a new chapter for data modeling
  • Included a new chatper for extending trace data using flow, start from a uddsketch example
  • Otel and Jaeger are kept in original position

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

Copy link

cloudflare-workers-and-pages bot commented May 6, 2025

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3e1fb22
Status: ✅  Deploy successful!
Preview URL: https://01be728c.greptime-docs.pages.dev
Branch Preview URL: https://docs-trace-section.greptime-docs.pages.dev

View logs

@sunng87 sunng87 requested a review from zyy17 May 7, 2025 12:08
@sunng87 sunng87 marked this pull request as ready for review May 7, 2025 12:12
@sunng87
Copy link
Member Author

sunng87 commented May 7, 2025

Translated docs coming later

@sunng87 sunng87 requested a review from killme2008 May 8, 2025 03:38
Copy link
Contributor

@killme2008 killme2008 left a comment

Choose a reason for hiding this comment

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

Great job! Almost LGM

In this section, we will cover how trace data is modeled in GreptimeDB as
tables.

We reuse the concept of Pipeline for trace data modeling. However, note that at
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider linking to the pipeline documentation: https://docs.greptime.com/user-guide/logs/manage-pipelines.

Should we move pipeline management documentation out of the logs user guide and create a standalone document, similar to the flow documentation?

Copy link
Member Author

Choose a reason for hiding this comment

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

Here I ignored link by purpose, because we only support non-customiziable built-in pipeline.


### GreptimeDB Pipeline

The HTTP header `x-greptime-pipeline-name` is required for ingesting trace
Copy link
Contributor

Choose a reason for hiding this comment

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

The same suggestion as above. Link the pipeline concept document here.

Copy link
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants