Closes #1297 - Use OpenTelemetry as OpenCensus implementation (#1431)

Co-authored-by: Heiko Holz <heiko.holz@novatec-gmbh.de>
Co-authored-by: Marius Brill <marius.brill@novatec-gmbh.de>

Author: 3 people

THIRD-PARTY-LICENSES.txt

@@ -138,7 +138,8 @@ dependencies {
             "io.springfox:springfox-swagger2:2.9.2",
             "io.springfox:springfox-swagger-ui:2.9.2",
 
-            "io.opencensus:opencensus-impl:${openCensusVersion}"
+            "io.opentelemetry:opentelemetry-sdk:${openTelemetryVersion}",
+            "io.opentelemetry:opentelemetry-opencensus-shim:${openTelemetryAlphaVersion}"
     )
     testImplementation(
             'org.springframework.boot:spring-boot-starter-test:2.1.6.RELEASE',

components/inspectit-ocelot-configurationserver/build.gradle

@@ -189,7 +189,8 @@ protected String verifyPath(String relativeBasePath, String relativePath) throws
         Path path = Paths.get(relativePath).normalize();
 
         if (StringUtils.isBlank(relativeBasePath)) {
-            return path.toString().replace("\\", "/");
+            // replace '\' with '/'. A regex that matches a single backslash character must include four backslashes, see https://www.gnu.org/software/guile/manual/html_node/Backslash-Escapes.html
+            return path.toString().replaceAll("\\\\", "/");
         }
 
         Path basePath = Paths.get(relativeBasePath).normalize();
@@ -199,7 +200,8 @@ protected String verifyPath(String relativeBasePath, String relativePath) throws
             throw new IllegalArgumentException("User path escapes the base path: " + relativePath);
         }
 
-        return resolvedPath.toString().replace("\\", "/");
+        // replace '\' with '/'. A regex that matches a single backslash character must include four backslashes, see https://www.gnu.org/software/guile/manual/html_node/Backslash-Escapes.html
+        return resolvedPath.toString().replaceAll("\\\\", "/");
     }
 
     @Override

components/inspectit-ocelot-configurationserver/src/main/java/rocks/inspectit/ocelot/file/accessor/git/RevisionAccess.java

@@ -47,7 +47,7 @@ void pastList() {
 
             List<String> result = completer.getSuggestions(input);
 
-            assertThat(result).containsExactlyInAnyOrder("config", "exporters", "instrumentation", "logging", "metrics", "plugins", "privacy", "publish-open-census-to-bootstrap", "self-monitoring", "service-name", "tags", "thread-pool-size", "tracing", "agent-commands", "log-preloading");
+            assertThat(result).containsExactlyInAnyOrder("config", "exporters", "instrumentation", "logging", "metrics", "plugins", "privacy", "publish-open-telemetry-to-bootstrap", "self-monitoring", "service-name", "tags", "thread-pool-size", "tracing", "agent-commands", "log-preloading");
         }
 
         @Test
