Merge branch 'master' of github.com:elastic/apm-agent-java into user-agent-spec

Author: SylvainJuge

CHANGELOG.asciidoc

@@ -38,6 +38,7 @@ exclude known static files in all applications might be changed to `/app/static/
 ===== Features
 * Improved capturing of logged exceptions when using Log4j2 - {pull}2139[#2139]
 * Update to async-profiler 1.8.7 and set configured `safemode` at load time though a new system property - {pull}2165[#2165]
+* Added support to capture `context.message.routing-key` in rabbitmq, spring amqp instrumentations - {pull}1767[#1767]
 
 [float]
 ===== Performance improvements
@@ -47,6 +48,7 @@ exclude known static files in all applications might be changed to `/app/static/
 ===== Bug fixes
 * Fix k8s metadata discovery for containerd-cri envs - {pull}2126[#2126]
 * Fixing/reducing startup delays related to `ensureInstrumented` - {pull}2150[#2150]
+* Fix runtime attach when bytebuddy is in application classpath - {pull}2116[#2116]
 
 [float]
 ===== Refactorings

apm-agent-attach-cli/pom.xml

@@ -160,6 +160,11 @@
  must be loaded through a dedicated class loader
  -->
  <exclude>co/elastic/apm/attach/bouncycastle/BouncyCastleVerifier.class</exclude>
+ <!--
+ Eliminating exposure to the log4j2 vulnerability related to the SMTP appender -
+ https://nvd.nist.gov/vuln/detail/CVE-2020-9488#vulnCurrentDescriptionTitle
+ -->
+ <exclude>org/apache/logging/log4j/core/appender/SmtpAppender.class</exclude>
  </excludes>
  </filter>
  </filters>
@@ -199,15 +204,10 @@
  must be loaded through a dedicated class loader
  -->
  <exclude>co/elastic/apm/attach/bouncycastle/BouncyCastleVerifier.class</exclude>
- </excludes>
- </filter>
- <filter>
- <artifact>org.apache.logging.log4j:log4j-core</artifact>
- <!--
- Eliminating exposure to the log4j2 vulnerability related to the SMTP appender -
- https://nvd.nist.gov/vuln/detail/CVE-2020-9488#vulnCurrentDescriptionTitle
- -->
- <excludes>
+ <!--
+ Eliminating exposure to the log4j2 vulnerability related to the SMTP appender -
+ https://nvd.nist.gov/vuln/detail/CVE-2020-9488#vulnCurrentDescriptionTitle
+ -->
  <exclude>org/apache/logging/log4j/core/appender/SmtpAppender.class</exclude>
  </excludes>
  </filter>

apm-agent-attach-cli/src/main/java/co/elastic/apm/attach/GetAgentProperties.java

@@ -18,17 +18,14 @@
  */
 package co.elastic.apm.attach;
 
-import net.bytebuddy.agent.ByteBuddyAgent;
-import net.bytebuddy.agent.VirtualMachine;
+import co.elastic.apm.attach.UserRegistry.CommandOutput;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.StringReader;
 import java.util.Arrays;
 import java.util.Properties;
 
-import co.elastic.apm.attach.UserRegistry.CommandOutput;
-
 public class GetAgentProperties {
 
  /**
@@ -46,11 +43,11 @@ public class GetAgentProperties {
  * @throws Exception
  */
  public static void main(String[] args) throws Exception {
- getAgentAndSystemPropertiesCurrentUser(args[0]).store(System.out, null);
+ JvmAttachUtils.getAgentAndSystemProperties(args[0]).store(System.out, null);
  }
 
  /**
- * Attaches to the VM with the given pid and gets the {@link VirtualMachine#getAgentProperties()} and {@link VirtualMachine#getSystemProperties()}.
+ * Attaches to the VM with the given pid and gets the agent and system properties.
  *
  * @param pid The pid of the target VM, If it is current VM, this method will fork a VM for self-attachment.
  * @param user The user that runs the target VM. If this is not the current user, this method will fork a VM that runs under this user.
@@ -59,13 +56,13 @@ public static void main(String[] args) throws Exception {
  */
  public static Properties getAgentAndSystemProperties(String pid, UserRegistry.User user) throws Exception {
  if (user.isCurrentUser() && !JvmInfo.CURRENT_PID.equals(pid)) {
- return getAgentAndSystemPropertiesCurrentUser(pid);
+ return JvmAttachUtils.getAgentAndSystemProperties(pid);
  } else {
  return getAgentAndSystemPropertiesSwitchUser(pid, user);
  }
  }
 
- static Properties getAgentAndSystemPropertiesSwitchUser(String pid, UserRegistry.User user) throws IOException, InterruptedException {
+ static Properties getAgentAndSystemPropertiesSwitchUser(String pid, UserRegistry.User user) throws IOException {
  CommandOutput output = user.executeAsUserWithCurrentClassPath(GetAgentProperties.class, Arrays.asList(pid, user.getUsername()));
  if (output.getExitCode() == 0) {
  Properties properties = new Properties();
@@ -76,27 +73,4 @@ static Properties getAgentAndSystemPropertiesSwitchUser(String pid, UserRegistry
  }
  }
 
- static Properties getAgentAndSystemPropertiesCurrentUser(String pid) {
- ByteBuddyAgent.AttachmentProvider.Accessor accessor = ElasticAttachmentProvider.get().attempt();
- if (!accessor.isAvailable()) {
- throw new IllegalStateException("No compatible attachment provider is available");
- }
-
- try {
- Class<?> vm = accessor.getVirtualMachineType();
- Object virtualMachineInstance = vm
- .getMethod("attach", String.class)
- .invoke(null, pid);
- try {
- Properties agentProperties = (Properties) vm.getMethod("getAgentProperties").invoke(virtualMachineInstance);
- Properties systemProperties = (Properties) vm.getMethod("getSystemProperties").invoke(virtualMachineInstance);
- systemProperties.putAll(agentProperties);
- return systemProperties;
- } finally {
- vm.getMethod("detach").invoke(virtualMachineInstance);
- }
- } catch (Exception exception) {
- throw new IllegalStateException("Error during attachment using: " + accessor, exception);
- }
- }
 }

apm-agent-attach-cli/src/main/java/co/elastic/apm/attach/JvmInfo.java

@@ -18,13 +18,11 @@
  */
 package co.elastic.apm.attach;
 
-import net.bytebuddy.agent.ByteBuddyAgent;
-
 import java.util.Locale;
 import java.util.Properties;
 
 class JvmInfo {
- public static final String CURRENT_PID = ByteBuddyAgent.ProcessProvider.ForCurrentVm.INSTANCE.resolve();
+ public static final String CURRENT_PID = JvmAttachUtils.CURRENT_PID;
 
  private final String pid;
  private final String userName;

apm-agent-attach/pom.xml

@@ -32,7 +32,6 @@
  <dependency>
  <groupId>net.bytebuddy</groupId>
  <artifactId>byte-buddy-agent</artifactId>
- <version>${version.byte-buddy}</version>
  </dependency>
  <dependency>
  <groupId>net.java.dev.jna</groupId>
@@ -111,6 +110,52 @@
  </execution>
  </executions>
  </plugin>
+ <plugin>
+ <artifactId>maven-shade-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>shade-dependencies</id>
+ <phase>package</phase>
+ <goals>
+ <goal>shade</goal>
+ </goals>
+ <configuration>
+ <keepDependenciesWithProvidedScope>true</keepDependenciesWithProvidedScope>
+ <createSourcesJar>true</createSourcesJar>
+ <shadeSourcesContent>true</shadeSourcesContent>
+ <shadedArtifactId>${project.artifactId}</shadedArtifactId>
+ <filters>
+ <filter>
+ <artifact>net.bytebuddy:*</artifact>
+ <excludes>
+ <exclude>META-INF/MANIFEST.MF</exclude>
+ <exclude>META-INF/NOTICE</exclude>
+ </excludes>
+ </filter>
+ </filters>
+ <artifactSet>
+ <excludes>
+ <exclude>net.java.dev.jna:*</exclude>
+ </excludes>
+ </artifactSet>
+ <relocations>
+ <relocation>
+ <pattern>net.bytebuddy</pattern>
+ <shadedPattern>co.elastic.apm.attach.bytebuddy</shadedPattern>
+ </relocation>
+ </relocations>
+ <transformers>
+ <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer" />
+ <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer" />
+ <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
+ <resource>META-INF/LICENSE</resource>
+ <file>${apm-agent-parent.base.dir}/LICENSE</file>
+ </transformer>
+ </transformers>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
  </plugins>
  </build>
 

apm-agent-attach/src/main/java/co/elastic/apm/attach/JvmAttachUtils.java

@@ -0,0 +1,56 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+package co.elastic.apm.attach;
+
+import net.bytebuddy.agent.ByteBuddyAgent;
+
+import java.util.Properties;
+
+/**
+ * Allows convenient access to current JVM utilities provided by bytebuddy which is relocated on packaging.
+ */
+public class JvmAttachUtils {
+
+ public static final String CURRENT_PID = ByteBuddyAgent.ProcessProvider.ForCurrentVm.INSTANCE.resolve();
+
+ public static Properties getAgentAndSystemProperties(String pid) {
+ ByteBuddyAgent.AttachmentProvider.Accessor accessor = ElasticAttachmentProvider.get().attempt();
+ if (!accessor.isAvailable()) {
+ throw new IllegalStateException("No compatible attachment provider is available");
+ }
+
+ try {
+ Class<?> vm = accessor.getVirtualMachineType();
+ Object virtualMachineInstance = vm
+ .getMethod("attach", String.class)
+ .invoke(null, pid);
+ try {
+ Properties agentProperties = (Properties) vm.getMethod("getAgentProperties").invoke(virtualMachineInstance);
+ Properties systemProperties = (Properties) vm.getMethod("getSystemProperties").invoke(virtualMachineInstance);
+ systemProperties.putAll(agentProperties);
+ return systemProperties;
+ } finally {
+ vm.getMethod("detach").invoke(virtualMachineInstance);
+ }
+ } catch (Exception e) {
+ throw new IllegalStateException("Error during attachment using: " + accessor, e);
+ }
+ }
+
+}

apm-agent-benchmarks/pom.xml

@@ -122,7 +122,6 @@
  <dependency>
  <groupId>net.bytebuddy</groupId>
  <artifactId>byte-buddy-agent</artifactId>
- <version>${version.byte-buddy}</version>
  </dependency>
  <dependency>
  <groupId>org.agrona</groupId>

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

@@ -63,7 +63,8 @@ public void init(ElasticApmTracer tracer) {
 
  void logConfiguration(ConfigurationRegistry configurationRegistry, Logger logger) {
  final String serviceName = configurationRegistry.getConfig(CoreConfiguration.class).getServiceName();
- logger.info("Starting Elastic APM {} as {} on {}", elasticApmVersion, serviceName, getJvmAndOsVersionString());
+ final String serviceVersion = configurationRegistry.getConfig(CoreConfiguration.class).getServiceVersion();
+ logger.info("Starting Elastic APM {} as {} ({}) on {}", elasticApmVersion, serviceName, serviceVersion, getJvmAndOsVersionString());
  logger.debug("VM Arguments: {}", ManagementFactory.getRuntimeMXBean().getInputArguments());
  for (List<ConfigurationOption<?>> options : configurationRegistry.getConfigurationOptionsByCategory().values()) {
  for (ConfigurationOption<?> option : options) {

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

@@ -51,6 +51,9 @@ public void recycle(StringBuilder object) {
  @Nullable
  private StringBuilder body;
 
+ @Nullable
+ private String routingKey;
+
  /**
  * Represents the message age in milliseconds. Since 0 is a valid value (can occur due to clock skews between
  * sender and receiver) - a negative value represents invalid or unavailable age.
@@ -72,6 +75,16 @@ public Message withQueue(String queueName) {
  return this;
  }
 
+ public Message withRoutingKey(String routingKey) {
+ this.routingKey = routingKey;
+ return this;
+ }
+
+ @Nullable
+ public String getRoutingKey() {
+ return routingKey;
+ }
+
  /**
  * Gets a body StringBuilder to write content to. If this message's body is not initializes, this method will
  * initialize from the StringBuilder pool.
@@ -149,6 +162,7 @@ public void resetState() {
  stringBuilderPool.recycle(body);
  body = null;
  }
+ routingKey = null;
  }
 
  public void copyFrom(Message other) {
@@ -159,5 +173,6 @@ public void copyFrom(Message other) {
  }
  this.headers.copyFrom(other.getHeaders());
  this.age = other.getAge();
+ this.routingKey = other.getRoutingKey();
  }
 }

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

@@ -902,7 +902,9 @@ private void serializeMessageContext(final Message message) {
  jw.writeByte(OBJECT_END);
  jw.writeByte(COMMA);
  }
-
+ if (message.getRoutingKey() != null && !message.getRoutingKey().isEmpty()) {
+ writeField("routing_key", message.getRoutingKey());
+ }
  writeFieldName("queue");
  jw.writeByte(OBJECT_START);
  writeLastField("name", message.getQueueName());