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

Fully initialize OpenTelemetry items during start-up #9489

Merged
merged 2 commits into from
Nov 13, 2024
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 @@ -15,13 +15,19 @@
*/
package io.helidon.microprofile.telemetry;

import io.helidon.tracing.Tracer;

import io.opentelemetry.instrumentation.annotations.WithSpan;
import jakarta.annotation.Priority;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.enterprise.context.Initialized;
import jakarta.enterprise.event.Observes;
import jakarta.enterprise.inject.spi.BeforeBeanDiscovery;
import jakarta.enterprise.inject.spi.Extension;
import jakarta.enterprise.inject.spi.ProcessAnnotatedType;
import jakarta.enterprise.inject.spi.WithAnnotations;
import jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator;
import jakarta.interceptor.Interceptor;

/**
* CDI extension for Microprofile Telemetry implementation.
Expand Down Expand Up @@ -62,4 +68,13 @@ void processAnnotations(@Observes @WithAnnotations(WithSpan.class) ProcessAnnota
}
}
}

void finish(@Observes @Priority(Interceptor.Priority.LIBRARY_BEFORE) @Initialized(ApplicationScoped.class) Object startup,
Tracer tracer) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have to refresh my memory here but I'm not fully sure whether the mere appearance of a Tracer client proxy here will cause its underlying target instance to be created. You may have to invoke a business method on it to force proxy "inflation". toString shouldn't do the trick, but IIRC it does.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(The relevant section of the specification is probably the one on client proxy invocations, not business methods; sorry about that.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is interesting. TRACE-level logging is not turned on during the build (and therefore when the unit test runs) nor would it likely be at runtime, so even toString is not likely to be invoked.

That said, during the build the new unit test failed before I added that observer method to the extension and passed afterwards.

To be safer I can revise the observer method to invoke enabled--not inherited from Object as the spec warns against--on the Tracer object.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right; for posterity, you can call toString. It is both the only method that has defined semantics for client proxies and fulfills the proxy inflation conditions.

// Forcing CDI to get us a tracer and then invoking one of the bean's methods triggers the producer to do its
// initialization, including setting the global tracer as part of start up.
tracer.enabled();
LOGGER.log(System.Logger.Level.TRACE,
() -> "Global tracer set to " + tracer.unwrap(io.opentelemetry.api.trace.Tracer.class));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
* Copyright (c) 2024 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.helidon.microprofile.telemetry;

import io.helidon.tracing.Tracer;

import jakarta.enterprise.context.ApplicationScoped;
import jakarta.enterprise.context.Initialized;
import jakarta.enterprise.event.Observes;
import jakarta.enterprise.inject.spi.Extension;

public class TestExtension implements Extension {

static Tracer globalTracerAtStartup;

void startup(@Observes @Initialized(ApplicationScoped.class) Object startup) {
globalTracerAtStartup = Tracer.global();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*
* Copyright (c) 2024 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.helidon.microprofile.telemetry;

import io.helidon.microprofile.testing.junit5.AddConfig;
import io.helidon.microprofile.testing.junit5.HelidonTest;

import org.junit.jupiter.api.Test;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.not;

@HelidonTest
@AddConfig(key = "otel.sdk.disabled", value = "false")
class TestTracerAtStartup {

@Test
void checkForFullFeaturedTracerAtStartup() {
assertThat("Global tracer from start-up extension",
TestExtension.globalTracerAtStartup.unwrap(io.opentelemetry.api.trace.Tracer.class).getClass().getName(),
not(containsString("Default")));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
io.helidon.microprofile.telemetry.TestExtension