@@ -119,7 +119,7 @@ void startsNotLikeInspectit() {
 
         @Test
         void startsNotWithInspectit() {
-            List<String> input = Arrays.asList("test", "antotherTest");
+            List<String> input = Arrays.asList("test", "anotherTest");
 
             List<String> result = completer.getSuggestions(input);
 
@@ -152,7 +152,7 @@ public class GetProperties {
         void getPropertiesInspectit() {
             List<String> result = completer.getProperties(InspectitConfig.class);
 
-            assertThat(result).containsExactlyInAnyOrder("config", "env", "exporters", "instrumentation", "logging", "metrics", "plugins", "privacy", "publish-open-census-to-bootstrap", "self-monitoring", "service-name", "tags", "thread-pool-size", "tracing", "agent-commands", "log-preloading");
+            assertThat(result).containsExactlyInAnyOrder("config", "env", "exporters", "instrumentation", "logging", "metrics", "plugins", "privacy", "publish-open-telemetry-to-bootstrap", "self-monitoring", "service-name", "tags", "thread-pool-size", "tracing", "agent-commands", "log-preloading");
         }
     }
 }

components/inspectit-ocelot-configurationserver/src/test/java/rocks/inspectit/ocelot/autocomplete/autocompleterimpl/ModelAutoCompleterTest.java

@@ -46,10 +46,13 @@ public class InfluxExporterService {
     private boolean shouldEnable() {
         InfluxExporterSettings influx = configuration.getExporters().getMetrics().getInflux();
         if (!influx.getEnabled().isDisabled()) {
-            if (StringUtils.hasText(influx.getUrl())) {
+            if (StringUtils.hasText(influx.getEndpoint())) {
+                return true;
+            } else if (StringUtils.hasText(influx.getUrl())) {
+                log.warn("You are using the deprecated property 'url'. This property will be invalid in future releases of InspectIT Ocelot, please use `endpoint` instead.");
                 return true;
             } else if (influx.getEnabled().equals(ExporterEnabledState.ENABLED)) {
-                log.warn("InfluxDB Exporter is enabled but no url set.");
+                log.warn("InfluxDB Exporter is enabled but 'endpoint' is not set.");
             }
         }
         return false;
@@ -59,9 +62,10 @@ private boolean shouldEnable() {
     private void doEnable() {
         InfluxExporterSettings influx = configuration.getExporters().getMetrics().getInflux();
         if (shouldEnable()) {
-            log.info("Starting InfluxDB Exporter to '{}:{}' on '{}'", influx.getDatabase(), influx.getRetentionPolicy(), influx.getUrl());
+            String endpoint = StringUtils.hasText(influx.getEndpoint()) ? influx.getEndpoint() : influx.getUrl();
+            log.info("Starting InfluxDB Exporter to '{}:{}' on '{}'", influx.getDatabase(), influx.getRetentionPolicy(), endpoint);
             activeExporter = InfluxExporter.builder()
-                    .url(influx.getUrl())
+                    .url(endpoint)
                     .database(influx.getDatabase())
                     .retention(influx.getRetentionPolicy())
                     .user(influx.getUser())

components/inspectit-ocelot-eum-server/src/main/java/rocks/inspectit/oce/eum/server/exporters/InfluxExporterService.java

@@ -17,6 +17,7 @@
 import rocks.inspectit.ocelot.config.model.exporters.trace.TraceExportersSettings;
 
 import javax.annotation.PostConstruct;
+import javax.validation.Valid;
 import java.util.Optional;
 
 @Configuration
@@ -33,23 +34,23 @@ public void logWrongJaegerConfig() {
                 .map(TraceExportersSettings::getJaeger)
                 .filter((jaeger) -> !jaeger.getEnabled().isDisabled())
                 .ifPresent(settings -> {
-                    if (StringUtils.hasText(settings.getUrl()) && !StringUtils.hasText(settings.getGrpc())) {
-                        log.warn("In order to use Jaeger span exporter, please specify the grpc API endpoint property instead of the url.");
+                    if (StringUtils.hasText(settings.getUrl()) && !StringUtils.hasText(settings.getEndpoint())) {
+                        log.warn("In order to use Jaeger span exporter, please specify the grpc API 'endpoint' property instead of the 'url'.");
                     }
                 });
     }
 
     @Bean(destroyMethod = "shutdown")
-    @ConditionalOnProperty({"inspectit-eum-server.exporters.tracing.jaeger.enabled", "inspectit-eum-server.exporters.tracing.jaeger.grpc"})
-    @ConditionalOnExpression("(NOT new String('${inspectit-eum-server.exporters.tracing.jaeger.enabled}').toUpperCase().equals(T(rocks.inspectit.ocelot.config.model.exporters.ExporterEnabledState).DISABLED.toString())) AND (new String('${inspectit-eum-server.exporters.tracing.jaeger.grpc}').length() > 0)")
+    @ConditionalOnProperty({"inspectit-eum-server.exporters.tracing.jaeger.enabled", "inspectit-eum-server.exporters.tracing.jaeger.endpoint"})
+    @ConditionalOnExpression("(NOT new String('${inspectit-eum-server.exporters.tracing.jaeger.enabled}').toUpperCase().equals(T(rocks.inspectit.ocelot.config.model.exporters.ExporterEnabledState).DISABLED.toString())) AND (new String('${inspectit-eum-server.exporters.tracing.jaeger.endpoint}').length() > 0)")
     public SpanExporter jaegerSpanExporter() {
         JaegerExporterSettings jaegerExporterSettings = configuration.getExporters().getTracing().getJaeger();
 
-        ManagedChannel channel = ManagedChannelBuilder.forTarget(jaegerExporterSettings.getGrpc())
+        ManagedChannel channel = ManagedChannelBuilder.forTarget(jaegerExporterSettings.getEndpoint())
                 .usePlaintext()
                 .build();
 
-        log.info("Starting Jaeger Exporter on grpc '{}'", jaegerExporterSettings.getGrpc());
+        log.info("Starting Jaeger Exporter on grpc '{}'", jaegerExporterSettings.getEndpoint());
         System.setProperty("otel.resource.attributes", "service.name=" + jaegerExporterSettings.getServiceName());
 
         return JaegerGrpcSpanExporter.builder().setChannel(channel).build();

components/inspectit-ocelot-eum-server/src/main/java/rocks/inspectit/oce/eum/server/exporters/configuration/TraceExportersConfiguration.java

@@ -172,10 +172,14 @@ inspectit-eum-server:
         # If jaeger exporter for the OT received spans is enabled.
         enabled: IF_CONFIGURED
 
+        # The transport protocol
+        protocol: grpc
+
         # Location of the jaeger gRPC API.
         # Either a valid NameResolver-compliant URI, or an authority string.
         # If this property is not set, the jaeger-exporter will not be started.
-        # grpc: localhost:14250
+        # endpoint: localhost:14250
+
 
         # service name for all exported spans.
         service-name: browser-js

components/inspectit-ocelot-eum-server/src/main/resources/application.yml

@@ -16,6 +16,7 @@
 import org.testcontainers.containers.wait.strategy.Wait;
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
+import rocks.inspectit.ocelot.config.model.exporters.ExporterEnabledState;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -41,16 +42,14 @@ public class JaegerExporterIntTest {
     public static final String SERVICE_NAME = "E2E-test";
 
     @Container
-    public static GenericContainer<?> jaegerContainer = new GenericContainer<>("ghcr.io/open-telemetry/java-test-containers:jaeger")
-            .withExposedPorts(COLLECTOR_PORT, QUERY_PORT, HEALTH_PORT)
+    public static GenericContainer<?> jaegerContainer = new GenericContainer<>("ghcr.io/open-telemetry/java-test-containers:jaeger").withExposedPorts(COLLECTOR_PORT, QUERY_PORT, HEALTH_PORT)
             .waitingFor(Wait.forHttp("/").forPort(HEALTH_PORT));
 
     static class EnvInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
 
         @Override
         public void initialize(ConfigurableApplicationContext applicationContext) {
-            TestPropertyValues.of(String.format("inspectit-eum-server.exporters.tracing.jaeger.grpc=%s:%d", jaegerContainer
-                    .getHost(), jaegerContainer.getMappedPort(COLLECTOR_PORT)), "inspectit-eum-server.exporters.tracing.jaeger.service-name=" + JaegerExporterIntTest.SERVICE_NAME)
+            TestPropertyValues.of("inspectit-eum-server.exporters.tracing.jaeger.enabled=" + ExporterEnabledState.ENABLED, String.format("inspectit-eum-server.exporters.tracing.jaeger.endpoint=%s:%d", jaegerContainer.getHost(), jaegerContainer.getMappedPort(COLLECTOR_PORT)), "inspectit-eum-server.exporters.tracing.jaeger.service-name=" + JaegerExporterIntTest.SERVICE_NAME, "inspectit-eum-server.exporters.tracing.jaeger.protocol=grpc")
                     .applyTo(applicationContext);
         }
     }

components/inspectit-ocelot-eum-server/src/test/java/rocks/inspectit/oce/eum/server/exporters/JaegerExporterIntTest.java

@@ -11,14 +11,14 @@
 
 /**
  * This Test class tests whether the annotations on {@link TraceExportersConfiguration#jaegerSpanExporter()} are working as expected,
- * i.e. whether the Bean only gets created when 'jaeger.enabled' is not set to DISABLED and 'jaeger.grpc' is not empty.
+ * i.e. whether the Bean only gets created when 'jaeger.enabled' is not set to DISABLED and 'jaeger.endpoint' is not empty.
  */
 @SpringBootTest
 class TraceExportersConfigurationTest {
 
-    @TestPropertySource(properties = {"inspectit-eum-server.exporters.tracing.jaeger.grpc=", "inspectit-eum-server.exporters.tracing.jaeger.enabled=ENABLED"})
+    @TestPropertySource(properties = {"inspectit-eum-server.exporters.tracing.jaeger.endpoint=", "inspectit-eum-server.exporters.tracing.jaeger.enabled=ENABLED"})
     @Nested
-    public class MissingGrpcTest {
+    public class MissingEndpointTest {
 
         @Autowired(required = false)
         JaegerGrpcSpanExporter exporter;
@@ -29,7 +29,7 @@ public void testBeanWasNotCreated() {
         }
     }
 
-    @TestPropertySource(properties = {"inspectit-eum-server.exporters.tracing.jaeger.grpc=localhost:1234", "inspectit-eum-server.exporters.tracing.jaeger.enabled=DISABLED"})
+    @TestPropertySource(properties = {"inspectit-eum-server.exporters.tracing.jaeger.endpoint=localhost:1234", "inspectit-eum-server.exporters.tracing.jaeger.enabled=DISABLED", "inspectit-eum-server.exporters.tracing.jaeger.protocol=grpc"})
     @Nested
     public class DisabledTest {
 
@@ -42,7 +42,7 @@ public void testBeanWasNotCreated() {
         }
     }
 
-    @TestPropertySource(properties = {"inspectit-eum-server.exporters.tracing.jaeger.grpc=localhost:1234", "inspectit-eum-server.exporters.tracing.jaeger.enabled=ENABLED"})
+    @TestPropertySource(properties = {"inspectit-eum-server.exporters.tracing.jaeger.endpoint=localhost:1234", "inspectit-eum-server.exporters.tracing.jaeger.enabled=ENABLED", "inspectit-eum-server.exporters.tracing.jaeger.protocol=grpc"})
     @Nested
     public class BothAvailableTest {
 

components/inspectit-ocelot-eum-server/src/test/java/rocks/inspectit/oce/eum/server/exporters/configuration/TraceExportersConfigurationTest.java

@@ -7,9 +7,14 @@ logbackVersion=1.2.10
 
 # Ensure to adapt the netty version (inspectit-ocelot-core/build.gradle) when changing the OpenCensus version
 openCensusVersion=0.28.3
-prometheusClientVersion=0.6.0
+# OpenTelemetry related
+openTelemetryVersion=1.10.0
+openTelemetryAlphaVersion=1.10.0-alpha
+
+prometheusClientVersion=0.15.0
 # appropriate netty version, see https://github.com/census-instrumentation/opencensus-java/blob/master/exporters/trace/ocagent/README.md
 tcnativeVersion=2.0.20.Final
+grpcVersion=1.43.1
 
 # CycloneDX SBOM settings
 # Specifies the type of project being built. Defaults to 'library'