Upgrade OpenTelemetry

Signed-off-by: Antoine Toulme <antoine@lunar-ocean.com>
hyperledger · Jun 23, 2022 · 8c4f998 · 8c4f998
1 parent 5ee9be8
commit 8c4f998
Show file tree

Hide file tree

Showing 22 changed files with 253 additions and 177 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Additions and Improvements
 ### Bug Fixes
 - Fixed a snapsync issue that can sometimes block the healing step [#3920](https://github.com/hyperledger/besu/pull/3920)
+- Upgrade OpenTelemetry to version 1.15.0 [#3675](https://github.com/hyperledger/besu/pull/3675)
 
 ## 22.4.3
 

diff --git a/...ance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/BesuNode.java b/...ance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/BesuNode.java
@@ -127,6 +127,7 @@ public class BesuNode implements NodeConfiguration, RunnableNode, AutoCloseable
   private Optional<Integer> exitCode = Optional.empty();
   private Optional<PkiKeyStoreConfiguration> pkiKeyStoreConfiguration = Optional.empty();
   private final boolean isStrictTxReplayProtectionEnabled;
+  private final Map<String, String> environment;
 
   public BesuNode(
       final String name,
@@ -159,7 +160,8 @@ public BesuNode(
       final List<String> runCommand,
       final Optional<KeyPair> keyPair,
       final Optional<PkiKeyStoreConfiguration> pkiKeyStoreConfiguration,
-      final boolean isStrictTxReplayProtectionEnabled)
+      final boolean isStrictTxReplayProtectionEnabled,
+      final Map<String, String> environment)
       throws IOException {
     this.homeDirectory = dataPath.orElseGet(BesuNode::createTmpDataDirectory);
     this.isStrictTxReplayProtectionEnabled = isStrictTxReplayProtectionEnabled;
@@ -216,6 +218,7 @@ public BesuNode(
     this.isDnsEnabled = isDnsEnabled;
     privacyParameters.ifPresent(this::setPrivacyParameters);
     this.pkiKeyStoreConfiguration = pkiKeyStoreConfiguration;
+    this.environment = environment;
     LOG.info("Created BesuNode {}", this);
   }
 
@@ -794,4 +797,9 @@ public void verify(final Condition expected) {
   public void setExitCode(final int exitValue) {
     this.exitCode = Optional.of(exitValue);
   }
+
+  @Override
+  public Map<String, String> getEnvironment() {
+    return environment;
+  }
 }
diff --git a/...l/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ProcessBesuNodeRunner.java b/...l/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ProcessBesuNodeRunner.java
@@ -419,6 +419,8 @@ public void startNode(final BesuNode node) {
             "JAVA_OPTS",
             "-Djava.security.properties="
                 + "acceptance-tests/tests/build/resources/test/acceptanceTesting.security");
+    // add additional environment variables
+    processBuilder.environment().putAll(node.getEnvironment());
     try {
       checkState(
           isNotAliveOrphan(node.getName()),

diff --git a/...a/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeConfiguration.java b/...a/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeConfiguration.java
@@ -30,6 +30,7 @@
 
 import java.nio.file.Path;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
 public class BesuNodeConfiguration {
@@ -65,6 +66,7 @@ public class BesuNodeConfiguration {
   private final Optional<KeyPair> keyPair;
   private final Optional<PkiKeyStoreConfiguration> pkiKeyStoreConfiguration;
   private final boolean strictTxReplayProtectionEnabled;
+  private final Map<String, String> environment;
 
   BesuNodeConfiguration(
       final String name,
@@ -97,7 +99,8 @@ public class BesuNodeConfiguration {
       final List<String> runCommand,
       final Optional<KeyPair> keyPair,
       final Optional<PkiKeyStoreConfiguration> pkiKeyStoreConfiguration,
-      final boolean strictTxReplayProtectionEnabled) {
+      final boolean strictTxReplayProtectionEnabled,
+      final Map<String, String> environment) {
     this.name = name;
     this.miningParameters = miningParameters;
     this.jsonRpcConfiguration = jsonRpcConfiguration;
@@ -129,6 +132,7 @@ public class BesuNodeConfiguration {
     this.keyPair = keyPair;
     this.pkiKeyStoreConfiguration = pkiKeyStoreConfiguration;
     this.strictTxReplayProtectionEnabled = strictTxReplayProtectionEnabled;
+    this.environment = environment;
   }
 
   public String getName() {
@@ -254,4 +258,8 @@ public Optional<PkiKeyStoreConfiguration> getPkiKeyStoreConfiguration() {
   public boolean isStrictTxReplayProtectionEnabled() {
     return strictTxReplayProtectionEnabled;
   }
+
+  public Map<String, String> getEnvironment() {
+    return environment;
+  }
 }
diff --git a/...yperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeConfigurationBuilder.java b/...yperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeConfigurationBuilder.java
@@ -44,7 +44,9 @@
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
 public class BesuNodeConfigurationBuilder {
@@ -85,6 +87,7 @@ public class BesuNodeConfigurationBuilder {
   private Optional<KeyPair> keyPair = Optional.empty();
   private Optional<PkiKeyStoreConfiguration> pkiKeyStoreConfiguration = Optional.empty();
   private Boolean strictTxReplayProtectionEnabled = false;
+  private Map<String, String> environment = new HashMap<>();
 
   public BesuNodeConfigurationBuilder() {
     // Check connections more frequently during acceptance tests to cut down on
@@ -478,6 +481,11 @@ public BesuNodeConfigurationBuilder strictTxReplayProtectionEnabled(
     return this;
   }
 
+  public BesuNodeConfigurationBuilder environment(final Map<String, String> environment) {
+    this.environment = environment;
+    return this;
+  }
+
   public BesuNodeConfiguration build() {
     return new BesuNodeConfiguration(
         name,
@@ -510,6 +518,7 @@ public BesuNodeConfiguration build() {
         runCommand,
         keyPair,
         pkiKeyStoreConfiguration,
-        strictTxReplayProtectionEnabled);
+        strictTxReplayProtectionEnabled,
+        environment);
   }
 }
diff --git a/...in/java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeFactory.java b/...in/java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeFactory.java
@@ -88,7 +88,8 @@ public BesuNode create(final BesuNodeConfiguration config) throws IOException {
         config.getRunCommand(),
         config.getKeyPair(),
         config.getPkiKeyStoreConfiguration(),
-        config.isStrictTxReplayProtectionEnabled());
+        config.isStrictTxReplayProtectionEnabled(),
+        config.getEnvironment());
   }
 
   public BesuNode createMinerNode(

diff --git a/.../java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/NodeConfiguration.java b/.../java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/NodeConfiguration.java
@@ -18,6 +18,7 @@
 
 import java.net.URI;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
 public interface NodeConfiguration {
@@ -59,4 +60,6 @@ public interface NodeConfiguration {
   boolean isRevertReasonEnabled();
 
   List<String> getStaticNodes();
+
+  Map<String, String> getEnvironment();
 }
diff --git a/...ests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/privacy/PrivacyNode.java b/...ests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/privacy/PrivacyNode.java
@@ -127,7 +127,8 @@ public PrivacyNode(
             List.of(),
             Optional.empty(),
             Optional.empty(),
-            besuConfig.isStrictTxReplayProtectionEnabled());
+            besuConfig.isStrictTxReplayProtectionEnabled(),
+            besuConfig.getEnvironment());
   }
 
   public void testEnclaveConnection(final List<PrivacyNode> otherNodes) {

diff --git a/acceptance-tests/tests/build.gradle b/acceptance-tests/tests/build.gradle
@@ -56,9 +56,9 @@ dependencies {
   testImplementation 'io.jaegertracing:jaeger-client'
   testImplementation 'io.jaegertracing:jaeger-proto'
   testImplementation 'io.netty:netty-all'
-  testImplementation 'io.opentelemetry.proto:opentelemetry-proto'
   testImplementation 'io.opentelemetry:opentelemetry-api'
   testImplementation 'io.opentelemetry:opentelemetry-exporter-otlp'
+  testImplementation 'io.opentelemetry.proto:opentelemetry-proto'
   testImplementation 'io.opentelemetry:opentelemetry-sdk'
   testImplementation 'io.opentelemetry:opentelemetry-sdk-trace'
   testImplementation 'io.opentracing.contrib:opentracing-okhttp3'

diff --git a/...ests/src/test/java/org/hyperledger/besu/tests/acceptance/OpenTelemetryAcceptanceTest.java b/...ests/src/test/java/org/hyperledger/besu/tests/acceptance/OpenTelemetryAcceptanceTest.java
@@ -26,7 +26,9 @@
 
 import java.time.Duration;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 import com.google.common.io.Closer;
 import com.google.protobuf.ByteString;
@@ -131,16 +133,24 @@ public void setUp() throws Exception {
     MetricsConfiguration configuration =
         MetricsConfiguration.builder()
             .protocol(MetricsProtocol.OPENTELEMETRY)
-            .enabled(true)
+            .pushEnabled(true)
             .port(0)
             .hostsAllowlist(singletonList("*"))
             .build();
+    Map<String, String> env = new HashMap<>();
+    env.put("OTEL_METRIC_EXPORT_INTERVAL", "1000");
+    env.put("OTEL_TRACES_SAMPLER", "always_on");
+    env.put("OTEL_EXPORTER_OTLP_ENDPOINT", "http://localhost:4317");
+    env.put("OTEL_EXPORTER_OTLP_INSECURE", "true");
+    env.put("OTEL_EXPORTER_OTLP_PROTOCOL", "grpc");
+
     metricsNode =
         besu.create(
             new BesuNodeConfigurationBuilder()
                 .name("metrics-node")
                 .jsonRpcEnabled()
                 .metricsConfiguration(configuration)
+                .environment(env)
                 .build());
     cluster.start(metricsNode);
   }
@@ -170,11 +180,11 @@ public void traceReporting() {
           net.netVersion().verify(metricsNode);
           List<ResourceSpans> spans = fakeTracesCollector.getReceivedSpans();
           assertThat(spans.isEmpty()).isFalse();
-          Span internalSpan = spans.get(0).getInstrumentationLibrarySpans(0).getSpans(0);
+          Span internalSpan = spans.get(0).getScopeSpans(0).getSpans(0);
           assertThat(internalSpan.getKind()).isEqualTo(Span.SpanKind.SPAN_KIND_INTERNAL);
           ByteString parent = internalSpan.getParentSpanId();
           assertThat(parent.isEmpty()).isFalse();
-          Span serverSpan = spans.get(0).getInstrumentationLibrarySpans(0).getSpans(1);
+          Span serverSpan = spans.get(0).getScopeSpans(0).getSpans(1);
           assertThat(serverSpan.getKind()).isEqualTo(Span.SpanKind.SPAN_KIND_SERVER);
           ByteString rootSpanId = serverSpan.getParentSpanId();
           assertThat(rootSpanId.isEmpty()).isTrue();

diff --git a/gradle/versions.gradle b/gradle/versions.gradle
@@ -72,14 +72,16 @@ dependencyManagement {
     dependency group: 'io.netty', name: 'netty-transport-native-kqueue', version:'4.1.74.Final', classifier: 'osx-x86_64'
     dependency 'io.netty:netty-transport-native-unix-common:4.1.74.Final'
 
-    dependency 'io.opentelemetry:opentelemetry-api:1.6.0'
-    dependency 'io.opentelemetry:opentelemetry-exporter-otlp-metrics:1.6.0-alpha'
-    dependency 'io.opentelemetry:opentelemetry-exporter-otlp:1.6.0'
-    dependency 'io.opentelemetry:opentelemetry-extension-trace-propagators:1.6.0'
-    dependency 'io.opentelemetry:opentelemetry-sdk-trace:1.6.0'
-    dependency 'io.opentelemetry:opentelemetry-sdk:1.6.0'
-    dependency 'io.opentelemetry:opentelemetry-semconv:1.6.0-alpha'
-    dependency 'io.opentelemetry.proto:opentelemetry-proto:0.13.0-alpha'
+    dependency 'io.opentelemetry:opentelemetry-api:1.15.0'
+    dependency 'io.opentelemetry:opentelemetry-exporter-otlp-metrics:1.14.0'
+    dependency 'io.opentelemetry:opentelemetry-exporter-otlp:1.15.0'
+    dependency 'io.opentelemetry:opentelemetry-extension-trace-propagators:1.15.0'
+    dependency 'io.opentelemetry.proto:opentelemetry-proto:0.16.0-alpha'
+    dependency 'io.opentelemetry:opentelemetry-sdk-metrics:1.15.0'
+    dependency 'io.opentelemetry:opentelemetry-sdk-trace:1.15.0'
+    dependency 'io.opentelemetry:opentelemetry-sdk:1.15.0'
+    dependency 'io.opentelemetry:opentelemetry-sdk-extension-autoconfigure:1.15.0-alpha'
+    dependency 'io.opentelemetry:opentelemetry-semconv:1.15.0-alpha'
 
     dependency 'io.opentracing.contrib:opentracing-okhttp3:3.0.0'
     dependency 'io.opentracing:opentracing-api:0.33.0'

diff --git a/metrics/core/build.gradle b/metrics/core/build.gradle
@@ -49,9 +49,10 @@ dependencies {
   implementation 'io.opentelemetry:opentelemetry-sdk'
   implementation 'io.opentelemetry:opentelemetry-semconv'
   implementation 'io.opentelemetry:opentelemetry-sdk-trace'
+  implementation 'io.opentelemetry:opentelemetry-sdk-metrics'
   implementation 'io.opentelemetry:opentelemetry-exporter-otlp'
   implementation 'io.opentelemetry:opentelemetry-exporter-otlp-metrics'
-  implementation 'io.opentelemetry.proto:opentelemetry-proto'
+  implementation 'io.opentelemetry:opentelemetry-sdk-extension-autoconfigure'
 
   implementation 'io.prometheus:simpleclient'
   implementation 'io.prometheus:simpleclient_common'

diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsService.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsService.java
@@ -14,8 +14,7 @@
  */
 package org.hyperledger.besu.metrics;
 
-import org.hyperledger.besu.metrics.opentelemetry.MetricsOtelGrpcPushService;
-import org.hyperledger.besu.metrics.opentelemetry.OpenTelemetrySystem;
+import org.hyperledger.besu.metrics.opentelemetry.MetricsOtelPushService;
 import org.hyperledger.besu.metrics.prometheus.MetricsConfiguration;
 import org.hyperledger.besu.metrics.prometheus.MetricsHttpService;
 import org.hyperledger.besu.metrics.prometheus.MetricsPushGatewayService;
@@ -49,8 +48,7 @@ static Optional<MetricsService> create(
       }
     } else if (configuration.getProtocol() == MetricsProtocol.OPENTELEMETRY) {
       if (configuration.isEnabled()) {
-        return Optional.of(
-            new MetricsOtelGrpcPushService(configuration, (OpenTelemetrySystem) metricsSystem));
+        return Optional.of(new MetricsOtelPushService());
       } else {
         return Optional.empty();
       }

diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsSystemFactory.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsSystemFactory.java
@@ -54,7 +54,8 @@ public static ObservableMetricsSystem create(final MetricsConfiguration metricsC
           new OpenTelemetrySystem(
               metricsConfiguration.getMetricCategories(),
               metricsConfiguration.isTimersEnabled(),
-              metricsConfiguration.getPrometheusJob());
+              metricsConfiguration.getPrometheusJob(),
+              true);
       metricsSystem.initDefaults();
       return metricsSystem;
     } else {

diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/opentelemetry/DebugMetricReader.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/opentelemetry/DebugMetricReader.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright Besu Contributors
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.metrics.opentelemetry;
+
+import java.util.Collection;
+
+import io.opentelemetry.sdk.common.CompletableResultCode;
+import io.opentelemetry.sdk.metrics.InstrumentType;
+import io.opentelemetry.sdk.metrics.data.AggregationTemporality;
+import io.opentelemetry.sdk.metrics.data.MetricData;
+import io.opentelemetry.sdk.metrics.export.CollectionRegistration;
+import io.opentelemetry.sdk.metrics.export.MetricReader;
+import io.opentelemetry.sdk.metrics.internal.export.MetricProducer;
+import org.jetbrains.annotations.NotNull;
+
+class DebugMetricReader implements MetricReader {
+  private CollectionRegistration registration;
+
+  public DebugMetricReader() {}
+
+  public Collection<MetricData> getAllMetrics() {
+    return MetricProducer.asMetricProducer(this.registration).collectAllMetrics();
+  }
+
+  @Override
+  public void register(final @NotNull CollectionRegistration registration) {
+    this.registration = registration;
+  }
+
+  @Override
+  public CompletableResultCode forceFlush() {
+    return null;
+  }
+
+  @Override
+  public CompletableResultCode shutdown() {
+    return CompletableResultCode.ofSuccess();
+  }
+
+  @Override
+  public AggregationTemporality getAggregationTemporality(
+      final @NotNull InstrumentType instrumentType) {
+    return null;
+  }
+}