Skip to content

Commit cbe3bbd

Browse files
committed
Clement's suggestions
1 parent dc05fa3 commit cbe3bbd

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

docs/src/main/asciidoc/extension-maturity-matrix.adoc

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,16 +150,25 @@ Many of these characteristics come by default with the Quarkus framework or http
150150

151151
=== Logging
152152

153-
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.
153+
Quarkus uses JBoss Logging as its logging engine, and xref:logging[supports several logging APIs]. (This is normal Java logging, not OpenTelemetry logging.)
154+
155+
Avoid using errors and warnings for conditions that will not affect normal operation. These outputs can cause false alarms in user monitoring systems.
156+
154157

155158
=== Define health endpoints
156159

157-
Extensions may wish to xref:writing-extensions#extension-defined-endpoints[define library-specific endpoints].
160+
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`.
161+
162+
=== Tracing context
163+
164+
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.
165+
For example, extensions which have reactive internals should support xref:duplicated-context.adoc[duplicated contexts] for correct context propagation.
158166

159-
=== Kubernetes integration
167+
=== Advanced Kubernetes and containers integration
160168

161169
Quarkus is designed to be a Kubernetes-native runtime.
162-
Extensions can continue this philosphy by adding library-specific integration points with Kubernetes.
170+
Extensions can continue this philosophy by adding library-specific integration points with Kubernetes.
171+
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.
163172

164173

165174
== References
-2.44 KB
Loading

0 commit comments

Comments
 (0)