force observability with DIGMA_OBSERVABILITY

shalom938 · web-flow · commit a628b86cd02b · 2024-05-13T15:43:50.000+03:00
force observability with DIGMA_OBSERVABILITY #Closes 2144
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/ParametersExtractor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/ParametersExtractor.kt
@@ -66,6 +66,14 @@ open class ParametersExtractor(protected val configuration: RunConfiguration, pr
         return params.env[OTEL_RESOURCE_ATTRIBUTES]?.contains("$DIGMA_ENVIRONMENT_RESOURCE_ATTRIBUTE=") ?: false
     }
 
+
+    fun getDigmaObservability(): DigmaObservabilityType? {
+        return extractEnvValue(DIGMA_OBSERVABILITY)?.takeIf { it.isNotBlank() }?.let {
+            DigmaObservabilityType.valueOf(it)
+        } ?: if (isEnvExists(DIGMA_OBSERVABILITY)) DigmaObservabilityType.app else null
+    }
+
+
     fun extractEnvValue(envKeyName: String): String? {
 
         if (configuration is ExternalSystemRunConfiguration &&
@@ -82,5 +90,15 @@ open class ParametersExtractor(protected val configuration: RunConfiguration, pr
 
     }
 
+    fun isEnvExists(envKeyName: String): Boolean {
+
+        if (configuration is ExternalSystemRunConfiguration) {
+            return configuration.settings.env.containsKey(envKeyName)
+        }
+
+        return params.env.containsKey(envKeyName)
+
+    }
+
 
 }
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/constants.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/constants.kt
@@ -12,6 +12,32 @@ const val OTEL_SERVICE_NAME_PROP_NAME = "otel.service.name"
 
 const val DIGMA_MARKER = "-Dorg.digma.marker=true"
 
+/*
+DIGMA_OBSERVABILITY is an environment variable to forces observability when user executes an unsupported
+ gradle task or maven goal. it should be used only for gradle or maven. it can not force observability for unknown
+ configuration types because we don't know how to treat unknown configuration types. gradle and maven configuration
+ types are known to us, we just don't support all possible gradle task names or maven goals.
+there can be two values for DIGMA_OBSERVABILITY, app or test. when app, the observability will be treated as regular application,
+ when test, the observability will be treated as test and is mainly used to add digma.environment LOCAL or LOCAL_TESTS.
+when exists and value is empty it will be treated as app.
+to force a different instrumentation flavor add INSTRUMENTATION_FLAVOR environment variable with value one of
+ org.digma.intellij.plugin.idea.execution.flavor.InstrumentationFlavorType.
+examples:
+if running a task called myTask that we don't support:
+DIGMA_OBSERVABILITY or DIGMA_OBSERVABILITY=app -> will be treated as regular application with the default flavor.
+DIGMA_OBSERVABILITY=test -> will be treated as a test execution with the default flavor.
+
+together with
+DIGMA_OBSERVABILITY=test
+INSTRUMENTATION_FLAVOR=Quarkus
+will be treated as Quarkus flavor and a test execution.
+
+don't add DIGMA_OBSERVABILITY if it's not necessary, it may confuse the instrumentation flavor.
+
+*/
+const val DIGMA_OBSERVABILITY = "DIGMA_OBSERVABILITY"
+
+enum class DigmaObservabilityType { app, test }
 
 val KNOWN_IRRELEVANT_TASKS = setOf(
     /*
@@ -146,4 +172,4 @@ val KNOWN_IRRELEVANT_TASKS = setOf(
     "runIde",
     "setupDependencies"
 
-    )
+)
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/BaseInstrumentationFlavor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/BaseInstrumentationFlavor.kt
@@ -52,6 +52,7 @@ abstract class BaseInstrumentationFlavor : InstrumentationFlavor {
 
     open fun isTest(
         instrumentationService: RunConfigurationInstrumentationService,
+        parametersExtractor: ParametersExtractor,
         configuration: RunConfiguration,
         params: SimpleProgramParameters
     ): Boolean {
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/DefaultInstrumentationFlavor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/DefaultInstrumentationFlavor.kt
@@ -7,6 +7,7 @@ import com.intellij.execution.configurations.SimpleProgramParameters
 import org.digma.intellij.plugin.buildsystem.BuildSystem
 import org.digma.intellij.plugin.errorreporting.ErrorReporter
 import org.digma.intellij.plugin.execution.RunConfigurationInstrumentationService
+import org.digma.intellij.plugin.idea.execution.DigmaObservabilityType
 import org.digma.intellij.plugin.idea.execution.JavaToolOptionsBuilder
 import org.digma.intellij.plugin.idea.execution.ModuleResolver
 import org.digma.intellij.plugin.idea.execution.OtelResourceAttributesBuilder
@@ -114,7 +115,7 @@ open class DefaultInstrumentationFlavor : BaseInstrumentationFlavor() {
 
         return try {
 
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             javaToolOptionsBuilder
                 .withOtelAgent(useOtelAgent())
@@ -142,7 +143,7 @@ open class DefaultInstrumentationFlavor : BaseInstrumentationFlavor() {
     ): Map<String, String> {
 
         return try {
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             otelResourceAttributesBuilder
                 .withCommonResourceAttributes(isTest, parametersExtractor)
@@ -157,13 +158,24 @@ open class DefaultInstrumentationFlavor : BaseInstrumentationFlavor() {
 
     override fun isTest(
         instrumentationService: RunConfigurationInstrumentationService,
+        parametersExtractor: ParametersExtractor,
         configuration: RunConfiguration,
         params: SimpleProgramParameters
     ): Boolean {
+        //maybe DIGMA_OBSERVABILITY exists , it can force test if we don't support the running task
+        // for gradle or maven
+        val digmaObservability = parametersExtractor.getDigmaObservability()
         val buildSystem = instrumentationService.getBuildSystem(configuration)
         return when (buildSystem) {
-            BuildSystem.GRADLE -> hasSupportedGradleTasks(instrumentationService.getTaskNames(configuration), SUPPORTED_GRADLE_TEST_TASKS)
-            BuildSystem.MAVEN -> hasSupportedMavenGoals(instrumentationService.getTaskNames(configuration), SUPPORTED_MAVEN_TEST_GOALS)
+            BuildSystem.GRADLE -> {
+                hasSupportedGradleTasks(instrumentationService.getTaskNames(configuration), SUPPORTED_GRADLE_TEST_TASKS)
+                        || digmaObservability == DigmaObservabilityType.test
+            }
+
+            BuildSystem.MAVEN -> {
+                hasSupportedMavenGoals(instrumentationService.getTaskNames(configuration), SUPPORTED_MAVEN_TEST_GOALS)
+                        || digmaObservability == DigmaObservabilityType.test
+            }
             BuildSystem.INTELLIJ -> configuration is JavaTestConfigurationBase
         }
     }
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/InstrumentationFlavor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/InstrumentationFlavor.kt
@@ -62,6 +62,12 @@ interface InstrumentationFlavor {
             }
         }
 
+        @Throws(NoSuchElementException::class)
+        fun getByType(type: InstrumentationFlavorType): InstrumentationFlavor {
+            return instrumentationFlavors.first {
+                it.getFlavor() == type
+            }
+        }
 
         private fun getFlavorInEnv(parametersExtractor: ParametersExtractor): InstrumentationFlavorType? {
             return try {
@@ -73,6 +79,8 @@ interface InstrumentationFlavor {
                 null
             }
         }
+
+
     }
 
 
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/JavaServerInstrumentationFlavor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/JavaServerInstrumentationFlavor.kt
@@ -35,6 +35,7 @@ class JavaServerInstrumentationFlavor : DefaultInstrumentationFlavor() {
 
     override fun isTest(
         instrumentationService: RunConfigurationInstrumentationService,
+        parametersExtractor: ParametersExtractor,
         configuration: RunConfiguration,
         params: SimpleProgramParameters
     ): Boolean {
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/MicronautInstrumentationFlavor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/MicronautInstrumentationFlavor.kt
@@ -8,6 +8,7 @@ import com.intellij.openapi.module.Module
 import org.digma.intellij.plugin.buildsystem.BuildSystem
 import org.digma.intellij.plugin.errorreporting.ErrorReporter
 import org.digma.intellij.plugin.execution.RunConfigurationInstrumentationService
+import org.digma.intellij.plugin.idea.execution.DigmaObservabilityType
 import org.digma.intellij.plugin.idea.execution.JavaToolOptionsBuilder
 import org.digma.intellij.plugin.idea.execution.ModuleResolver
 import org.digma.intellij.plugin.idea.execution.OtelResourceAttributesBuilder
@@ -105,7 +106,7 @@ class MicronautInstrumentationFlavor : BaseInstrumentationFlavor() {
     ): String? {
         return try {
 
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             javaToolOptionsBuilder
                 .withMicronautTracing(true)
@@ -134,7 +135,7 @@ class MicronautInstrumentationFlavor : BaseInstrumentationFlavor() {
     ): Map<String, String> {
 
         return try {
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             otelResourceAttributesBuilder
                 .withCommonResourceAttributes(isTest, parametersExtractor)
@@ -154,13 +155,24 @@ class MicronautInstrumentationFlavor : BaseInstrumentationFlavor() {
 
     override fun isTest(
         instrumentationService: RunConfigurationInstrumentationService,
+        parametersExtractor: ParametersExtractor,
         configuration: RunConfiguration,
         params: SimpleProgramParameters
     ): Boolean {
+        //maybe DIGMA_OBSERVABILITY exists , it can force test if we don't support the running task
+        // for gradle or maven
+        val digmaObservability = parametersExtractor.getDigmaObservability()
         val buildSystem = instrumentationService.getBuildSystem(configuration)
         return when (buildSystem) {
-            BuildSystem.GRADLE -> hasSupportedGradleTasks(instrumentationService.getTaskNames(configuration), SUPPORTED_GRADLE_TEST_TASKS)
-            BuildSystem.MAVEN -> hasSupportedMavenGoals(instrumentationService.getTaskNames(configuration), SUPPORTED_MAVEN_TEST_GOALS)
+            BuildSystem.GRADLE -> {
+                hasSupportedGradleTasks(instrumentationService.getTaskNames(configuration), SUPPORTED_GRADLE_TEST_TASKS)
+                        || digmaObservability == DigmaObservabilityType.test
+            }
+
+            BuildSystem.MAVEN -> {
+                hasSupportedMavenGoals(instrumentationService.getTaskNames(configuration), SUPPORTED_MAVEN_TEST_GOALS)
+                        || digmaObservability == DigmaObservabilityType.test
+            }
             BuildSystem.INTELLIJ -> configuration is JavaTestConfigurationBase
         }
     }
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/OpenLibertyInstrumentationFlavor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/OpenLibertyInstrumentationFlavor.kt
@@ -6,6 +6,7 @@ import com.intellij.execution.configurations.SimpleProgramParameters
 import org.digma.intellij.plugin.buildsystem.BuildSystem
 import org.digma.intellij.plugin.errorreporting.ErrorReporter
 import org.digma.intellij.plugin.execution.RunConfigurationInstrumentationService
+import org.digma.intellij.plugin.idea.execution.DigmaObservabilityType
 import org.digma.intellij.plugin.idea.execution.JavaToolOptionsBuilder
 import org.digma.intellij.plugin.idea.execution.ModuleResolver
 import org.digma.intellij.plugin.idea.execution.OtelResourceAttributesBuilder
@@ -84,7 +85,7 @@ class OpenLibertyInstrumentationFlavor : BaseInstrumentationFlavor() {
     ): String? {
         return try {
 
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             javaToolOptionsBuilder
                 .withOtelSdkDisabledEqualsFalse()
@@ -113,7 +114,7 @@ class OpenLibertyInstrumentationFlavor : BaseInstrumentationFlavor() {
     ): Map<String, String> {
 
         return try {
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             otelResourceAttributesBuilder
                 .withCommonResourceAttributes(isTest, parametersExtractor)
@@ -128,13 +129,24 @@ class OpenLibertyInstrumentationFlavor : BaseInstrumentationFlavor() {
 
     override fun isTest(
         instrumentationService: RunConfigurationInstrumentationService,
+        parametersExtractor: ParametersExtractor,
         configuration: RunConfiguration,
         params: SimpleProgramParameters
     ): Boolean {
+        //maybe DIGMA_OBSERVABILITY exists , it can force test if we don't support the running task
+        // for gradle or maven
+        val digmaObservability = parametersExtractor.getDigmaObservability()
         val buildSystem = instrumentationService.getBuildSystem(configuration)
         return when (buildSystem) {
-            BuildSystem.GRADLE -> hasSupportedGradleTasks(instrumentationService.getTaskNames(configuration), SUPPORTED_GRADLE_TEST_TASKS)
-            BuildSystem.MAVEN -> hasSupportedMavenGoals(instrumentationService.getTaskNames(configuration), SUPPORTED_MAVEN_TEST_GOALS)
+            BuildSystem.GRADLE -> {
+                hasSupportedGradleTasks(instrumentationService.getTaskNames(configuration), SUPPORTED_GRADLE_TEST_TASKS)
+                        || digmaObservability == DigmaObservabilityType.test
+            }
+
+            BuildSystem.MAVEN -> {
+                hasSupportedMavenGoals(instrumentationService.getTaskNames(configuration), SUPPORTED_MAVEN_TEST_GOALS)
+                        || digmaObservability == DigmaObservabilityType.test
+            }
             BuildSystem.INTELLIJ -> false
         }
     }
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/QuarkusInstrumentationFlavor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/QuarkusInstrumentationFlavor.kt
@@ -8,6 +8,7 @@ import com.intellij.openapi.module.Module
 import org.digma.intellij.plugin.buildsystem.BuildSystem
 import org.digma.intellij.plugin.errorreporting.ErrorReporter
 import org.digma.intellij.plugin.execution.RunConfigurationInstrumentationService
+import org.digma.intellij.plugin.idea.execution.DigmaObservabilityType
 import org.digma.intellij.plugin.idea.execution.JavaToolOptionsBuilder
 import org.digma.intellij.plugin.idea.execution.ModuleResolver
 import org.digma.intellij.plugin.idea.execution.OtelResourceAttributesBuilder
@@ -107,7 +108,7 @@ class QuarkusInstrumentationFlavor : BaseInstrumentationFlavor() {
     ): String? {
         return try {
 
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             javaToolOptionsBuilder
                 .withQuarkusOtelExportedTracesEndpoint()
@@ -155,13 +156,24 @@ class QuarkusInstrumentationFlavor : BaseInstrumentationFlavor() {
 
     override fun isTest(
         instrumentationService: RunConfigurationInstrumentationService,
+        parametersExtractor: ParametersExtractor,
         configuration: RunConfiguration,
         params: SimpleProgramParameters
     ): Boolean {
+        //maybe DIGMA_OBSERVABILITY exists , it can force test if we don't support the running task
+        // for gradle or maven
+        val digmaObservability = parametersExtractor.getDigmaObservability()
         val buildSystem = instrumentationService.getBuildSystem(configuration)
         return when (buildSystem) {
-            BuildSystem.GRADLE -> hasSupportedGradleTasks(instrumentationService.getTaskNames(configuration), SUPPORTED_GRADLE_TEST_TASKS)
-            BuildSystem.MAVEN -> hasSupportedMavenGoals(instrumentationService.getTaskNames(configuration), SUPPORTED_MAVEN_TEST_GOALS)
+            BuildSystem.GRADLE -> {
+                hasSupportedGradleTasks(instrumentationService.getTaskNames(configuration), SUPPORTED_GRADLE_TEST_TASKS)
+                        || digmaObservability == DigmaObservabilityType.test
+            }
+
+            BuildSystem.MAVEN -> {
+                hasSupportedMavenGoals(instrumentationService.getTaskNames(configuration), SUPPORTED_MAVEN_TEST_GOALS)
+                        || digmaObservability == DigmaObservabilityType.test
+            }
             BuildSystem.INTELLIJ -> configuration is JavaTestConfigurationBase
         }
     }
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/SpringBootMicrometerInstrumentationFlavor.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/flavor/SpringBootMicrometerInstrumentationFlavor.kt
@@ -94,7 +94,7 @@ class SpringBootMicrometerInstrumentationFlavor : DefaultInstrumentationFlavor()
     ): String? {
         return try {
 
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             javaToolOptionsBuilder
                 .withCommonSpringBootWithMicrometerTracing(true)
@@ -124,7 +124,7 @@ class SpringBootMicrometerInstrumentationFlavor : DefaultInstrumentationFlavor()
     ): Map<String, String> {
 
         return try {
-            val isTest = isTest(instrumentationService, configuration, params)
+            val isTest = isTest(instrumentationService, parametersExtractor, configuration, params)
 
             if (needToAddDigmaEnvironmentAttribute(parametersExtractor)) {
                 if (isTest) {
diff --git a/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/services/BaseJvmRunConfigurationInstrumentationService.kt b/jvm-common/src/main/kotlin/org/digma/intellij/plugin/idea/execution/services/BaseJvmRunConfigurationInstrumentationService.kt
@@ -19,6 +19,7 @@ import org.digma.intellij.plugin.idea.execution.ParametersExtractor
 import org.digma.intellij.plugin.idea.execution.ProjectHeuristics
 import org.digma.intellij.plugin.idea.execution.ServiceNameProvider
 import org.digma.intellij.plugin.idea.execution.flavor.InstrumentationFlavor
+import org.digma.intellij.plugin.idea.execution.flavor.InstrumentationFlavorType
 
 /**
  * base class that covers most of the configuration types.
@@ -39,7 +40,7 @@ abstract class BaseJvmRunConfigurationInstrumentationService : RunConfigurationI
         val otelResourceAttributesBuilder = getOtelResourceAttributesBuilder(configuration, params, runnerSettings)
 
 
-        val instrumentationFlavor: InstrumentationFlavor? =
+        var instrumentationFlavor: InstrumentationFlavor? =
             InstrumentationFlavor.get(
                 this,
                 configuration,
@@ -50,8 +51,27 @@ abstract class BaseJvmRunConfigurationInstrumentationService : RunConfigurationI
                 parametersExtractor
             )
 
+
         if (instrumentationFlavor == null) {
-            return null
+
+            //if no instrumentationFlavor was selected then maybe it's a gradle or maven task that we don't support.
+            //if it's not gradle or maven return null. otherwise check if DIGMA_OBSERVABILITY exists to force observability.
+            val buildSystem = getBuildSystem(configuration)
+            if (buildSystem != BuildSystem.GRADLE && buildSystem != BuildSystem.MAVEN) {
+                return null
+            }
+
+            //check is DIGMA_OBSERVABILITY exists else return null.
+            //DIGMA_OBSERVABILITY is also used to decide if to force app or test in the various flavors.
+            parametersExtractor.getDigmaObservability()
+                ?: return null
+
+            //if DIGMA_OBSERVABILITY exists force observability with InstrumentationFlavorType.Default.
+            //no need to check if INSTRUMENTATION_FLAVOR exists, if it existed InstrumentationFlavor.get would return something.
+            //InstrumentationFlavor.getByType must return something, or we have a bug. it will throw an exception
+            // if not. the exception will be caught and reported.
+            instrumentationFlavor = InstrumentationFlavor.getByType(InstrumentationFlavorType.Default)
+
         }
 
 
@@ -69,8 +89,16 @@ abstract class BaseJvmRunConfigurationInstrumentationService : RunConfigurationI
             )
 
             javaToolOptions = javaToolOptions?.let {
-                //easier for us to see which flavor
-                " -Ddigma.flavor=${instrumentationFlavor.getFlavor()} ".plus(it)
+                //easier for us to see which flavor was selected
+                var newValue = " -Ddigma.flavor=${instrumentationFlavor.getFlavor()} ".plus(it)
+
+                //and if DIGMA_OBSERVABILITY was configured
+                if (parametersExtractor.getDigmaObservability() != null) {
+                    newValue = " -Ddigma.observability=${parametersExtractor.getDigmaObservability()} $newValue"
+                }
+
+                newValue
+
             }
 
             val otelResourceAttributes = instrumentationFlavor.buildOtelResourceAttributes(

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,12 @@ interface InstrumentationFlavor {`
`62`	`62`	`}`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ @Throws(NoSuchElementException::class)`
	`66`	`+ fun getByType(type: InstrumentationFlavorType): InstrumentationFlavor {`
	`67`	`+ return instrumentationFlavors.first {`
	`68`	`+ it.getFlavor() == type`
	`69`	`+ }`
	`70`	`+ }`
`65`	`71`
`66`	`72`	`private fun getFlavorInEnv(parametersExtractor: ParametersExtractor): InstrumentationFlavorType? {`
`67`	`73`	`return try {`
`@@ -73,6 +79,8 @@ interface InstrumentationFlavor {`
`73`	`79`	`null`
`74`	`80`	`}`
`75`	`81`	`}`
	`82`	`+`
	`83`	`+`
`76`	`84`	`}`
`77`	`85`
`78`	`86`