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

Clarify tech preview status of OTel logs and metrics in docs #43930

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

brunobat
Copy link
Contributor

No description provided.

Copy link
Member

@maxandersen maxandersen left a comment

Choose a reason for hiding this comment

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

looks good but maybe add ::extension-status: preview so the usual preview banner gets added?

@brunobat
Copy link
Contributor Author

brunobat commented Oct 17, 2024

looks good but maybe add ::extension-status: preview so the usual preview banner gets added?

The issue is that the extension includes Otel Tracing which is supported... It is the logging and metrics part that is tech preview... We chose to have them off by default.
This was discussed with @tqvarnst

Copy link

github-actions bot commented Oct 17, 2024

🎊 PR Preview 5c3944b has been successfully built and deployed to https://quarkus-pr-main-43930-preview.surge.sh/version/main/guides/

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

@quarkus-bot

This comment has been minimized.

Copy link
Contributor

@sheilamjones sheilamjones left a comment

Choose a reason for hiding this comment

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

Hi @brunobat, LGTM, I just had a minor comment.
Just to clarify for the RHBQ docs, we don't make reference to OpenTelemetry Logging in 3.15 release notes Tech Preview updates; only reference the OTel metrics.

docs/src/main/asciidoc/opentelemetry-logging.adoc Outdated Show resolved Hide resolved
@maxandersen
Copy link
Member

The issue is that the extension includes Otel Tracing which is supported... It is the logging and metrics part that is tech preview... We chose to have them off by default.
This was discussed with @tqvarnst

yes, but is this doc not specifically about metrics? that macro/parameter just makes it very clear the content of this doc is preview.

@quarkus-bot

This comment has been minimized.

@brunobat
Copy link
Contributor Author

The issue is that the extension includes Otel Tracing which is supported... It is the logging and metrics part that is tech preview... We chose to have them off by default.
This was discussed with @tqvarnst

yes, but is this doc not specifically about metrics? that macro/parameter just makes it very clear the content of this doc is preview.

umm... good point. Will add that to the logging and metrics guides.

@quarkus-bot
Copy link

quarkus-bot bot commented Oct 17, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 150a87e.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

@@ -5,6 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Using OpenTelemetry Logging
include::_attributes.adoc[]
:extension-status: preview
Copy link
Member

Choose a reason for hiding this comment

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

This is not enough, you also need to include the extension status include.

See

include::{includes}/extension-status.adoc[]
for an example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

4 participants