Updated "event.outcome" values from "Succeeded" to "success" and "Fai…

…led" to "failure"
elastic · Jul 5, 2024 · 3ba83d1 · 3ba83d1
1 parent f452d01
commit 3ba83d1
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 8 deletions.
diff --git a/packages/azure/changelog.yml b/packages/azure/changelog.yml
@@ -3,6 +3,9 @@
  - description: ECS version updated to 8.11.0. Update the kibana constraint to ^8.13.0. Modified the field definitions to remove ECS fields made redundant by the ecs@mappings component template.
  type: enhancement
  link: https:/elastic/integrations/pull/10224
+ - description: Updated "event.outcome" values from "Succeeded" to "success" and "Failed" to "failure".
+ type: breaking-change
+ link: https:/elastic/apm-server/pull/10224
 - version: "1.11.4"
  changes:
  - description: Replace Azure AD with Microsoft Entra ID.

diff --git a/packages/azure/data_stream/eventhub/sample_event.json b/packages/azure/data_stream/eventhub/sample_event.json
@@ -43,7 +43,7 @@
  "172.27.0.7"
  ],
  "mac": [
- "02:42:ac:1b:00:07"
+ "02-42-AC-14-00-07"
  ],
  "name": "docker-fleet-agent",
  "os": {

diff --git a/...data_stream/platformlogs/_dev/test/pipeline/test-platformlogs-edgecases.log-expected.json b/...data_stream/platformlogs/_dev/test/pipeline/test-platformlogs-edgecases.log-expected.json
@@ -39,7 +39,7 @@
  "action": "Retreive ConsumerGroup",
  "kind": "event",
  "original": "{\"ActivityId\":\"30ed877c-a36b-491a-bd4d-ddd847fe55b8\",\"Caller\":\"Portal\",\"callerIpAddress\": \"2a02:cf40:add:4002:91f2:a9b2:e09a:6fc6\",\"Environment\":\"PROD\",\"EventName\":\"Retreive ConsumerGroup\",\"EventProperties\":\"{\\\"SubscriptionId\\\":\\\"7657426d-c4c3-44ac-88a2-3b2cd59e6dba\\\",\\\"Namespace\\\":\\\"obstesteventhubs\\\"}\",\"EventTimeString\":\"11/3/2020 9:06:42 AM +00:00\",\"Region\":\"West Europe\",\"ScaleUnit\":\"PROD-AM3-AZ501\",\"Status\":\"Succeeded\",\"category\":\"OperationalLogs\",\"resourceId\":\"/SUBSCRIPTIONS/7657426D-C4C3-44AC-88A2-3B2CD59E6DBA/RESOURCEGROUPS/OBS-TEST/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/OBSTESTEVENTHUBS\"}",
- "outcome": "succeeded"
+ "outcome": "success"
  },
  "geo": {
  "continent_name": "Europe",
@@ -107,7 +107,7 @@
  "action": "Retreive ConsumerGroup",
  "kind": "event",
  "original": "{\"ActivityId\":\"30ed877c-a36b-491a-bd4d-ddd847fe55b8\",\"Caller\":\"Portal\",\"callerIpAddress\": \"XX:2a02:cf40:add:4002:91f2:a9b2:e09a:6fc6\",\"Environment\":\"PROD\",\"EventName\":\"Retreive ConsumerGroup\",\"EventProperties\":\"{\\\"SubscriptionId\\\":\\\"7657426d-c4c3-44ac-88a2-3b2cd59e6dba\\\",\\\"Namespace\\\":\\\"obstesteventhubs\\\"}\",\"EventTimeString\":\"11/3/2020 9:06:42 AM +00:00\",\"Region\":\"West Europe\",\"ScaleUnit\":\"PROD-AM3-AZ501\",\"Status\":\"Succeeded\",\"category\":\"OperationalLogs\",\"resourceId\":\"/SUBSCRIPTIONS/7657426D-C4C3-44AC-88A2-3B2CD59E6DBA/RESOURCEGROUPS/OBS-TEST/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/OBSTESTEVENTHUBS\"}",
- "outcome": "succeeded"
+ "outcome": "success"
  },
  "source": {
  "address": "XX:2a02:cf40:add:4002:91f2:a9b2:e09a:6fc6"

diff --git a/...azure/data_stream/platformlogs/_dev/test/pipeline/test-platformlogs-raw.log-expected.json b/...azure/data_stream/platformlogs/_dev/test/pipeline/test-platformlogs-raw.log-expected.json
@@ -38,7 +38,7 @@
  "action": "Retreive ConsumerGroup",
  "kind": "event",
  "original": "{\"ActivityId\":\"30ed877c-a36b-491a-bd4d-ddd847fe55b8\",\"Caller\":\"Portal\",\"Environment\":\"PROD\",\"EventName\":\"Retreive ConsumerGroup\",\"EventProperties\":\"{\\\"SubscriptionId\\\":\\\"7657426d-c4c3-44ac-88a2-3b2cd59e6dba\\\",\\\"Namespace\\\":\\\"obstesteventhubs\\\",\\\"Via\\\":\\\"sb://obstesteventhubs.servicebus.windows.net/insights-logs-operationallogs/consumergroups?api-version=2017-04\\u0026$skip=0\\u0026$top=100\\\",\\\"TrackingId\\\":\\\"30ed877c-a36b-491a-bd4d-ddd847fe55b8_M2CH3_M2CH3_G3S2\\\"}\",\"EventTimeString\":\"11/3/2020 9:06:42 AM +00:00\",\"Region\":\"West Europe\",\"ScaleUnit\":\"PROD-AM3-AZ501\",\"Status\":\"Succeeded\",\"category\":\"OperationalLogs\",\"resourceId\":\"/SUBSCRIPTIONS/7657426D-C4C3-44AC-88A2-3B2CD59E6DBA/RESOURCEGROUPS/OBS-TEST/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/OBSTESTEVENTHUBS\"}",
- "outcome": "succeeded"
+ "outcome": "success"
  },
  "tags": [
  "preserve_original_event"
@@ -80,7 +80,7 @@
  "action": "Retreive ConsumerGroup",
  "kind": "event",
  "original": "{\"ActivityId\":\"30ed877c-a36b-491a-bd4d-ddd847fe55b8\",\"Caller\":\"Portal\",\"Environment\":\"PROD\",\"EventName\":\"Retreive ConsumerGroup\",\"EventProperties\":\"{\\\"SubscriptionId\\\":\\\"7657426d-c4c3-44ac-88a2-3b2cd59e6dba\\\",\\\"Namespace\\\":\\\"obstesteventhubs\\\"}\",\"EventTimeString\":\"11/3/2020 9:06:42 AM +00:00\",\"Region\":\"West Europe\",\"ScaleUnit\":\"PROD-AM3-AZ501\",\"Status\":\"Succeeded\",\"category\":\"OperationalLogs\",\"resourceId\":\"/SUBSCRIPTIONS/7657426D-C4C3-44AC-88A2-3B2CD59E6DBA/RESOURCEGROUPS/OBS-TEST/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/OBSTESTEVENTHUBS\"}",
- "outcome": "succeeded"
+ "outcome": "success"
  },
  "tags": [
  "preserve_original_event"

diff --git a/packages/azure/data_stream/platformlogs/elasticsearch/ingest_pipeline/default.yml b/packages/azure/data_stream/platformlogs/elasticsearch/ingest_pipeline/default.yml
@@ -186,6 +186,16 @@ processors:
  target_field: event.outcome
  type: string
  if: "ctx?.event?.outcome == null && ctx?.azure?.platformlogs?.Status != null && ctx?.azure?.platformlogs?.Status instanceof String && ['success', 'failure', 'unknown', 'Succeeded', 'Failed'].contains(ctx.azure?.platformlogs?.Status)"
+ - set:
+ field: event.outcome
+ value: "success"
+ override: true
+ if: ctx?.event?.outcome != null && ctx?.event?.outcome == "Succeeded"
+ - set:
+ field: event.outcome
+ value: "failure"
+ override: true
+ if: ctx?.event?.outcome != null && ctx?.event?.outcome == "Failed"
  - rename:
  field: azure.platformlogs.operationName
  target_field: azure.platformlogs.operation_name

diff --git a/packages/azure/data_stream/platformlogs/sample_event.json b/packages/azure/data_stream/platformlogs/sample_event.json
@@ -54,7 +54,7 @@
  "dataset": "azure.platformlogs",
  "ingested": "2020-11-01T12:02:34.237205200Z",
  "kind": "event",
- "outcome": "succeeded"
+ "outcome": "success"
  },
  "host": {
  "name": "DESKTOP-RFOOE09"

diff --git a/packages/azure/docs/eventhub.md b/packages/azure/docs/eventhub.md
@@ -114,7 +114,7 @@ An example event for `eventhub` looks as following:
  "172.27.0.7"
  ],
  "mac": [
- "02:42:ac:1b:00:07"
+ "02-42-AC-14-00-07"
  ],
  "name": "docker-fleet-agent",
  "os": {

diff --git a/packages/azure/docs/platformlogs.md b/packages/azure/docs/platformlogs.md
@@ -121,7 +121,7 @@ An example event for `platformlogs` looks as following:
  "dataset": "azure.platformlogs",
  "ingested": "2020-11-01T12:02:34.237205200Z",
  "kind": "event",
- "outcome": "succeeded"
+ "outcome": "success"
  },
  "host": {
  "name": "DESKTOP-RFOOE09"