Skip to content

Commit

Permalink
Clement's suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
holly-cummins committed Nov 4, 2024
1 parent dc05fa3 commit cbe3bbd
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/src/main/asciidoc/extension-maturity-matrix.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,16 +150,25 @@ Many of these characteristics come by default with the Quarkus framework or http

=== Logging

Quarkus uses JBoss Logging as its logging engine, and xref:logging[supports several logging APIs]. Avoid using errors and warnings for conditions that will not affect normal operation. These outputs can cause false alarms in user monitoring systems.
Quarkus uses JBoss Logging as its logging engine, and xref:logging[supports several logging APIs]. (This is normal Java logging, not OpenTelemetry logging.)

Avoid using errors and warnings for conditions that will not affect normal operation. These outputs can cause false alarms in user monitoring systems.


=== Define health endpoints

Extensions may wish to xref:writing-extensions#extension-defined-endpoints[define library-specific endpoints].
Extensions may wish to xref:writing-extensions#extension-defined-endpoints[define library-specific endpoints] for health criteria which are specific to that extension. To add a new endpoint, extensions should produce a `NonApplicationRootPathBuildItem`.

=== Tracing context

You should test that OpenTelemetry output for applications using your extension have properly-defined spans. You may need to do extra work to ensure spans are created with the right OpenTracing ID.
For example, extensions which have reactive internals should support xref:duplicated-context.adoc[duplicated contexts] for correct context propagation.

=== Kubernetes integration
=== Advanced Kubernetes and containers integration

Quarkus is designed to be a Kubernetes-native runtime.
Extensions can continue this philosphy by adding library-specific integration points with Kubernetes.
Extensions can continue this philosophy by adding library-specific integration points with Kubernetes.
Being Kubernetes-native implies being container-native. At a minimum, extensions should always work well in containers, but extensions may also have opportunities to integrate with the lower levels of the container stack.


== References
Expand Down
Binary file modified docs/src/main/asciidoc/images/extension-maturity-matrix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cbe3bbd

Please sign in to comment.