-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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?
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. |
🎊 PR Preview 5c3944b has been successfully built and deployed to https://quarkus-pr-main-43930-preview.surge.sh/version/main/guides/
|
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this 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.
14dbbc8
to
8c974b5
Compare
8c974b5
to
5e91ce6
Compare
yes, but is this doc not specifically about metrics? that macro/parameter just makes it very clear the content of this doc is preview. |
This comment has been minimized.
This comment has been minimized.
umm... good point. Will add that to the logging and metrics guides. |
5e91ce6
to
150a87e
Compare
Status for workflow
|
@@ -5,6 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc | |||
//// | |||
= Using OpenTelemetry Logging | |||
include::_attributes.adoc[] | |||
:extension-status: preview |
There was a problem hiding this comment.
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[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gsmet, will this change the status of the quarkus-opentelemetry
extension?
The objective is not to change that status for the entire extension, just report that for the metrics and logging parts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure I understand your question :)
The attribute in itself doesn't do anything at all, it's just a random attribute being set.
What makes use of the attribute is the include, which depending on the attribute value displays a mention.
You can add the include in a specific section if you have to. You can also set the attribute just before it if not global.
I can help if you tell me exactly what you want to do. AFAICS I added the comment for the opentelemetry-logging.adoc
and my understanding is that the whole thing is preview?
No description provided.