adding scopes to auth metrics for detailed authStatus (#736)

* adding scopes to auth metrics for detailed authStatus * npm run fix * added authScopes to addConnection metric * reworded auth_userState --------- Co-authored-by: Dhruvi Gajjar <[email protected]>
aws · May 17, 2024 · 7b10365 · 7b10365
1 parent 3008f9c
commit 7b10365
Showing 1 changed file with 48 additions and 1 deletion.
diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json
@@ -102,6 +102,26 @@
             "type": "int",
             "description": "Current number of authentication connections the user has"
         },
+        {
+            "name": "authEnabledConnections",
+            "type": "string",
+            "description": "Comma-delimited list of enabled auths."
+        },
+        {
+            "name": "authScopes",
+            "type": "string",
+            "description": "Comma-delimited list of scopes that users has"
+        },
+        {
+            "name": "authStatus",
+            "type": "string",
+            "allowedValues": [
+                "connected",
+                "notConnected",
+                "expired"
+            ],
+            "description": "Status of the an auth connection."
+        },
         {
             "name": "awsFiletype",
             "type": "string",
@@ -1893,6 +1913,10 @@
                     "type": "attempts",
                     "required": false
                 },
+                {
+                    "type": "authScopes",
+                    "required": false
+                },
                 {
                     "type": "credentialSourceId"
                 },
@@ -1961,6 +1985,29 @@
                 }
             ]
         },
+        {
+            "name": "auth_userState",
+            "description": "The state of the user's authentication upon startup.",
+            "metadata": [
+                {
+                    "type": "authEnabledConnections",
+                    "required": true
+                },
+                {
+                    "type": "authScopes",
+                    "required": false
+                },
+                {
+                    "type": "authStatus",
+                    "required": true
+                },
+                {
+                    "type": "source",
+                    "required": true
+                }
+            ],
+            "passive": true
+        },
         {
             "name": "aws_copyArn",
             "description": "Copy the ARN of an AWS resource",
@@ -5866,4 +5913,4 @@
             ]
         }
     ]
-}
+}