Skip to content

Commit 7520b17

Browse files
authored
telemetry: update metrics descriptions (#759)
1 parent db4b3c2 commit 7520b17

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

telemetry/definitions/commonDefinitions.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1253,12 +1253,12 @@
12531253
{
12541254
"name": "reason",
12551255
"type": "string",
1256-
"description": "The reason for a metric or exception depending on context. It describes a certain theme of errors usually the exception class name eg. FileIOException"
1256+
"description": "Reason code or name for an event (when result=Succeeded) or error (when result=Failed). Unlike the `reasonDesc` field, this should be a stable/predictable name for a class of events or errors (typically the exception name, e.g. FileIOException)."
12571257
},
12581258
{
12591259
"name": "reasonDesc",
12601260
"type": "string",
1261-
"description": "Error message detail (truncated). May contain arbitrary message details (as opposed to the 'reason' field, which is intended to have a predictable value for a particular class of failures)."
1261+
"description": "Error message detail. May contain arbitrary message details (unlike the `reason` field), but should be truncated (recommendation: 200 chars)."
12621262
},
12631263
{
12641264
"name": "referencePolicyType",
@@ -1268,7 +1268,7 @@
12681268
"Resource",
12691269
"None"
12701270
],
1271-
"description": "User inputted policy type of the reference file. Applicable to only CheckNoNewAccess check type."
1271+
"description": "User-provided policy type of the reference file. Applicable to only CheckNoNewAccess check type."
12721272
},
12731273
{
12741274
"name": "requestId",

0 commit comments

Comments
 (0)