Add note to Observation#observationConvention about setting the conve…

…ntion
micrometer-metrics · Nov 23, 2022 · 22a81f0 · 22a81f0
1 parent 3f0ca2f
commit 22a81f0
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/micrometer-observation/src/main/java/io/micrometer/observation/Observation.java b/micrometer-observation/src/main/java/io/micrometer/observation/Observation.java
@@ -414,7 +414,9 @@ default boolean isNoop() {
 
     /**
      * Sets an observation convention that can be used to attach key values to the
-     * observation. WARNING: You must set the ObservationConvention to the Observation
+     * observation. Implementations should only set the convention when it supports (see:
+     * {@link ObservationConvention#supportsContext(Context)}) the current
+     * {@link Context}. WARNING: You must set the ObservationConvention to the Observation
      * before it is started.
      * @param observationConvention observation convention
      * @return this