Merge pull request #245853 from jeanbisutti/telemetry-processor-update

Attribute masking for telemetry processor

Author: prmerger-automator[bot]

articles/azure-monitor/app/java-standalone-telemetry-processors-examples.md

@@ -355,9 +355,12 @@ For example, given `http.url = http://example.com/path?queryParam1=value1,queryP
 }
 ```
 
-The following sample shows how to process spans that have a span name that matches regex patterns.
-This processor removes the `token` attribute. It obfuscates the `password` attribute in spans where the span name matches `auth.*`
-and where the span name doesn't match `login.*`.
+### Mask
+
+For example, given `http.url = https://example.com/user/12345622` is updated to `http.url = https://example.com/user/****` using either of the below configurations.
+
+
+First configuration example:
 
 ```json
 {
@@ -366,27 +369,12 @@ and where the span name doesn't match `login.*`.
     "processors": [
       {
         "type": "attribute",
-        "include": {
-          "matchType": "regexp",
-          "spanNames": [
-            "auth.*"
-          ]
-        },
-        "exclude": {
-          "matchType": "regexp",
-          "spanNames": [
-            "login.*"
-          ]
-        },
         "actions": [
           {
-            "key": "password",
-            "value": "obfuscated",
-            "action": "update"
-          },
-          {
-            "key": "token",
-            "action": "delete"
+            "key": "http.url",
+            "pattern": "user\\/\\d+",
+            "replace": "user\\/****",
+            "action": "mask"
           }
         ]
       }
@@ -396,6 +384,29 @@ and where the span name doesn't match `login.*`.
 ```
 
 
+Second configuration example with regular expression group name:
+
+```json
+{
+  "connectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000",
+  "preview": {
+    "processors": [
+      {
+        "type": "attribute",
+        "actions": [
+          {
+            "key": "http.url",
+            "pattern": "^(?<userGroupName>[a-zA-Z.:\/]+)\d+",
+            "replace": "${userGroupName}**",
+            "action": "mask"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
 ## Span processor samples
 
 ### Name a span

articles/azure-monitor/app/java-standalone-telemetry-processors.md

@@ -15,7 +15,7 @@ ms.reviewer: mmcc
 
 Application Insights Java 3.x can process telemetry data before the data is exported.
 
-Here are some use cases for telemetry processors:
+Some use cases:
  * Mask sensitive data.
  * Conditionally add custom dimensions.
  * Update the span name, which is used to aggregate similar telemetry in the Azure portal.
@@ -52,7 +52,11 @@ The trace message or body is the primary display for logs in the Azure portal. L
 
 ## Telemetry processor types
 
-Currently, the four types of telemetry processors are attribute processors, span processors, log processors, and metric filters.
+Currently, the four types of telemetry processors are
+* Attribute processors
+* Span processors
+* Log processors
+* Metric filters
 
 An attribute processor can insert, update, delete, or hash attributes of a telemetry item (`span` or `log`).
 It can also use a regular expression to extract one or more new attributes from an existing attribute.
@@ -111,6 +115,7 @@ The attribute processor modifies attributes of a `span` or a `log`. It can suppo
 - `delete`
 - `hash`
 - `extract`
+- `mask`
 
 ### `insert`
 
@@ -227,6 +232,38 @@ The `extract` action requires the following settings:
 * `pattern`
 * `action`: `extract`
 
+### `mask`
+
+> [!NOTE]
+> The `mask` feature is available only in version 3.2.5 and later.
+
+The `mask` action masks attribute values by using a regular expression rule specified in the `pattern` and `replace`.
+
+```json
+"processors": [
+  {
+    "type": "attribute",
+    "actions": [
+      {
+        "key": "attributeName",
+        "pattern": "<regular expression pattern>",
+        "replace": "<replacement value>",
+        "action": "mask"
+      }
+    ]
+  }
+]
+```
+The `mask` action requires the following settings:
+* `key`
+* `pattern`
+* `replace`
+* `action`: `mask`
+
+`pattern` can contain a named group placed betwen `?<` and `>:`. Example: `(?<userGroupName>[a-zA-Z.:\/]+)\d+`? The gorup is `(?<userGroupName>[a-zA-Z.:\/]+)` and `userGroupName` is the name of the group. `pattern` can then contain the same named group placed between `${` and `}` followed by the masK. Example where the mask is **: `${userGroupName}**`.
+
+See  [Telemetry processor examples](./java-standalone-telemetry-processors-examples.md) for masking examples.
+
 ### Include criteria and exclude criteria
 
 Attribute processors support optional `include` and `exclude` criteria.