-
Notifications
You must be signed in to change notification settings - Fork 320
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Defines a syntax for matching methods which should be traced closes #347
- Loading branch information
1 parent
035ba3a
commit f1611f9
Showing
15 changed files
with
758 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
123 changes: 123 additions & 0 deletions
123
apm-agent-core/src/main/java/co/elastic/apm/agent/bci/methodmatching/MethodMatcher.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /*- | ||
| * #%L | ||
| * Elastic APM Java agent | ||
| * %% | ||
| * Copyright (C) 2018 Elastic and 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. | ||
| * #L% | ||
| */ | ||
| package co.elastic.apm.agent.bci.methodmatching; | ||
|
|
||
| import co.elastic.apm.agent.matcher.WildcardMatcher; | ||
| import org.stagemonitor.util.StringUtils; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| import java.lang.reflect.Modifier; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import static co.elastic.apm.agent.matcher.WildcardMatcher.caseSensitiveMatcher; | ||
|
|
||
| public class MethodMatcher { | ||
|
|
||
| private static final String MODIFIER = "(public|private|protected|\\*)"; | ||
| private static final String CLASS_NAME = "([a-zA-Z\\d_$.\\*]+)"; | ||
| private static final String METHOD_NAME = "([a-zA-Z\\d_$\\*]+)"; | ||
| private static final String PARAM = "([a-zA-Z\\d_$.\\[\\]\\*]+)"; | ||
| private static final String PARAMS = PARAM + "(,\\s*" + PARAM + ")*"; | ||
| private static final Pattern METHOD_MATCHER_PATTERN = Pattern.compile("^(" + MODIFIER + "\\s+)?" + CLASS_NAME + "#" + METHOD_NAME + "(\\((" + PARAMS + ")*\\))?$"); | ||
|
|
||
| private final String stringRepresentation; | ||
| @Nullable | ||
| private final Integer modifier; | ||
| private final WildcardMatcher classMatcher; | ||
| private final WildcardMatcher methodMatcher; | ||
| @Nullable | ||
| private final List<WildcardMatcher> argumentMatchers; | ||
|
|
||
| private MethodMatcher(String stringRepresentation, @Nullable Integer modifier, WildcardMatcher classMatcher, WildcardMatcher methodMatcher, @Nullable List<WildcardMatcher> argumentMatchers) { | ||
| this.stringRepresentation = stringRepresentation; | ||
| this.modifier = modifier; | ||
| this.classMatcher = classMatcher; | ||
| this.methodMatcher = methodMatcher; | ||
| this.argumentMatchers = argumentMatchers; | ||
| } | ||
|
|
||
| public static MethodMatcher of(String methodMatcher) { | ||
| final Matcher matcher = METHOD_MATCHER_PATTERN.matcher(methodMatcher); | ||
| if (!matcher.matches()) { | ||
| throw new IllegalArgumentException("'" + methodMatcher + "'" + " is not a valid method matcher"); | ||
| } | ||
|
|
||
| return new MethodMatcher(methodMatcher, getModifier(matcher.group(2)), caseSensitiveMatcher(matcher.group(3)), caseSensitiveMatcher(matcher.group(4)), | ||
| getArgumentMatchers(matcher.group(5))); | ||
| } | ||
|
|
||
| @Nullable | ||
| private static Integer getModifier(@Nullable String modifier) { | ||
| if (modifier == null) { | ||
| return null; | ||
| } | ||
| switch (modifier) { | ||
| case "public": | ||
| return Modifier.PUBLIC; | ||
| case "private": | ||
| return Modifier.PRIVATE; | ||
| case "protected": | ||
| return Modifier.PROTECTED; | ||
| default: | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| @Nullable | ||
| private static List<WildcardMatcher> getArgumentMatchers(@Nullable String arguments) { | ||
| if (arguments == null) { | ||
| return null; | ||
| } | ||
| // remove parenthesis | ||
| arguments = arguments.substring(1, arguments.length() - 1); | ||
| final String[] splitArguments = StringUtils.split(arguments, ','); | ||
| List<WildcardMatcher> matchers = new ArrayList<>(splitArguments.length); | ||
| for (String argument : splitArguments) { | ||
| matchers.add(caseSensitiveMatcher(argument.trim())); | ||
| } | ||
| return matchers; | ||
| } | ||
|
|
||
| public WildcardMatcher getClassMatcher() { | ||
| return classMatcher; | ||
| } | ||
|
|
||
| @Nullable | ||
| public Integer getModifier() { | ||
| return modifier; | ||
| } | ||
|
|
||
| public WildcardMatcher getMethodMatcher() { | ||
| return methodMatcher; | ||
| } | ||
|
|
||
| @Nullable | ||
| public List<WildcardMatcher> getArgumentMatchers() { | ||
| return argumentMatchers; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return stringRepresentation; | ||
| } | ||
| } |
114 changes: 114 additions & 0 deletions
114
...ore/src/main/java/co/elastic/apm/agent/bci/methodmatching/TraceMethodInstrumentation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| /*- | ||
| * #%L | ||
| * Elastic APM Java agent | ||
| * %% | ||
| * Copyright (C) 2018 Elastic and 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. | ||
| * #L% | ||
| */ | ||
| package co.elastic.apm.agent.bci.methodmatching; | ||
|
|
||
| import co.elastic.apm.agent.bci.ElasticApmInstrumentation; | ||
| import co.elastic.apm.agent.bci.bytebuddy.SimpleMethodSignatureOffsetMappingFactory; | ||
| import co.elastic.apm.agent.impl.transaction.AbstractSpan; | ||
| import co.elastic.apm.agent.matcher.WildcardMatcher; | ||
| import net.bytebuddy.asm.Advice; | ||
| import net.bytebuddy.description.method.MethodDescription; | ||
| import net.bytebuddy.description.type.TypeDescription; | ||
| import net.bytebuddy.matcher.ElementMatcher; | ||
| import net.bytebuddy.matcher.ElementMatchers; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| import java.lang.reflect.Modifier; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
||
| import static co.elastic.apm.agent.bci.bytebuddy.CustomElementMatchers.matches; | ||
| import static net.bytebuddy.matcher.ElementMatchers.declaresMethod; | ||
| import static net.bytebuddy.matcher.ElementMatchers.takesArgument; | ||
| import static net.bytebuddy.matcher.ElementMatchers.takesArguments; | ||
|
|
||
| public class TraceMethodInstrumentation extends ElasticApmInstrumentation { | ||
|
|
||
| protected final MethodMatcher methodMatcher; | ||
|
|
||
| public TraceMethodInstrumentation(MethodMatcher methodMatcher) { | ||
| this.methodMatcher = methodMatcher; | ||
| } | ||
|
|
||
| @Advice.OnMethodEnter(suppress = Throwable.class) | ||
| public static void onMethodEnter(@SimpleMethodSignatureOffsetMappingFactory.SimpleMethodSignature String signature, | ||
| @Advice.Local("span") AbstractSpan<?> span) { | ||
| if (tracer != null) { | ||
| final AbstractSpan<?> parent = tracer.activeSpan(); | ||
| if (parent == null) { | ||
| span = tracer.startTransaction() | ||
| .withName(signature) | ||
| .activate(); | ||
| } else { | ||
| span = parent.createSpan() | ||
| .withName(signature) | ||
| .activate(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Advice.OnMethodExit(suppress = Throwable.class, onThrowable = Throwable.class) | ||
| public static void onMethodExit(@Nullable @Advice.Local("span") AbstractSpan<?> span, | ||
| @Advice.Thrown Throwable t) { | ||
| if (span != null) { | ||
| span.captureException(t) | ||
| .deactivate() | ||
| .end(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public ElementMatcher<? super TypeDescription> getTypeMatcher() { | ||
| return matches(methodMatcher.getClassMatcher()) | ||
| .and(declaresMethod(matches(methodMatcher.getMethodMatcher()))); | ||
| } | ||
|
|
||
| @Override | ||
| public ElementMatcher<? super MethodDescription> getMethodMatcher() { | ||
| ElementMatcher.Junction<? super MethodDescription> matcher = matches(methodMatcher.getMethodMatcher()); | ||
| if (methodMatcher.getModifier() != null) { | ||
| switch (methodMatcher.getModifier()) { | ||
| case Modifier.PUBLIC: | ||
| matcher = matcher.and(ElementMatchers.isPublic()); | ||
| break; | ||
| case Modifier.PROTECTED: | ||
| matcher = matcher.and(ElementMatchers.isProtected()); | ||
| break; | ||
| case Modifier.PRIVATE: | ||
| matcher = matcher.and(ElementMatchers.isPrivate()); | ||
| break; | ||
| } | ||
| } | ||
| if (methodMatcher.getArgumentMatchers() != null) { | ||
| matcher = matcher.and(takesArguments(methodMatcher.getArgumentMatchers().size())); | ||
| List<WildcardMatcher> argumentMatchers = methodMatcher.getArgumentMatchers(); | ||
| for (int i = 0; i < argumentMatchers.size(); i++) { | ||
| matcher = matcher.and(takesArgument(i, matches(argumentMatchers.get(i)))); | ||
| } | ||
| } | ||
| return matcher; | ||
| } | ||
|
|
||
| @Override | ||
| public Collection<String> getInstrumentationGroupNames() { | ||
| return Collections.singletonList("method-matching"); | ||
| } | ||
| } |
42 changes: 42 additions & 0 deletions
42
...va/co/elastic/apm/agent/bci/methodmatching/configuration/MethodMatcherValueConverter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /*- | ||
| * #%L | ||
| * Elastic APM Java agent | ||
| * %% | ||
| * Copyright (C) 2018 Elastic and 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. | ||
| * #L% | ||
| */ | ||
| package co.elastic.apm.agent.bci.methodmatching.configuration; | ||
|
|
||
| import co.elastic.apm.agent.bci.methodmatching.MethodMatcher; | ||
| import org.stagemonitor.configuration.converter.ValueConverter; | ||
|
|
||
| public enum MethodMatcherValueConverter implements ValueConverter<MethodMatcher> { | ||
| INSTANCE; | ||
|
|
||
| @Override | ||
| public MethodMatcher convert(String methodMatcher) throws IllegalArgumentException { | ||
| return MethodMatcher.of(methodMatcher); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString(MethodMatcher methodMatcher) { | ||
| return methodMatcher.toString(); | ||
| } | ||
|
|
||
| @Override | ||
| public String toSafeString(MethodMatcher value) { | ||
| return toString(value); | ||
| } | ||
| } |
23 changes: 23 additions & 0 deletions
23
...ore/src/main/java/co/elastic/apm/agent/bci/methodmatching/configuration/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /*- | ||
| * #%L | ||
| * Elastic APM Java agent | ||
| * %% | ||
| * Copyright (C) 2018 Elastic and 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. | ||
| * #L% | ||
| */ | ||
| @NonnullApi | ||
| package co.elastic.apm.agent.bci.methodmatching.configuration; | ||
|
|
||
| import co.elastic.apm.agent.annotation.NonnullApi; |
Oops, something went wrong.