Moved Event back to Observation

Author: marcingrzejszczak

micrometer-commons/src/main/java/io/micrometer/common/Event.java

@@ -15,7 +15,6 @@
  */
 package io.micrometer.core.instrument.observation;
 
-import io.micrometer.common.Event;
 import io.micrometer.core.instrument.*;
 import io.micrometer.observation.Observation;
 
@@ -66,7 +65,7 @@ public void onStop(Observation.Context context) {
     }
 
     @Override
-    public void onEvent(Event event, Observation.Context context) {
+    public void onEvent(Observation.Event event, Observation.Context context) {
         Counter.builder(context.getName() + "." + event.getName()).tags(createTags(context)).register(meterRegistry)
                 .increment();
     }

micrometer-core/src/main/java/io/micrometer/core/instrument/observation/DefaultMeterObservationHandler.java

@@ -15,7 +15,6 @@
  */
 package io.micrometer.observation.tck;
 
-import io.micrometer.common.Event;
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationHandler;
 import org.junit.jupiter.api.DisplayName;
@@ -42,7 +41,8 @@ void handlerSupportsAnyContext() {
         assertThatCode(() -> handler.onStart(testContext)).doesNotThrowAnyException();
         assertThatCode(() -> handler.onStop(testContext)).doesNotThrowAnyException();
         assertThatCode(() -> handler.onError(testContext)).doesNotThrowAnyException();
-        assertThatCode(() -> handler.onEvent(Event.of("testEvent"), testContext)).doesNotThrowAnyException();
+        assertThatCode(() -> handler.onEvent(Observation.Event.of("testEvent"), testContext))
+                .doesNotThrowAnyException();
         assertThatCode(() -> handler.onScopeOpened(testContext)).doesNotThrowAnyException();
         assertThatCode(() -> handler.supportsContext(testContext)).doesNotThrowAnyException();
         assertThat(handler.supportsContext(testContext)).as("Handler supports any context").isTrue();

micrometer-observation-test/src/main/java/io/micrometer/observation/tck/AnyContextObservationHandlerCompatibilityKit.java

@@ -15,7 +15,6 @@
  */
 package io.micrometer.observation.tck;
 
-import io.micrometer.common.Event;
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationHandler;
 import io.micrometer.observation.ObservationRegistry;
@@ -59,7 +58,7 @@ void handlerSupportsConcreteContextForHandlerMethods() {
         assertThatCode(() -> handler.onStart(context())).doesNotThrowAnyException();
         assertThatCode(() -> handler.onStop(context())).doesNotThrowAnyException();
         assertThatCode(() -> handler.onError(context())).doesNotThrowAnyException();
-        assertThatCode(() -> handler.onEvent(Event.of("testEvent"), context())).doesNotThrowAnyException();
+        assertThatCode(() -> handler.onEvent(Observation.Event.of("testEvent"), context())).doesNotThrowAnyException();
         assertThatCode(() -> handler.onScopeOpened(context())).doesNotThrowAnyException();
     }
 

micrometer-observation-test/src/main/java/io/micrometer/observation/tck/ConcreteContextObservationHandlerCompatibilityKit.java

@@ -15,7 +15,6 @@
  */
 package io.micrometer.observation.tck;
 
-import io.micrometer.common.Event;
 import io.micrometer.common.KeyValue;
 import io.micrometer.common.KeyValues;
 import io.micrometer.common.lang.Nullable;
@@ -82,7 +81,7 @@ void observeWithHandlers() {
             inOrder.verify(handler).onScopeOpened(isA(Observation.Context.class));
             assertThat(scope.getCurrentObservation()).isSameAs(observation);
 
-            Event event = Event.of("testEvent", "event for testing");
+            Observation.Event event = Observation.Event.of("testEvent", "event for testing");
             observation.event(event);
             inOrder.verify(handler).onEvent(same(event), isA(Observation.Context.class));
 

micrometer-observation-test/src/main/java/io/micrometer/observation/tck/ObservationRegistryCompatibilityKit.java

@@ -15,7 +15,6 @@
  */
 package io.micrometer.observation.tck;
 
-import io.micrometer.common.Event;
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationHandler;
 
@@ -33,7 +32,7 @@ public void onError(Observation.Context context) {
             }
 
             @Override
-            public void onEvent(Event event, Observation.Context context) {
+            public void onEvent(Observation.Event event, Observation.Context context) {
             }
 
             @Override

micrometer-observation-test/src/test/java/io/micrometer/observation/tck/AnyContextObservationHandlerCompatibilityKitTests.java

@@ -15,7 +15,6 @@
  */
 package io.micrometer.observation.tck;
 
-import io.micrometer.common.Event;
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationHandler;
 
@@ -34,7 +33,7 @@ public void onError(Observation.Context context) {
             }
 
             @Override
-            public void onEvent(Event event, Observation.Context context) {
+            public void onEvent(Observation.Event event, Observation.Context context) {
             }
 
             @Override

micrometer-observation-test/src/test/java/io/micrometer/observation/tck/ConcreteContextObservationHandlerCompatibilityKitTests.java

@@ -15,7 +15,6 @@
  */
 package io.micrometer.observation.tck;
 
-import io.micrometer.common.Event;
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationHandler;
 
@@ -33,7 +32,7 @@ public void onError(Observation.Context context) {
             }
 
             @Override
-            public void onEvent(Event event, Observation.Context context) {
+            public void onEvent(Observation.Event event, Observation.Context context) {
             }
 
             @Override

micrometer-observation-test/src/test/java/io/micrometer/observation/tck/NullContextObservationHandlerCompatibilityKitTests.java

@@ -16,7 +16,6 @@
 package io.micrometer.observation;
 
 import io.micrometer.common.KeyValue;
-import io.micrometer.common.Event;
 
 /**
  * No-op implementation of {@link Observation} so that we can disable the instrumentation

micrometer-observation/src/main/java/io/micrometer/observation/NoopObservation.java

@@ -17,7 +17,6 @@
 
 import io.micrometer.common.KeyValue;
 import io.micrometer.common.KeyValues;
-import io.micrometer.common.Event;
 import io.micrometer.common.lang.NonNull;
 import io.micrometer.common.lang.Nullable;
 
@@ -1107,4 +1106,81 @@ interface CheckedCallable<T, E extends Throwable> {
 
     }
 
+    /**
+     * Represents an event used for documenting instrumentation.
+     *
+     * @author Marcin Grzejszczak
+     * @since 1.10.0
+     */
+    interface Event {
+
+        /**
+         * Returns event name.
+         * @return event name
+         */
+        String getName();
+
+        /**
+         * Returns event contextual name. You can use {@code %s} to represent dynamic
+         * entries that should be resolved at runtime via
+         * {@link String#format(String, Object...)}.
+         * @return event contextual name
+         */
+        default String getContextualName() {
+            return getName();
+        }
+
+        /**
+         * Creates a {@link Event} for the given names.
+         * @param name event name
+         * @param contextualName event contextual name
+         * @return event
+         */
+        static Event of(String name, String contextualName) {
+            return new Event() {
+                @Override
+                public String getName() {
+                    return name;
+                }
+
+                @Override
+                public String getContextualName() {
+                    return contextualName;
+                }
+            };
+        }
+
+        /**
+         * Creates a {@link Event} for the given name.
+         * @param name event name
+         * @return event
+         */
+        static Event of(String name) {
+            return of(name, name);
+        }
+
+        /**
+         * Creates an event for the given key name.
+         * @param dynamicEntriesForContextualName variables to be resolved in
+         * {@link Event#getContextualName()} via {@link String#format(String, Object...)}
+         * @return event
+         */
+        default Event format(Object... dynamicEntriesForContextualName) {
+            Event parent = this;
+            return new Event() {
+
+                @Override
+                public String getName() {
+                    return parent.getName();
+                }
+
+                @Override
+                public String getContextualName() {
+                    return String.format(parent.getContextualName(), dynamicEntriesForContextualName);
+                }
+            };
+        }
+
+    }
+
 }