Add bootstrap check for disabling agent when required (#2951)

Author: eyalkoren

CHANGELOG.asciidoc

@@ -33,6 +33,7 @@ endif::[]
 [float]
 ===== Features
 * Add experimental log sending from the agent with `log_sending` - {pull}2694[#2694]
+* Add bootstrap checks that enable <<jvm-filtering>> on startup - {pull}2951[#2951]
 
 [float]
 ===== Bug fixes

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

@@ -19,6 +19,7 @@
 package co.elastic.apm.attach;
 
 import co.elastic.apm.agent.common.util.ResourceExtractionUtil;
+import co.elastic.apm.agent.common.util.SystemStandardOutputLogger;
 import net.bytebuddy.agent.ByteBuddyAgent;
 
 import javax.annotation.Nullable;
@@ -83,7 +84,7 @@ private static Map<String, String> loadPropertiesFromClasspath(String properties
  }
  }
  } catch (IOException e) {
- e.printStackTrace();
+ SystemStandardOutputLogger.printStackTrace(e);
  }
  return propertyMap;
  }
@@ -124,7 +125,7 @@ static File createTempProperties(Map<String, String> configuration, @Nullable Fi
  properties.store(outputStream, null);
  }
  } catch (IOException e) {
- e.printStackTrace();
+ SystemStandardOutputLogger.printStackTrace(e);
  }
  }
  return tempFile;
@@ -170,11 +171,11 @@ private static void attachWithFallback(File agentJarFile, String pid, String age
  ByteBuddyAgent.attach(agentJarFile, pid, agentArgs, ElasticAttachmentProvider.getFallback());
  } catch (RuntimeException e2) {
  // output the two exceptions for debugging
- System.err.println("Unable to attach with fallback provider:");
- e2.printStackTrace();
+ SystemStandardOutputLogger.stdErrInfo("Unable to attach with fallback provider:");
+ SystemStandardOutputLogger.printStackTrace(e2);
 
- System.err.println("Unable to attach with regular provider:");
- e1.printStackTrace();
+ SystemStandardOutputLogger.stdErrInfo("Unable to attach with regular provider:");
+ SystemStandardOutputLogger.printStackTrace(e1);
  }
  }
  }

apm-agent-common/src/main/java/co/elastic/apm/agent/common/JvmRuntimeInfo.java

@@ -18,6 +18,8 @@
  */
 package co.elastic.apm.agent.common;
 
+import co.elastic.apm.agent.common.util.SystemStandardOutputLogger;
+
 import javax.annotation.Nullable;
 
 public class JvmRuntimeInfo {
@@ -111,7 +113,7 @@ private int getUpdateVersion(String version) {
  }
 
  if (updateVersion < 0) {
- System.err.println("[elastic-apm-agent] WARN Unsupported format of the java.version system property - " + version);
+ SystemStandardOutputLogger.stdErrWarn("Unsupported format of the java.version system property - " + version);
  }
  return updateVersion;
  }

apm-agent-common/src/main/java/co/elastic/apm/agent/common/util/StringUtils.java

@@ -0,0 +1,79 @@
+/*
+ * 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.agent.common.util;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class StringUtils {
+
+ /**
+ * Copied from https://github.com/apache/commons-lang/blob/master/src/main/java/org/apache/commons/lang3/StringUtils.java
+ *
+ * <p>Splits the provided text into an array, separator specified.
+ * This is an alternative to using StringTokenizer.</p>
+ *
+ * <p>The separator is not included in the returned String array.
+ * Adjacent separators are treated as one separator.
+ * For more control over the split use the StrTokenizer class.</p>
+ *
+ * <p>A {@code null} input String returns {@code null}.</p>
+ *
+ * <pre>
+ * StringUtils.split(null, *) = null
+ * StringUtils.split("", *) = []
+ * StringUtils.split("a.b.c", '.') = ["a", "b", "c"]
+ * StringUtils.split("a..b.c", '.') = ["a", "b", "c"]
+ * StringUtils.split("a:b:c", '.') = ["a:b:c"]
+ * StringUtils.split("a b c", ' ') = ["a", "b", "c"]
+ * </pre>
+ *
+ * @param str the String to parse, may be null
+ * @param separatorChar the character used as the delimiter
+ * @return an array of parsed Strings, {@code null} if null String input
+ */
+ public static String[] split(final String str, final char separatorChar) {
+ if (str == null) {
+ return null;
+ }
+ final int len = str.length();
+ if (len == 0) {
+ return new String[0];
+ }
+ final List<String> list = new ArrayList<String>();
+ int i = 0, start = 0;
+ boolean match = false;
+ while (i < len) {
+ if (str.charAt(i) == separatorChar) {
+ if (match) {
+ list.add(str.substring(start, i));
+ match = false;
+ }
+ start = ++i;
+ continue;
+ }
+ match = true;
+ i++;
+ }
+ if (match) {
+ list.add(str.substring(start, i));
+ }
+ return list.toArray(new String[list.size()]);
+ }
+}

