Add options automator latency as a tag and into the msg (#923)

* Add options automator latency as a tag and into the msg

* added a testcase

* fields

* update latencyy seconds expcted

* small change

Author: kneeyo1

src/types/index.ts

@@ -19,6 +19,7 @@ export interface SentryOptionsResponse {
     got_type: string;
     expected_type: string;
   }[];
+  latency_seconds?: number;
 }
 
 export interface KafkaControlPlaneResponse {

src/webhooks/sentry-options/sentry-options.test.ts

@@ -3,6 +3,7 @@ import * as Sentry from '@sentry/node';
 import testAdminPayload from '@test/payloads/sentry-options/test-admin-payload.json';
 import testBadPayload from '@test/payloads/sentry-options/test-bad-payload.json';
 import testEmptyPayload from '@test/payloads/sentry-options/test-empty-payload.json';
+import testLatencyPayload from '@test/payloads/sentry-options/test-latency-payload.json';
 import testMegaPayload from '@test/payloads/sentry-options/test-mega-payload.json';
 import testPartialPayload from '@test/payloads/sentry-options/test-partial-payload.json';
 import testPayload from '@test/payloads/sentry-options/test-payload.json';
@@ -628,4 +629,63 @@ describe('sentry-options webhook', function () {
       },
     });
   });
+
+  it('should include latency_seconds tag when present', async function () {
+    await sendSentryOptionsUpdatesToDatadog(testLatencyPayload, 1699563828);
+    expect(datadogApiInstanceSpy).toHaveBeenCalledTimes(2);
+
+    // Check the drifted_options message
+    const driftedMessage = datadogApiInstanceSpy.mock.calls[0][0];
+    expect(driftedMessage).toEqual({
+      body: {
+        dateHappened: 1699563828,
+        text: '{"change":"drifted_options","option":{"option_name":"drifted_option_1","option_value":"value_1"},"latency_seconds":2.5}',
+        title: 'Sentry Options Update',
+        alertType: 'error',
+        tags: [
+          'sentry_region:st-test_region',
+          'source_tool:options-automator',
+          'source:options-automator',
+          'source_category:infra-tools',
+          'option_name:drifted_option_1',
+          'sentry_user:options-automator',
+          'latency_seconds:2.5',
+        ],
+      },
+    });
+
+    const updatedMessage = datadogApiInstanceSpy.mock.calls[1][0];
+    expect(updatedMessage).toEqual({
+      body: {
+        dateHappened: 1699563828,
+        text: '{"change":"updated_options","option":{"option_name":"updated_option_1","db_value":"db_value_1","value":"new_value_1"},"latency_seconds":2.5}',
+        title: 'Sentry Options Update',
+        alertType: 'success',
+        tags: [
+          'sentry_region:st-test_region',
+          'source_tool:options-automator',
+          'source:options-automator',
+          'source_category:infra-tools',
+          'option_name:updated_option_1',
+          'sentry_user:options-automator',
+          'latency_seconds:2.5',
+        ],
+      },
+    });
+  });
+
+  it('should not include latency_seconds tag when not present', async function () {
+    await sendSentryOptionsUpdatesToDatadog(testPartialPayload, 1699563828);
+    expect(datadogApiInstanceSpy).toHaveBeenCalledTimes(2);
+
+    const firstMessage = datadogApiInstanceSpy.mock.calls[0][0];
+    const secondMessage = datadogApiInstanceSpy.mock.calls[1][0];
+
+    expect(firstMessage.body.tags).not.toContain(
+      expect.stringMatching(/^latency_seconds:/)
+    );
+    expect(secondMessage.body.tags).not.toContain(
+      expect.stringMatching(/^latency_seconds:/)
+    );
+  });
 });

src/webhooks/sentry-options/sentry-options.ts

@@ -75,29 +75,44 @@ export async function sendSentryOptionsUpdatesToDatadog(
   const region = formatRegionTag(message.region);
 
   for (const optionType in message) {
-    if (optionType === 'region' || optionType === 'source') continue;
+    if (
+      optionType === 'region' ||
+      optionType === 'source' ||
+      optionType === 'latency_seconds'
+    )
+      continue;
     for (const option of message[optionType]) {
       const text = {
         change: optionType,
         option: option,
+        ...(message.latency_seconds !== undefined && {
+          latency_seconds: message.latency_seconds,
+        }),
       };
 
       const alertType = formatAlertType(optionType);
 
+      const tags = [
+        region,
+        `source_tool:${message.source}`,
+        `source:${message.source}`,
+        `source_category:infra-tools`,
+        `option_name:${option.option_name}`,
+        `sentry_user:${message.source}`,
+      ];
+
+      // Add latency_seconds as a tag if it exists
+      if (message.latency_seconds !== undefined) {
+        tags.push(`latency_seconds:${message.latency_seconds}`);
+      }
+
       const params: v1.EventCreateRequest = {
         title: 'Sentry Options Update',
         // TODO(getsentry/eng-pipes#706): Refactor Text Message
         text: JSON.stringify(text),
         alertType: alertType,
         dateHappened: timestamp,
-        tags: [
-          region,
-          `source_tool:${message.source}`,
-          `source:${message.source}`,
-          `source_category:infra-tools`,
-          `option_name:${option.option_name}`,
-          `sentry_user:${message.source}`,
-        ],
+        tags: tags,
       };
       await DATADOG_API_INSTANCE.createEvent({ body: params });
     }

test/payloads/sentry-options/test-latency-payload.json

@@ -0,0 +1,20 @@
+{
+    "region": "test_region",
+    "source": "options-automator",
+    "latency_seconds": 2.5,
+    "drifted_options": [
+        {"option_name": "drifted_option_1", "option_value": "value_1"}
+    ],
+    "updated_options": [
+        {
+            "option_name": "updated_option_1",
+            "db_value": "db_value_1",
+            "value": "new_value_1"
+        }
+    ],
+    "set_options": [],
+    "unset_options": [],
+    "not_writable_options": [],
+    "unregistered_options": [],
+    "invalid_type_options": []
+}