Add additional metrics for checking sam version (#3808)

* added additional metrics

* feedback changes

* fixed detekt

Author: manodnyab

gradle/libs.versions.toml

@@ -20,7 +20,7 @@ kotlinCoroutines = "1.6.4"
 mockito = "4.6.1"
 mockitoKotlin = "4.0.0"
 mockk = "1.13.4"
-telemetryGenerator = "1.0.136"
+telemetryGenerator = "1.0.140"
 testLogger = "3.1.0"
 testRetry = "1.5.2"
 slf4j = "1.7.36"

jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/actions/SyncServerlessAppAction.kt

@@ -77,6 +77,12 @@ class SyncServerlessAppAction : AnAction(
                     content = (samExecutable as ExecutableInstance.BadExecutable).validationError
                 )
                 LOG.warn { "Invalid SAM CLI Executable" }
+                SamTelemetry.sync(
+                    project = project,
+                    result = Result.Failed,
+                    syncedResources = SyncedResources.AllResources,
+                    reason = "InvalidSamCli"
+                )
                 return@thenAccept
             }
 
@@ -110,6 +116,12 @@ class SyncServerlessAppAction : AnAction(
                         }
                     )
                 )
+                SamTelemetry.sync(
+                    project = project,
+                    result = Result.Failed,
+                    syncedResources = SyncedResources.AllResources,
+                    reason = "OldSamCliVersion"
+                )
                 return@thenAccept
             }
 
@@ -118,6 +130,12 @@ class SyncServerlessAppAction : AnAction(
             validateTemplateFile(project, templateFile)?.let {
                 notifyError(content = it, project = project)
                 LOG.warn { it }
+                SamTelemetry.sync(
+                    project = project,
+                    result = Result.Failed,
+                    syncedResources = SyncedResources.AllResources,
+                    reason = "UnparseableTemplateFile"
+                )
                 return@thenAccept
             }
 
@@ -190,7 +208,7 @@ class SyncServerlessAppAction : AnAction(
                                             syncedResources = syncedResourceType,
                                             lambdaPackageType = lambdaType,
                                             version = SamCommon.getVersionString(),
-                                            reason = "Docker not available"
+                                            reason = "DockerNotFound"
                                         )
                                         return@runInEdt
                                     }

jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/sam/SamVersionCache.kt

@@ -10,6 +10,8 @@ import software.aws.toolkits.jetbrains.core.executables.ExecutableCommon
 import software.aws.toolkits.jetbrains.core.executables.ExecutableType
 import software.aws.toolkits.jetbrains.utils.FileInfoCache
 import software.aws.toolkits.resources.message
+import software.aws.toolkits.telemetry.Result
+import software.aws.toolkits.telemetry.SamTelemetry
 
 object SamVersionCache : FileInfoCache<SemVer>() {
     override fun getFileInfo(path: String): SemVer {
@@ -21,17 +23,25 @@ object SamVersionCache : FileInfoCache<SemVer>() {
         if (process.exitCode != 0) {
             val output = process.stderr.trimEnd()
             if (output.contains(SamCommon.SAM_INVALID_OPTION_SUBSTRING)) {
+                SamTelemetry.info(result = Result.Failed, reason = "SamCliUnexpectedOutput")
                 throw IllegalStateException(message("executableCommon.unexpected_output", SamCommon.SAM_NAME, output))
             }
             throw IllegalStateException(output)
         } else {
             val output = process.stdout.trimEnd()
             if (output.isEmpty()) {
+                SamTelemetry.info(result = Result.Failed, reason = "SamCliNoOutput")
                 throw IllegalStateException(message("executableCommon.empty_info", SamCommon.SAM_NAME))
             }
             val tree = SamCommon.mapper.readTree(output)
             val version = tree.get(SamCommon.SAM_INFO_VERSION_KEY).asText()
-            return SemVer.parseFromText(version) ?: throw IllegalStateException(message("executableCommon.version_parse_error", SamCommon.SAM_NAME, version))
+            val semVerVersion = SemVer.parseFromText(version)
+            if (semVerVersion == null) {
+                SamTelemetry.info(result = Result.Failed, reason = "UndetectableSamCliVersion")
+            } else {
+                SamTelemetry.info(result = Result.Succeeded)
+            }
+            return semVerVersion ?: throw IllegalStateException(message("executableCommon.version_parse_error", SamCommon.SAM_NAME, version))
         }
     }
 }

jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/wizard/SamInitRunner.kt

@@ -18,6 +18,8 @@ import software.aws.toolkits.jetbrains.services.lambda.sam.SamExecutable
 import software.aws.toolkits.jetbrains.services.lambda.sam.samInitCommand
 import software.aws.toolkits.jetbrains.services.schemas.SchemaTemplateParameters
 import software.aws.toolkits.resources.message
+import software.aws.toolkits.telemetry.Result
+import software.aws.toolkits.telemetry.SamTelemetry
 
 object SamInitRunner {
     private val LOG = getLogger<SamInitRunner>()
@@ -33,7 +35,13 @@ object SamInitRunner {
         ExecutableManager.getInstance().getExecutable<SamExecutable>().thenApply {
             val samExecutable = when (it) {
                 is ExecutableInstance.Executable -> it
-                else -> throw RuntimeException((it as? ExecutableInstance.BadExecutable)?.validationError)
+                else -> {
+                    SamTelemetry.init(
+                        result = Result.Failed,
+                        reason = "InvalidSamCli"
+                    )
+                    throw RuntimeException((it as? ExecutableInstance.BadExecutable)?.validationError)
+                }
             }
 
             val extraContent = if (schemaParameters?.templateExtraContext != null) {