Implement user-agent spec (#2177)

* implement spec + test * annotate some nullable configuration items * prevent NPE:wq * fix other NPEs + cleanup * fix copyright * update changelog * post review changes

Author: SylvainJuge

CHANGELOG.asciidoc

@@ -60,6 +60,7 @@ exclude known static files in all applications might be changed to `/app/static/
 * Switching last instrumentations (`trace_methods`, sparkjava, JDK `HttpServer` and Struts 2) to
 `TracerAwareInstrumentation` - {pull}#2170[#2170]
 * Replace concurrency plugin maps to `SpanConcurrentHashMap` ones - {pull}#2173[#2173]
+* Align User-Agent HTTP header with other APM agents - {pull}#2177[#2177]
 
 [[release-notes-1.x]]
 === Java Agent version 1.x

apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/CoreConfiguration.java

@@ -656,14 +656,17 @@ public long getDelayTracerStartMs() {
  return delayTracerStart.get().getMillis();
  }
 
+ @Nullable
  public String getServiceVersion() {
  return serviceVersion.get();
  }
 
+ @Nullable
  public String getHostname() {
  return hostname.get();
  }
 
+ @Nullable
  public String getEnvironment() {
  return environment.get();
  }

apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/StartupInfo.java

@@ -44,12 +44,7 @@ public class StartupInfo extends AbstractLifecycleListener {
  private final String elasticApmVersion;
 
  public StartupInfo() {
- final String version = VersionUtils.getAgentVersion();
- if (version != null) {
- elasticApmVersion = version;
- } else {
- elasticApmVersion = "(unknown version)";
- }
+ elasticApmVersion = VersionUtils.getAgentVersion();
  }
 
  private static String getJvmAndOsVersionString() {

apm-agent-core/src/main/java/co/elastic/apm/agent/impl/ElasticApmTracerBuilder.java

@@ -142,7 +142,7 @@ private ElasticApmTracer build(boolean startTracer) {
  lifecycleListeners.add(scheduleReloadAtRate(configurationRegistry, 30, TimeUnit.SECONDS));
  }
 
- ApmServerClient apmServerClient = new ApmServerClient(configurationRegistry.getConfig(ReporterConfiguration.class));
+ ApmServerClient apmServerClient = new ApmServerClient(configurationRegistry.getConfig(ReporterConfiguration.class), configurationRegistry.getConfig(CoreConfiguration.class));
  Future<MetaData> metaData = MetaData.create(configurationRegistry, ephemeralId);
  if (addApmServerConfigSource) {
  // adding remote configuration source last will make it highest priority

apm-agent-core/src/main/java/co/elastic/apm/agent/impl/payload/Service.java

@@ -149,7 +149,7 @@ public String getEnvironment() {
  /**
  * Environment name of the service, e.g. "production" or "staging"
  */
- public Service withEnvironment(String environment) {
+ public Service withEnvironment(@Nullable String environment) {
  this.environment = environment;
  return this;
  }
@@ -181,7 +181,7 @@ public String getVersion() {
  /**
  * Version of the service emitting this event
  */
- public Service withVersion(String version) {
+ public Service withVersion(@Nullable String version) {
  this.version = version;
  return this;
  }

apm-agent-core/src/main/java/co/elastic/apm/agent/impl/payload/ServiceFactory.java

@@ -28,17 +28,10 @@ public Service createService(CoreConfiguration coreConfiguration, String ephemer
  .withName(coreConfiguration.getServiceName())
  .withVersion(coreConfiguration.getServiceVersion())
  .withEnvironment(coreConfiguration.getEnvironment())
- .withAgent(new Agent("java", getAgentVersion(), ephemeralId))
+ .withAgent(new Agent("java", VersionUtils.getAgentVersion(), ephemeralId))
  .withRuntime(new RuntimeInfo("Java", System.getProperty("java.version")))
  .withLanguage(new Language("Java", System.getProperty("java.version")))
  .withNode(new Node(coreConfiguration.getServiceNodeName()));
  }
 
- private String getAgentVersion() {
- String version = VersionUtils.getAgentVersion();
- if (version == null) {
- return "unknown";
- }
- return version;
- }
 }

apm-agent-core/src/main/java/co/elastic/apm/agent/report/ApmServerClient.java

@@ -18,6 +18,7 @@
  */
 package co.elastic.apm.agent.report;
 
+import co.elastic.apm.agent.configuration.CoreConfiguration;
 import co.elastic.apm.agent.report.ssl.SslUtils;
 import co.elastic.apm.agent.util.UrlConnectionUtils;
 import co.elastic.apm.agent.util.Version;
@@ -65,7 +66,6 @@
 public class ApmServerClient {
 
  private static final Logger logger = LoggerFactory.getLogger(ApmServerClient.class);
- private static final String USER_AGENT = "elasticapm-java/" + VersionUtils.getAgentVersion();
  private static final Version VERSION_6_7 = Version.of("6.7.0");
  private static final Version VERSION_7_9 = Version.of("7.9.0");
  private static final Version VERSION_7_0 = Version.of("7.0.0");
@@ -77,9 +77,12 @@ public class ApmServerClient {
  private final AtomicInteger errorCount = new AtomicInteger();
  private final ApmServerHealthChecker healthChecker;
 
- public ApmServerClient(ReporterConfiguration reporterConfiguration) {
+ private final String userAgent;
+
+ public ApmServerClient(ReporterConfiguration reporterConfiguration, CoreConfiguration coreConfiguration) {
  this.reporterConfiguration = reporterConfiguration;
  this.healthChecker = new ApmServerHealthChecker(this);
+ this.userAgent = getUserAgent(coreConfiguration);
  }
 
  public void start() {
@@ -159,7 +162,7 @@ private HttpURLConnection startRequestToUrl(URL url) throws IOException {
  connection.setRequestProperty("Authorization", authHeaderValue);
  }
 
- connection.setRequestProperty("User-Agent", USER_AGENT);
+ connection.setRequestProperty("User-Agent", userAgent);
  connection.setConnectTimeout((int) reporterConfiguration.getServerTimeout().getMillis());
  connection.setReadTimeout((int) reporterConfiguration.getServerTimeout().getMillis());
  return (HttpURLConnection) connection;
@@ -320,7 +323,7 @@ public boolean supportsLogsEndpoint() {
  return isAtLeast(VERSION_7_9);
  }
 
- public boolean supportsNumericUrlPort(){
+ public boolean supportsNumericUrlPort() {
  return isAtLeast(VERSION_7_0);
  }
 
@@ -357,7 +360,7 @@ public interface ConnectionHandler<T> {
  /**
  * Gets the {@link HttpURLConnection} after the connection has been established and returns a result,
  * for example the status code or the response body.
- *
+ * <p>
  * NOTE: do not call {@link InputStream#close()} as that is handled by {@link ApmServerClient}
  *
  * @param connection the connection
@@ -368,4 +371,18 @@ public interface ConnectionHandler<T> {
  T withConnection(HttpURLConnection connection) throws IOException;
  }
 
+ private static String getUserAgent(CoreConfiguration coreConfiguration) {
+ StringBuilder userAgent = new StringBuilder();
+ userAgent.append("apm-agent-java/").append(VersionUtils.getAgentVersion());
+ String serviceName = coreConfiguration.getServiceName();
+ String serviceVersion = coreConfiguration.getServiceVersion();
+ if (!serviceName.isEmpty()) {
+ userAgent.append(" (").append(serviceName);
+ if (serviceVersion != null && !serviceVersion.isEmpty()) {
+ userAgent.append(" ").append(serviceVersion);
+ }
+ userAgent.append(")");
+ }
+ return userAgent.toString();
+ }
 }

apm-agent-core/src/main/java/co/elastic/apm/agent/util/VersionUtils.java

@@ -51,9 +51,8 @@ public final class VersionUtils {
  private VersionUtils() {
  }
 
- @Nullable
  public static String getAgentVersion() {
- return AGENT_VERSION;
+ return AGENT_VERSION != null ? AGENT_VERSION : "unknown";
  }
 
  @Nullable

apm-agent-core/src/test/java/co/elastic/apm/agent/configuration/ApmServerConfigurationSourceTest.java

@@ -74,7 +74,7 @@ public void setUp() throws Exception {
  mockApmServer.stubFor(get(urlEqualTo("/")).willReturn(okForJson(Map.of("version", "7.0.0"))));
  mockApmServer.stubFor(post(urlEqualTo("/config/v1/agents")).willReturn(okForJson(Map.of("foo", "bar")).withHeader("ETag", "foo")));
  mockApmServer.stubFor(post(urlEqualTo("/config/v1/agents")).withHeader("If-None-Match", equalTo("foo")).willReturn(status(304)));
- apmServerClient = new ApmServerClient(config.getConfig(ReporterConfiguration.class));
+ apmServerClient = new ApmServerClient(config.getConfig(ReporterConfiguration.class), config.getConfig(CoreConfiguration.class));
  apmServerClient.start(List.of(new URL("http", "localhost", mockApmServer.port(), "/")));
  mockLogger = mock(Logger.class);
  configurationSource = new ApmServerConfigurationSource(

apm-agent-core/src/test/java/co/elastic/apm/agent/report/ApmServerClientProxySupportTest.java

@@ -18,6 +18,7 @@
  */
 package co.elastic.apm.agent.report;
 
+import co.elastic.apm.agent.configuration.CoreConfiguration;
 import co.elastic.apm.agent.configuration.SpyConfiguration;
 import io.undertow.Undertow;
 import io.undertow.io.Sender;
@@ -27,6 +28,7 @@
 import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.stagemonitor.configuration.ConfigurationRegistry;
 import org.testcontainers.Testcontainers;
 import org.testcontainers.containers.BindMode;
 import org.testcontainers.containers.GenericContainer;
@@ -212,10 +214,11 @@ private void setSystemProxyCredentialProperties() {
  }
 
  private static ApmServerClient createAndStartClient(boolean useProxy) {
- ReporterConfiguration config = SpyConfiguration.createSpyConfig().getConfig(ReporterConfiguration.class);
+ ConfigurationRegistry spyConfig = SpyConfiguration.createSpyConfig();
+ ReporterConfiguration config = spyConfig.getConfig(ReporterConfiguration.class);
 
  doReturn(Collections.singletonList(useProxy ? proxyUrl : directUrl)).when(config).getServerUrls();
- ApmServerClient client = new ApmServerClient(config);
+ ApmServerClient client = new ApmServerClient(config, spyConfig.getConfig(CoreConfiguration.class));
  client.start();
  return client;
  }