apm-agent-common/src/main/java/co/elastic/apm/agent/common/util/SystemStandardOutputLogger.java

@@ -0,0 +1,99 @@
+/*
+ * 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.agent.common.util;
+
+import java.security.AccessController;
+import java.security.PrivilegedAction;
+
+/**
+ * A utility for writing to System standard output and standard error output streams.
+ * Prints can be disabled through the {@code elastic.apm.system_output_disabled} system property or the corresponding
+ * {@code ELASTIC_APM_SYSTEM_OUTPUT_DISABLED} environment variable.
+ */
+public class SystemStandardOutputLogger {
+ private static final String DISABLED_SYSTEM_PROPERTY = "elastic.apm.system_output_disabled";
+ private static final String DISABLED_ENV_VARIABLE = "ELASTIC_APM_SYSTEM_OUTPUT_DISABLED";
+
+ private static final String LINE_PREFIX = "[elastic-apm-agent]";
+
+ private static final boolean disabled;
+
+ static {
+ if (System.getSecurityManager() == null) {
+ disabled = isDisabledThroughConfiguration();
+ } else {
+ disabled = AccessController.doPrivileged(new PrivilegedAction<Boolean>() {
+ @Override
+ public Boolean run() {
+ return isDisabledThroughConfiguration();
+ }
+ });
+ }
+ }
+
+ public static boolean isDisabled() {
+ return disabled;
+ }
+
+ private static boolean isDisabledThroughConfiguration() {
+ return System.getProperty(DISABLED_SYSTEM_PROPERTY) != null || System.getenv(DISABLED_ENV_VARIABLE) != null;
+ }
+
+ public static void printStackTrace(Throwable throwable) {
+ if (!disabled) {
+ throwable.printStackTrace();
+ }
+ }
+
+ private static void printToStdOut(String level, String message) {
+ if (!disabled) {
+ System.out.printf("%s %s %s%n", LINE_PREFIX, level, message);
+ }
+ }
+
+ private static void printToStdErr(String level, String message) {
+ if (!disabled) {
+ System.err.printf("%s %s %s%n", LINE_PREFIX, level, message);
+ }
+ }
+
+ public static void stdOutInfo(String message) {
+ printToStdOut("INFO", message);
+ }
+
+ public static void stdOutWarn(String message) {
+ printToStdOut("WARN", message);
+ }
+
+ public static void stdOutError(String message) {
+ printToStdOut("ERROR", message);
+ }
+
+ public static void stdErrInfo(String message) {
+ printToStdErr("INFO", message);
+ }
+
+ public static void stdErrWarn(String message) {
+ printToStdErr("WARN", message);
+ }
+
+ public static void stdErrError(String message) {
+ printToStdErr("ERROR", message);
+ }
+}

apm-agent-core/src/main/java/co/elastic/apm/agent/matcher/WildcardMatcher.java renamed to apm-agent-common/src/main/java/co/elastic/apm/agent/common/util/WildcardMatcher.java

