From 22a81f0cf1ac3f21e3b0b1f93a2b8c5c079422e2 Mon Sep 17 00:00:00 2001 From: Jonatan Ivanov Date: Wed, 23 Nov 2022 09:56:40 -0800 Subject: [PATCH] Add note to Observation#observationConvention about setting the convention --- .../src/main/java/io/micrometer/observation/Observation.java | 4 +++- 1 file changed, 3 insertions(+), 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 index 81d5878a8e..156a450405 100644 --- 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