Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore NullObservation in ObservationValidator #5389

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package io.micrometer.observation.tck;

import io.micrometer.common.lang.Nullable;
import io.micrometer.observation.NullObservation.NullContext;
import io.micrometer.observation.Observation.Context;
import io.micrometer.observation.Observation.Event;
import io.micrometer.observation.ObservationHandler;
Expand Down Expand Up @@ -47,7 +48,7 @@ class ObservationValidator implements ObservationHandler<Context> {
}

ObservationValidator(Consumer<ValidationResult> consumer) {
this(consumer, context -> true);
this(consumer, context -> !(context instanceof NullContext));
}

ObservationValidator(Consumer<ValidationResult> consumer, Predicate<Context> supportsContextPredicate) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package io.micrometer.observation.tck;

import io.micrometer.observation.NullObservation;
import io.micrometer.observation.Observation;
import io.micrometer.observation.Observation.Event;
import io.micrometer.observation.Observation.Scope;
Expand Down Expand Up @@ -253,4 +254,9 @@ void startErrorErrorStopShouldBeValid() {
Observation.start("test", registry).error(new RuntimeException()).error(new RuntimeException()).stop();
}

@Test
void nullObservationShouldBeIgnored() {
new NullObservation(registry).openScope();
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
public class NullObservation extends SimpleObservation {

public NullObservation(ObservationRegistry registry) {
super("null", registry, new Context());
super("null", registry, new NullContext());
}

@Override
Expand Down Expand Up @@ -66,4 +66,16 @@ public Observation start() {
return this;
}

/**
* A special {@link Observation.Context} that should be used only in
* {@link NullObservation} in special cases where clearing of scopes is important. Its
* only purpose is to make scenarios through {@link NullObservation} distinguishable
* from "normal" {@link Observation Observations}.
*
* @since 1.14.0
*/
public static class NullContext extends Context {

}

}