@@ -16,9 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package co.elastic.apm.agent.matcher;
-
-import org.stagemonitor.util.StringUtils;
+package co.elastic.apm.agent.common.util;
 
 import javax.annotation.Nullable;
 import java.util.ArrayList;
@@ -46,7 +44,7 @@
 
 /**
  * This matcher is used in for example to disable tracing for certain URLs.
- * The advantage of this class compared to alternatives is is that {@linkplain #matches(CharSequence) matching} strings is completely allocation free.
+ * The advantage of this class compared to alternatives is that {@linkplain #matches(CharSequence) matching} strings is completely allocation free.
  * <p>
  * The wildcard matcher supports the {@code *} wildcard which matches zero or more characters.
  * By default, matches are a case insensitive.

apm-agent-core/src/main/java/co/elastic/apm/agent/bci/ElasticApmAgent.java

@@ -31,6 +31,7 @@
 import co.elastic.apm.agent.bci.bytebuddy.SimpleMethodSignatureOffsetMappingFactory;
 import co.elastic.apm.agent.bci.classloading.ExternalPluginClassLoader;
 import co.elastic.apm.agent.common.ThreadUtils;
+import co.elastic.apm.agent.common.util.SystemStandardOutputLogger;
 import co.elastic.apm.agent.configuration.CoreConfiguration;
 import co.elastic.apm.agent.impl.ElasticApmTracer;
 import co.elastic.apm.agent.impl.ElasticApmTracerBuilder;
@@ -243,7 +244,7 @@ private static synchronized void initInstrumentation(final ElasticApmTracer trac
  }
  System.setProperty("net.bytebuddy.dump", bytecodeDumpDir.getPath());
  } catch (Exception e) {
- System.err.println("[elastic-apm-agent] WARN Failed to create directory to dump instrumented bytecode: " + e.getMessage());
+ SystemStandardOutputLogger.stdErrWarn("Failed to create directory to dump instrumented bytecode: " + e.getMessage());
  }
  }
  }

apm-agent-core/src/main/java/co/elastic/apm/agent/bci/bytebuddy/CustomElementMatchers.java

@@ -19,7 +19,7 @@
 package co.elastic.apm.agent.bci.bytebuddy;
 
 import co.elastic.apm.agent.matcher.AnnotationMatcher;
-import co.elastic.apm.agent.matcher.WildcardMatcher;
+import co.elastic.apm.agent.common.util.WildcardMatcher;
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakConcurrent;
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakMap;
 import co.elastic.apm.agent.util.ClassLoaderUtils;

apm-agent-core/src/main/java/co/elastic/apm/agent/collections/NullCheck.java

@@ -18,6 +18,7 @@
  */
 package co.elastic.apm.agent.collections;
 
+import co.elastic.apm.agent.common.util.SystemStandardOutputLogger;
 import co.elastic.apm.agent.sdk.logging.Logger;
 import co.elastic.apm.agent.sdk.logging.LoggerFactory;
 
@@ -32,8 +33,8 @@ public class NullCheck {
  try {
  logger = LoggerFactory.getLogger(NullCheck.class);
  } catch (Throwable throwable) {
- System.err.println("[elastic-apm-agent] WARN Failed to initialize logger for the NullCheck class: " + throwable.getMessage());
- throwable.printStackTrace();
+ SystemStandardOutputLogger.stdErrWarn("Failed to initialize logger for the NullCheck class: " + throwable.getMessage());
+ SystemStandardOutputLogger.printStackTrace(throwable);
  }
  }
 

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

@@ -27,7 +27,7 @@
 import co.elastic.apm.agent.impl.transaction.Span;
 import co.elastic.apm.agent.matcher.MethodMatcher;
 import co.elastic.apm.agent.matcher.MethodMatcherValueConverter;
-import co.elastic.apm.agent.matcher.WildcardMatcher;
+import co.elastic.apm.agent.common.util.WildcardMatcher;
 import co.elastic.apm.agent.matcher.WildcardMatcherValueConverter;
 import co.elastic.apm.agent.sdk.logging.Logger;
 import co.elastic.apm.agent.sdk.logging.LoggerFactory;