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

Unify internal observability documentation and move it to website #4192

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

tiffany76
Copy link
Contributor

@tiffany76 tiffany76 commented Mar 22, 2024

Fixes open-telemetry/opentelemetry-collector#8886.

This PR brings together three different documents from the Collector repo: Troubleshooting, OpenTelemetry Collector Observability, and Monitoring.

NOTE: Work on this PR is broken up into three smaller pull requests. See bullet list below for corresponding PRs.

Per @mx-psi, this new document should describe:

The merged and reworked file will be located on opentelemetry.io, with its precise location in the nav hierarchy and title to be decided.

cc @codeboten


Preview: https://deploy-preview-4192--opentelemetry.netlify.app/docs/collector/internal-telemetry/

@tiffany76
Copy link
Contributor Author

This is still a VERY rough draft and very much a WIP. I've broken up the content into sections but done nothing else. Avert your eyes! :)

@theletterf
Copy link
Member

Great initiative, @tiffany76 ! For a better review experience, I think it'd be great if you could split the PR into one for each file / concern.

@tiffany76
Copy link
Contributor Author

Thanks, @theletterf! I will do that next. Traveling this week so progress may be a little slow.

@svrnm
Copy link
Member

svrnm commented Mar 27, 2024

Great initiative! As mentioned on the related collector issue I am fine with having a troubleshooting and an observability/internal telemetry page, we can talk about the right name eventually.

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Some drive-by comments. More copyedits to come when this is no longer in draft mode.

content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
@tiffany76
Copy link
Contributor Author

For a better review experience, I think it'd be great if you could split the PR into one for each file / concern.

Hi @theletterf and others, I've thought about how best to break this down and have decided to leave this PR here, in draft, with the full content. I'll create new smaller PRs with each of the three sections. The first PR is up (still in draft): #4246.

Hope that works for you!

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

Successfully merging this pull request may close these issues.

[docs] Unify internal observability documentation
4 participants