Update hypertrace config (#151)

pavolloffay · web-flow · commit ca167d3d85e0 · 2020-12-02T14:41:47.000+01:00
* Update hypertrace config

Signed-off-by: Pavol Loffay &lt;p.loffay@gmail.com&gt;

* fixes

Signed-off-by: Pavol Loffay &lt;p.loffay@gmail.com&gt;
diff --git a/Makefile b/Makefile
@@ -23,4 +23,4 @@ clean:
 
 .PHONY: init-submodules
 init-submodules:
-	git submodule update --init --recursive
+	git submodule update --init
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ The final artifact is in `javaagent/build/libs/hypertrace-agent-<version>-all.ja
 ## Run & Configure
 
 ```bash
-HT_EXPORTING_ADDRESS=http://localhost:9411/api/v2/spans java -javaagent:javaagent/build/libs/hypertrace-agent-<version>-all.jar -jar app.jar
+HT_EXPORTING_ENDPOINT=http://localhost:9411/api/v2/spans java -javaagent:javaagent/build/libs/hypertrace-agent-<version>-all.jar -jar app.jar
 ```
 
 By default the agent uses Zipkin exporter.
diff --git a/example-config.yaml b/example-config.yaml
@@ -1,3 +1,3 @@
 serviceName: service_name
 reporting:
-  address: http://localhost:9411/api/v2/spans
+  endpoint: http://localhost:9411/api/v2/spans
diff --git a/filter-custom-opa/src/main/java/org/hypertrace/agent/filter/opa/custom/CustomOpaLibProvider.java b/filter-custom-opa/src/main/java/org/hypertrace/agent/filter/opa/custom/CustomOpaLibProvider.java
@@ -41,9 +41,9 @@ public Filter create() {
     AgentConfig agentConfig = HypertraceConfig.get();
     Reporting reporting = agentConfig.getReporting();
     return new CustomOpaLib(
-        reporting.getOpa().getAddress().getValue(),
+        reporting.getOpa().getEndpoint().getValue(),
         reporting.getToken().getValue(),
         reporting.getSecure().getValue(),
-        reporting.getOpa().getPollPeriod().getValue());
+        reporting.getOpa().getPollPeriodSeconds().getValue());
   }
 }
diff --git a/javaagent-core/src/main/java/org/hypertrace/agent/core/EnvironmentConfig.java b/javaagent-core/src/main/java/org/hypertrace/agent/core/EnvironmentConfig.java
@@ -39,12 +39,12 @@ private EnvironmentConfig() {}
   static final String PROPAGATION_FORMATS = HT_PREFIX + "propagation.formats";
 
   private static final String REPORTING_PREFIX = HT_PREFIX + "reporting.";
-  static final String REPORTING_ADDRESS = REPORTING_PREFIX + "address";
+  static final String REPORTING_ENDPOINT = REPORTING_PREFIX + "endpoint";
   static final String REPORTING_SECURE = REPORTING_PREFIX + "secure";
 
   private static final String OPA_PREFIX = REPORTING_PREFIX + "opa.";
-  static final String OPA_ADDRESS = OPA_PREFIX + "address";
-  static final String OPA_POLL_PERIOD = OPA_PREFIX + "poll.period";
+  static final String OPA_ENDPOINT = OPA_PREFIX + "endpoint";
+  static final String OPA_POLL_PERIOD = OPA_PREFIX + "poll.period.seconds";
 
   private static final String CAPTURE_PREFIX = HT_PREFIX + "data.capture.";
   public static final String CAPTURE_HTTP_HEADERS_PREFIX = CAPTURE_PREFIX + "http.headers.";
@@ -79,9 +79,9 @@ private static void applyPropagationFormat(AgentConfig.Builder builder) {
   }
 
   private static Reporting.Builder applyReporting(Reporting.Builder builder) {
-    String reporterAddress = getProperty(REPORTING_ADDRESS);
+    String reporterAddress = getProperty(REPORTING_ENDPOINT);
     if (reporterAddress != null) {
-      builder.setAddress(StringValue.newBuilder().setValue(reporterAddress).build());
+      builder.setEndpoint(StringValue.newBuilder().setValue(reporterAddress).build());
     }
     String secure = getProperty(REPORTING_SECURE);
     if (secure != null) {
@@ -93,13 +93,14 @@ private static Reporting.Builder applyReporting(Reporting.Builder builder) {
   }
 
   private static Opa.Builder applyOpa(Opa.Builder builder) {
-    String address = getProperty(OPA_ADDRESS);
+    String address = getProperty(OPA_ENDPOINT);
     if (address != null) {
-      builder.setAddress(StringValue.newBuilder().setValue(address).build());
+      builder.setEndpoint(StringValue.newBuilder().setValue(address).build());
     }
     String pollPeriod = getProperty(OPA_POLL_PERIOD);
     if (pollPeriod != null) {
-      builder.setPollPeriod(Int32Value.newBuilder().setValue(Integer.parseInt(pollPeriod)).build());
+      builder.setPollPeriodSeconds(
+          Int32Value.newBuilder().setValue(Integer.parseInt(pollPeriod)).build());
     }
     return builder;
   }
diff --git a/javaagent-core/src/main/java/org/hypertrace/agent/core/HypertraceConfig.java b/javaagent-core/src/main/java/org/hypertrace/agent/core/HypertraceConfig.java
@@ -50,8 +50,8 @@ private HypertraceConfig() {}
   private static AgentConfig agentConfig;
 
   static final String DEFAULT_SERVICE_NAME = "unknown";
-  static final String DEFAULT_REPORTING_ADDRESS = "http://localhost:9411/api/v2/spans";
-  static final String DEFAULT_OPA_ADDRESS = "http://opa.traceableai:8181/";
+  static final String DEFAULT_REPORTING_ENDPOINT = "http://localhost:9411/api/v2/spans";
+  static final String DEFAULT_OPA_ENDPOINT = "http://opa.traceableai:8181/";
   static final int DEFAULT_OPA_POLL_PERIOD_SECONDS = 30;
 
   public static AgentConfig get() {
@@ -139,26 +139,26 @@ private static AgentConfig.Builder applyDefaults(AgentConfig.Builder configBuild
     configBuilder.setDataCapture(dataCaptureBuilder);
 
     if (configBuilder.getPropagationFormatsList().isEmpty()) {
-      configBuilder.addPropagationFormats(PropagationFormat.TRACE_CONTEXT);
+      configBuilder.addPropagationFormats(PropagationFormat.TRACECONTEXT);
     }
     return configBuilder;
   }
 
   private static Reporting.Builder applyReportingDefaults(Reporting.Builder builder) {
-    if (!builder.hasAddress()) {
-      builder.setAddress(StringValue.newBuilder().setValue(DEFAULT_REPORTING_ADDRESS).build());
+    if (!builder.hasEndpoint()) {
+      builder.setEndpoint(StringValue.newBuilder().setValue(DEFAULT_REPORTING_ENDPOINT).build());
     }
     Builder opaBuilder = applyOpaDefaults(builder.getOpa().toBuilder());
     builder.setOpa(opaBuilder);
     return builder;
   }
 
   private static Opa.Builder applyOpaDefaults(Opa.Builder builder) {
-    if (!builder.hasAddress()) {
-      builder.setAddress(StringValue.newBuilder().setValue(DEFAULT_OPA_ADDRESS).build());
+    if (!builder.hasEndpoint()) {
+      builder.setEndpoint(StringValue.newBuilder().setValue(DEFAULT_OPA_ENDPOINT).build());
     }
-    if (!builder.hasPollPeriod()) {
-      builder.setPollPeriod(
+    if (!builder.hasPollPeriodSeconds()) {
+      builder.setPollPeriodSeconds(
           Int32Value.newBuilder().setValue(DEFAULT_OPA_POLL_PERIOD_SECONDS).build());
     }
     return builder;
diff --git a/javaagent-core/src/main/proto b/javaagent-core/src/main/proto
@@ -1 +1 @@
-Subproject commit 5d884ee42b5c053ced0063c05039f7f1038b4cd8
+Subproject commit 0011d20fb7eaaf0c0f401e3d5e5f16f09acc9f9c
diff --git a/javaagent-core/src/main/resources/META-INF/services/io.opentelemetry.sdk.resources.ResourceProvider b/javaagent-core/src/main/resources/META-INF/services/io.opentelemetry.sdk.resources.ResourceProvider
diff --git a/javaagent-core/src/test/java/org/hypertrace/agent/core/EnvironmentConfigTest.java b/javaagent-core/src/test/java/org/hypertrace/agent/core/EnvironmentConfigTest.java
@@ -27,34 +27,35 @@
 class EnvironmentConfigTest {
 
   @Test
-  @ClearSystemProperty(key = EnvironmentConfig.REPORTING_ADDRESS)
+  @ClearSystemProperty(key = EnvironmentConfig.REPORTING_ENDPOINT)
   @ClearSystemProperty(key = EnvironmentConfig.REPORTING_SECURE)
-  @ClearSystemProperty(key = EnvironmentConfig.OPA_ADDRESS)
+  @ClearSystemProperty(key = EnvironmentConfig.OPA_ENDPOINT)
   @ClearSystemProperty(key = EnvironmentConfig.OPA_POLL_PERIOD)
   @ClearSystemProperty(key = EnvironmentConfig.PROPAGATION_FORMATS)
   @ClearSystemProperty(key = EnvironmentConfig.CAPTURE_HTTP_BODY_PREFIX + "request")
   public void systemProperties() {
     // when tests are run in parallel the env vars/sys props set it junit-pioneer are visible to
     // parallel tests
-    System.setProperty(EnvironmentConfig.REPORTING_ADDRESS, "http://:-)");
+    System.setProperty(EnvironmentConfig.REPORTING_ENDPOINT, "http://:-)");
     System.setProperty(EnvironmentConfig.REPORTING_SECURE, "true");
     System.setProperty(EnvironmentConfig.CAPTURE_HTTP_BODY_PREFIX + "request", "true");
-    System.setProperty(EnvironmentConfig.OPA_ADDRESS, "http://azkaban:9090");
+    System.setProperty(EnvironmentConfig.OPA_ENDPOINT, "http://azkaban:9090");
     System.setProperty(EnvironmentConfig.OPA_POLL_PERIOD, "10");
-    System.setProperty(EnvironmentConfig.PROPAGATION_FORMATS, "B3,TRACE_CONTEXT");
+    System.setProperty(EnvironmentConfig.PROPAGATION_FORMATS, "B3,TRACECONTEXT");
 
     AgentConfig.Builder configBuilder = AgentConfig.newBuilder();
     configBuilder.setServiceName(StringValue.newBuilder().setValue("foo"));
 
     AgentConfig agentConfig = EnvironmentConfig.applyPropertiesAndEnvVars(configBuilder).build();
     Assertions.assertEquals("foo", agentConfig.getServiceName().getValue());
     Assertions.assertEquals(
-        Arrays.asList(PropagationFormat.B3, PropagationFormat.TRACE_CONTEXT),
+        Arrays.asList(PropagationFormat.B3, PropagationFormat.TRACECONTEXT),
         agentConfig.getPropagationFormatsList());
-    Assertions.assertEquals("http://:-)", agentConfig.getReporting().getAddress().getValue());
+    Assertions.assertEquals("http://:-)", agentConfig.getReporting().getEndpoint().getValue());
     Assertions.assertEquals(
-        "http://azkaban:9090", agentConfig.getReporting().getOpa().getAddress().getValue());
-    Assertions.assertEquals(10, agentConfig.getReporting().getOpa().getPollPeriod().getValue());
+        "http://azkaban:9090", agentConfig.getReporting().getOpa().getEndpoint().getValue());
+    Assertions.assertEquals(
+        10, agentConfig.getReporting().getOpa().getPollPeriodSeconds().getValue());
     Assertions.assertEquals(true, agentConfig.getReporting().getSecure().getValue());
     Assertions.assertEquals(
         true, agentConfig.getDataCapture().getHttpBody().getRequest().getValue());
diff --git a/javaagent-core/src/test/java/org/hypertrace/agent/core/HypertraceConfigTest.java b/javaagent-core/src/test/java/org/hypertrace/agent/core/HypertraceConfigTest.java
@@ -37,17 +37,17 @@ public void defaultValues() throws IOException {
     AgentConfig agentConfig = HypertraceConfig.load(resource.getPath());
     Assertions.assertEquals("unknown", agentConfig.getServiceName().getValue());
     Assertions.assertEquals(
-        HypertraceConfig.DEFAULT_REPORTING_ADDRESS,
-        agentConfig.getReporting().getAddress().getValue());
+        HypertraceConfig.DEFAULT_REPORTING_ENDPOINT,
+        agentConfig.getReporting().getEndpoint().getValue());
     Assertions.assertEquals(
-        Arrays.asList(PropagationFormat.TRACE_CONTEXT), agentConfig.getPropagationFormatsList());
+        Arrays.asList(PropagationFormat.TRACECONTEXT), agentConfig.getPropagationFormatsList());
     Assertions.assertEquals(false, agentConfig.getReporting().getSecure().getValue());
     Assertions.assertEquals(
-        HypertraceConfig.DEFAULT_OPA_ADDRESS,
-        agentConfig.getReporting().getOpa().getAddress().getValue());
+        HypertraceConfig.DEFAULT_OPA_ENDPOINT,
+        agentConfig.getReporting().getOpa().getEndpoint().getValue());
     Assertions.assertEquals(
         HypertraceConfig.DEFAULT_OPA_POLL_PERIOD_SECONDS,
-        agentConfig.getReporting().getOpa().getPollPeriod().getValue());
+        agentConfig.getReporting().getOpa().getPollPeriodSeconds().getValue());
     Assertions.assertEquals(
         true, agentConfig.getDataCapture().getHttpHeaders().getRequest().getValue());
     Assertions.assertEquals(
@@ -93,11 +93,12 @@ private void assertConfig(AgentConfig agentConfig) {
     Assertions.assertEquals(
         Arrays.asList(PropagationFormat.B3), agentConfig.getPropagationFormatsList());
     Assertions.assertEquals(
-        "http://localhost:9411", agentConfig.getReporting().getAddress().getValue());
+        "http://localhost:9411", agentConfig.getReporting().getEndpoint().getValue());
     Assertions.assertEquals(true, agentConfig.getReporting().getSecure().getValue());
     Assertions.assertEquals(
-        "http://opa.localhost:8181/", agentConfig.getReporting().getOpa().getAddress().getValue());
-    Assertions.assertEquals(12, agentConfig.getReporting().getOpa().getPollPeriod().getValue());
+        "http://opa.localhost:8181/", agentConfig.getReporting().getOpa().getEndpoint().getValue());
+    Assertions.assertEquals(
+        12, agentConfig.getReporting().getOpa().getPollPeriodSeconds().getValue());
     Assertions.assertEquals(
         true, agentConfig.getDataCapture().getHttpHeaders().getRequest().getValue());
     Assertions.assertEquals(
@@ -109,14 +110,14 @@ private void assertConfig(AgentConfig agentConfig) {
   }
 
   @Test
-  @ClearSystemProperty(key = EnvironmentConfig.REPORTING_ADDRESS)
+  @ClearSystemProperty(key = EnvironmentConfig.REPORTING_ENDPOINT)
   public void configWithSystemProps() throws IOException {
-    System.setProperty(EnvironmentConfig.REPORTING_ADDRESS, "http://nowhere.here");
+    System.setProperty(EnvironmentConfig.REPORTING_ENDPOINT, "http://nowhere.here");
 
     URL resource = getClass().getClassLoader().getResource("config.yaml");
     AgentConfig agentConfig = HypertraceConfig.load(resource.getPath());
     Assertions.assertEquals(
-        "http://nowhere.here", agentConfig.getReporting().getAddress().getValue());
+        "http://nowhere.here", agentConfig.getReporting().getEndpoint().getValue());
     Assertions.assertEquals("service", agentConfig.getServiceName().getValue());
   }
 }
diff --git a/javaagent-core/src/test/resources/config.yaml b/javaagent-core/src/test/resources/config.yaml
@@ -2,11 +2,11 @@ serviceName: service
 propagationFormats:
   - B3
 reporting:
-  address: http://localhost:9411
+  endpoint: http://localhost:9411
   secure: true
   opa:
-    address: http://opa.localhost:8181/
-    pollPeriod: 12
+    endpoint: http://opa.localhost:8181/
+    pollPeriodSeconds: 12
 dataCapture:
   httpHeaders:
     request: true
diff --git a/javaagent/src/main/java/org/hypertrace/agent/instrument/HypertraceAgent.java b/javaagent/src/main/java/org/hypertrace/agent/instrument/HypertraceAgent.java
@@ -62,15 +62,15 @@ private static void setDefaultConfig() {
     OpenTelemetryConfig.setDefault(
         OTEL_PROPAGATORS, toOtelPropagators(agentConfig.getPropagationFormatsList()));
     OpenTelemetryConfig.setDefault(
-        OTEL_EXPORTER_ZIPKIN_ENDPOINT, agentConfig.getReporting().getAddress().getValue());
+        OTEL_EXPORTER_ZIPKIN_ENDPOINT, agentConfig.getReporting().getEndpoint().getValue());
     OpenTelemetryConfig.setDefault(
         OTEL_EXPORTER_ZIPKIN_SERVICE_NAME, agentConfig.getServiceName().getValue());
   }
 
   @VisibleForTesting
   static String toOtelPropagators(List<PropagationFormat> propagationFormats) {
     return propagationFormats.stream()
-        .map(v -> v.name().toLowerCase().replaceAll("_", ""))
+        .map(v -> v.name().toLowerCase())
         .collect(Collectors.joining(","));
   }
 
diff --git a/javaagent/src/test/java/org/hypertrace/agent/instrument/HypertraceAgentTest.java b/javaagent/src/test/java/org/hypertrace/agent/instrument/HypertraceAgentTest.java
@@ -27,7 +27,7 @@ public class HypertraceAgentTest {
   @Test
   public void propagationFormatList() {
     List<PropagationFormat> formats =
-        Arrays.asList(PropagationFormat.B3, PropagationFormat.TRACE_CONTEXT);
+        Arrays.asList(PropagationFormat.B3, PropagationFormat.TRACECONTEXT);
     Assertions.assertEquals("b3,tracecontext", HypertraceAgent.toOtelPropagators(formats));
   }
 }
diff --git a/smoke-tests/src/test/java/org/hypertrace/agent/smoketest/AbstractSmokeTest.java b/smoke-tests/src/test/java/org/hypertrace/agent/smoketest/AbstractSmokeTest.java
@@ -133,7 +133,7 @@ GenericContainer createAppUnderTest(int jdk) {
         .withEnv("HT_CONFIG_FILE", "/etc/ht-config.yaml")
         .withEnv("OTEL_BSP_MAX_EXPORT_BATCH", "1")
         .withEnv("OTEL_BSP_SCHEDULE_DELAY", "10")
-        .withEnv("HT_REPORTING_ADDRESS", OTEL_EXPORTER_ENDPOINT);
+        .withEnv("HT_REPORTING_ENDPOINT", OTEL_EXPORTER_ENDPOINT);
   }
 
   protected static int countSpansByName(
diff --git a/smoke-tests/src/test/resources/ht-config-all-disabled.yaml b/smoke-tests/src/test/resources/ht-config-all-disabled.yaml
@@ -1,6 +1,6 @@
 serviceName: app_under_test
 reporting:
-  address: http://localhost:9411
+  endpoint: http://localhost:9411
   secure: true
 dataCapture:
   httpHeaders:
diff --git a/smoke-tests/src/test/resources/ht-config.yaml b/smoke-tests/src/test/resources/ht-config.yaml
@@ -1,3 +1,3 @@
 serviceName: app_under_test
 reporting:
-  address: http://localhost:9411
+  endpoint: http://localhost:9411

Original file line number	Diff line number	Diff line change
`@@ -41,9 +41,9 @@ public Filter create() {`
`41`	`41`	`AgentConfig agentConfig = HypertraceConfig.get();`
`42`	`42`	`Reporting reporting = agentConfig.getReporting();`
`43`	`43`	`return new CustomOpaLib(`
`44`		`- reporting.getOpa().getAddress().getValue(),`
	`44`	`+ reporting.getOpa().getEndpoint().getValue(),`
`45`	`45`	`reporting.getToken().getValue(),`
`46`	`46`	`reporting.getSecure().getValue(),`
`47`		`- reporting.getOpa().getPollPeriod().getValue());`
	`47`	`+ reporting.getOpa().getPollPeriodSeconds().getValue());`
`48`	`48`	`}`
`49`	`49`	`}`