Auto-detect service name from web.xml display-name #886

laurit · 2022-08-23T10:13:23Z

No description provided.

laurit · 2022-08-26T10:08:52Z

custom/src/main/java/com/splunk/opentelemetry/SplunkConfiguration.java

+      if (ServiceNameDetector.serviceNameNotConfigured(config)) {
+        String serviceName = ServiceNameDetector.detectServiceName();
+        if (serviceName != null) {
+          log.info("Auto-detected service name '{}'.", serviceName);


should we also log some kind of description (path to the web.xml?) based on what we auto-detected?

If it's not too much trouble, then why not -- it'd make our lives easier. I'd log it at debug though, some customers are kinda sensitive to the amount of logs printed by the agent.

custom/src/main/java/com/splunk/opentelemetry/servicename/LibertyServiceNameDetector.java

laurit · 2022-08-26T10:19:30Z

custom/src/main/java/com/splunk/opentelemetry/servicename/TomeeServiceNameDetector.java

+
+  @Override
+  Path getDeploymentDir() throws URISyntaxException {
+    Path rootDir = getRootDir();


our test uses webapps directory so this isn't tested

custom/src/main/java/com/splunk/opentelemetry/servicename/WebSphereServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/WildflyServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/JettyServiceNameDetector.java

mateuszrzeszutek

This is awesome 👍
Even if it's only a fraction of all possible ways to deploy servlet apps, I think it's more than enough to get us started with this -- all other cases would be covered on demand (or not at all, if they're too insane)

custom/src/main/java/com/splunk/opentelemetry/SplunkConfiguration.java

custom/src/main/java/com/splunk/opentelemetry/servicename/ServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/AppServerServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/TomeeServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/LibertyServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/WebSphereServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/AppServerServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/WebSphereServiceNameDetector.java

custom/src/main/java/com/splunk/opentelemetry/servicename/AppServerServiceNameDetector.java

smoke-tests/src/test/java/com/splunk/opentelemetry/SmokeTest.java

smoke-tests/src/test/java/com/splunk/opentelemetry/WebSphereSmokeTest.java

custom/src/main/java/com/splunk/opentelemetry/servicename/JettyServiceNameDetector.java

breedx-splk · 2022-08-29T23:15:48Z

custom/src/test/java/com/splunk/opentelemetry/servicename/AppServerServiceNameDetectorTest.java

+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+public class AppServerServiceNameDetectorTest {


I don't think this is really a unit test because it does so much with the environment and tests across detectors. Feels like an integration test to me. Is there a better home for this?

It does not test across detectors. It only test logic in the base detector class.

breedx-splk

Agree with others that this is fantastic! I would have loved to see it broken up into more bite sized PRs for reviewing, but great anyway. 👍🏻

mateuszrzeszutek

Looks great! 👍

custom/src/main/java/com/splunk/opentelemetry/servicename/ServiceNameResourceProvider.java

Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>

…iceNameResourceProvider.java Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>

laurit marked this pull request as ready for review August 24, 2022 09:32

laurit requested review from a team as code owners August 24, 2022 09:32

theletterf approved these changes Aug 24, 2022

View reviewed changes

laurit commented Aug 26, 2022

View reviewed changes

custom/src/main/java/com/splunk/opentelemetry/servicename/LibertyServiceNameDetector.java Show resolved Hide resolved

laurit commented Aug 26, 2022

View reviewed changes

custom/src/main/java/com/splunk/opentelemetry/servicename/WebSphereServiceNameDetector.java Outdated Show resolved Hide resolved

laurit commented Aug 26, 2022

View reviewed changes

custom/src/main/java/com/splunk/opentelemetry/servicename/WildflyServiceNameDetector.java Show resolved Hide resolved

laurit commented Aug 26, 2022

View reviewed changes

custom/src/main/java/com/splunk/opentelemetry/servicename/JettyServiceNameDetector.java Show resolved Hide resolved

mateuszrzeszutek reviewed Aug 26, 2022

View reviewed changes

mateuszrzeszutek reviewed Aug 29, 2022

View reviewed changes