-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
91df07b
commit 0009e87
Showing
10 changed files
with
268 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
...c/main/java/io/quarkus/opentelemetry/runtime/config/build/EndUserSpanProcessorConfig.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
package io.quarkus.opentelemetry.runtime.config.build; | ||
|
||
import java.util.Optional; | ||
|
||
import io.quarkus.runtime.annotations.ConfigGroup; | ||
import io.smallrye.config.WithDefault; | ||
|
||
/** | ||
* Tracing build time configuration | ||
*/ | ||
@ConfigGroup | ||
public interface EndUserSpanProcessorConfig { | ||
|
||
/** | ||
* Enable the {@link io.quarkus.opentelemetry.runtime.exporter.otlp.EndUserSpanProcessor}. | ||
* <p> | ||
* The {@link io.quarkus.opentelemetry.runtime.exporter.otlp.EndUserSpanProcessor} adds | ||
* the {@link io.opentelemetry.semconv.trace.attributes.SemanticAttributes.ENDUSER_ID} | ||
* and {@link io.opentelemetry.semconv.trace.attributes.SemanticAttributes.ENDUSER_ROLE} to the Span. | ||
*/ | ||
@WithDefault("false") | ||
Optional<Boolean> enabled(); | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
...me/src/main/java/io/quarkus/opentelemetry/runtime/exporter/otlp/EndUserSpanProcessor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
package io.quarkus.opentelemetry.runtime.exporter.otlp; | ||
|
||
import jakarta.enterprise.context.ApplicationScoped; | ||
import jakarta.enterprise.context.control.ActivateRequestContext; | ||
import jakarta.inject.Inject; | ||
|
||
import org.eclipse.microprofile.context.ManagedExecutor; | ||
|
||
import io.opentelemetry.api.common.Attributes; | ||
import io.opentelemetry.context.Context; | ||
import io.opentelemetry.sdk.trace.ReadWriteSpan; | ||
import io.opentelemetry.sdk.trace.ReadableSpan; | ||
import io.opentelemetry.sdk.trace.SpanProcessor; | ||
import io.opentelemetry.semconv.trace.attributes.SemanticAttributes; | ||
import io.quarkus.security.identity.SecurityIdentity; | ||
|
||
@ApplicationScoped | ||
public class EndUserSpanProcessor implements SpanProcessor { | ||
|
||
@Inject | ||
protected SecurityIdentity securityIdentity; | ||
|
||
@Inject | ||
protected ManagedExecutor managedExecutor; | ||
|
||
@Override | ||
@ActivateRequestContext | ||
public void onStart(Context parentContext, ReadWriteSpan span) { | ||
managedExecutor.execute( | ||
() -> span.setAllAttributes( | ||
securityIdentity.isAnonymous() | ||
? Attributes.empty() | ||
: Attributes.of( | ||
SemanticAttributes.ENDUSER_ID, | ||
securityIdentity.getPrincipal().getName(), | ||
SemanticAttributes.ENDUSER_ROLE, | ||
securityIdentity.getRoles().toString()))); | ||
} | ||
|
||
@Override | ||
public boolean isStartRequired() { | ||
return Boolean.TRUE; | ||
} | ||
|
||
@Override | ||
public void onEnd(ReadableSpan span) { | ||
} | ||
|
||
@Override | ||
public boolean isEndRequired() { | ||
return Boolean.FALSE; | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
66 changes: 66 additions & 0 deletions
66
...on-tests/opentelemetry/src/test/java/io/quarkus/it/opentelemetry/AbstractEndUserTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
package io.quarkus.it.opentelemetry; | ||
|
||
import static io.restassured.RestAssured.given; | ||
import static java.util.concurrent.TimeUnit.SECONDS; | ||
import static org.awaitility.Awaitility.await; | ||
import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
||
import java.util.List; | ||
import java.util.function.Predicate; | ||
|
||
import jakarta.enterprise.inject.Instance; | ||
import jakarta.inject.Inject; | ||
|
||
import org.junit.jupiter.api.AfterEach; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
|
||
import io.opentelemetry.api.common.Attributes; | ||
import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter; | ||
import io.opentelemetry.sdk.trace.data.SpanData; | ||
import io.quarkus.it.opentelemetry.util.EndUserResource; | ||
import io.quarkus.opentelemetry.runtime.exporter.otlp.EndUserSpanProcessor; | ||
import io.quarkus.test.common.http.TestHTTPEndpoint; | ||
import io.quarkus.test.security.TestSecurity; | ||
|
||
@TestHTTPEndpoint(EndUserResource.class) | ||
@TestSecurity(user = "testUser", roles = { "admin", "user" }) | ||
public abstract class AbstractEndUserTest { | ||
|
||
@Inject | ||
InMemorySpanExporter inMemorySpanExporter; | ||
|
||
@Inject | ||
Instance<EndUserSpanProcessor> endUserSpanProcessor; | ||
|
||
protected final Predicate<Instance<EndUserSpanProcessor>> injectionPredicate; | ||
|
||
public AbstractEndUserTest(Predicate<Instance<EndUserSpanProcessor>> predicate) { | ||
this.injectionPredicate = predicate; | ||
} | ||
|
||
@BeforeEach | ||
@AfterEach | ||
protected void reset() { | ||
inMemorySpanExporter.reset(); | ||
} | ||
|
||
protected List<SpanData> getSpans() { | ||
return inMemorySpanExporter.getFinishedSpanItems(); | ||
} | ||
|
||
protected abstract void evaluateAttributes(Attributes attributes); | ||
|
||
@Test | ||
protected void baseTest() { | ||
assertTrue(this.injectionPredicate.test(endUserSpanProcessor)); | ||
given() | ||
.when().get() | ||
.then() | ||
.statusCode(200); | ||
await().atMost(5, SECONDS).until(() -> getSpans().size() == 1); | ||
SpanData spanData = getSpans().get(0); | ||
evaluateAttributes(spanData.getAttributes()); | ||
} | ||
|
||
} |
23 changes: 23 additions & 0 deletions
23
...on-tests/opentelemetry/src/test/java/io/quarkus/it/opentelemetry/EndUserDisabledTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
package io.quarkus.it.opentelemetry; | ||
|
||
import static org.junit.jupiter.api.Assertions.assertNull; | ||
|
||
import jakarta.enterprise.inject.Instance; | ||
|
||
import io.opentelemetry.api.common.Attributes; | ||
import io.opentelemetry.semconv.trace.attributes.SemanticAttributes; | ||
import io.quarkus.test.junit.QuarkusTest; | ||
|
||
@QuarkusTest | ||
public class EndUserDisabledTest extends AbstractEndUserTest { | ||
|
||
public EndUserDisabledTest() { | ||
super(Instance::isUnsatisfied); | ||
} | ||
|
||
@Override | ||
protected void evaluateAttributes(Attributes attributes) { | ||
assertNull(attributes.get(SemanticAttributes.ENDUSER_ID)); | ||
assertNull(attributes.get(SemanticAttributes.ENDUSER_ROLE)); | ||
} | ||
} |
26 changes: 26 additions & 0 deletions
26
...ion-tests/opentelemetry/src/test/java/io/quarkus/it/opentelemetry/EndUserEnabledTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
package io.quarkus.it.opentelemetry; | ||
|
||
import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
||
import jakarta.enterprise.inject.Instance; | ||
|
||
import io.opentelemetry.api.common.Attributes; | ||
import io.opentelemetry.semconv.trace.attributes.SemanticAttributes; | ||
import io.quarkus.it.opentelemetry.util.EndUserProfile; | ||
import io.quarkus.test.junit.QuarkusTest; | ||
import io.quarkus.test.junit.TestProfile; | ||
|
||
@QuarkusTest | ||
@TestProfile(EndUserProfile.class) | ||
public class EndUserEnabledTest extends AbstractEndUserTest { | ||
|
||
public EndUserEnabledTest() { | ||
super(Instance::isResolvable); | ||
} | ||
|
||
@Override | ||
protected void evaluateAttributes(Attributes attributes) { | ||
assertEquals(attributes.get(SemanticAttributes.ENDUSER_ID), "testUser"); | ||
assertEquals(attributes.get(SemanticAttributes.ENDUSER_ROLE), "[admin, user]"); | ||
} | ||
} |
15 changes: 15 additions & 0 deletions
15
...on-tests/opentelemetry/src/test/java/io/quarkus/it/opentelemetry/util/EndUserProfile.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
package io.quarkus.it.opentelemetry.util; | ||
|
||
import java.util.Map; | ||
|
||
import io.quarkus.test.junit.QuarkusTestProfile; | ||
|
||
public class EndUserProfile implements QuarkusTestProfile { | ||
|
||
@Override | ||
public Map<String, String> getConfigOverrides() { | ||
return Map.of( | ||
"quarkus.otel.traces.eusp.enabled", "true"); | ||
} | ||
|
||
} |
17 changes: 17 additions & 0 deletions
17
...n-tests/opentelemetry/src/test/java/io/quarkus/it/opentelemetry/util/EndUserResource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
package io.quarkus.it.opentelemetry.util; | ||
|
||
import jakarta.enterprise.context.RequestScoped; | ||
import jakarta.ws.rs.GET; | ||
import jakarta.ws.rs.Path; | ||
import jakarta.ws.rs.core.Response; | ||
|
||
@Path("/otel/enduser") | ||
@RequestScoped | ||
public class EndUserResource { | ||
|
||
@GET | ||
public Response dummy() { | ||
return Response.ok().build(); | ||
} | ||
|
||
} |