feat: Add ignore-timeouts option (#41)

masci · web-flow · commit c78b05108a82 · 2025-02-26T10:51:48.000+01:00
* first attempt

* document ignore-timeouts
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ This Action lets you send events and metrics to Datadog from a GitHub workflow.
 
 ## Usage
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 > The action can send metrics and events to any Datadog site by setting the `api-url` param. When
 > omitted, it defaults to the US endpoint: `https://api.datadoghq.com`.
 
@@ -100,6 +100,53 @@ steps:
           service: "payment"
 ```
 
+## Inputs
+
+```yaml
+- name: Datadog
+  uses: masci/datadog@v1
+  with:
+    # The api key to use.
+    # Type: string
+    # Required
+    api-key: ${{ secrets.DATADOG_API_KEY }}
+
+    # The ingestion endpoint to use, US by default.
+    # Type: string
+    # Default: 'https://api.datadoghq.com'
+    api-url: ''
+
+    # The URL of the Log API endpoint.
+    # Type: string
+    # Default: 'https://http-intake.logs.datadoghq.com'
+    log-api-url: ''
+
+    # If true, timeout errors will be ignored and step will always succeed
+    # Type: boolean
+    # Default: false
+    ignore-timeouts:
+
+    # A list of metric objects to send, defined in YAML format
+    # Type: string
+    # Default: '[]'
+    metrics: ''
+
+    # A list of event objects to send, defined in YAML format.
+    # Type: string
+    # Default: '[]'
+    events: ''
+
+    # A list of service check objects to send, defined in YAML format.
+    # Type: string
+    # Default: '[]'
+    service-checks: ''
+
+    # A list of log objects to send, defined in YAML format.
+    # Type: string
+    # Default: '[]'
+    logs: ''
+```
+
 ## Development
 
 Install the dependencies
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -24,7 +24,8 @@ describe('unit-tests', () => {
     expect(dd.sendMetrics).toHaveBeenCalledWith(
       'https://api.datadoghq.com',
       'fooBarBaz',
-      []
+      [],
+      false
     )
   })
 
@@ -34,7 +35,8 @@ describe('unit-tests', () => {
     expect(dd.sendMetrics).toHaveBeenCalledWith(
       'http://example.com',
       'fooBarBaz',
-      []
+      [],
+      false
     )
     process.env['INPUT_API-URL'] = ''
   })
@@ -44,7 +46,8 @@ describe('unit-tests', () => {
     expect(dd.sendLogs).toHaveBeenCalledWith(
       'https://http-intake.logs.datadoghq.com',
       'fooBarBaz',
-      []
+      [],
+      false
     )
   })
 
@@ -54,7 +57,8 @@ describe('unit-tests', () => {
     expect(dd.sendLogs).toHaveBeenCalledWith(
       'http://example.com',
       'fooBarBaz',
-      []
+      [],
+      false
     )
     process.env['INPUT_LOG-API-URL'] = ''
   })
@@ -64,22 +68,26 @@ describe('unit-tests', () => {
     expect(dd.sendMetrics).toHaveBeenCalledWith(
       'https://api.datadoghq.com',
       'fooBarBaz',
-      []
+      [],
+      false
     )
     expect(dd.sendEvents).toHaveBeenCalledWith(
       'https://api.datadoghq.com',
       'fooBarBaz',
-      []
+      [],
+      false
     )
     expect(dd.sendServiceChecks).toHaveBeenCalledWith(
       'https://api.datadoghq.com',
       'fooBarBaz',
-      []
+      [],
+      false
     )
     expect(dd.sendLogs).toHaveBeenCalledWith(
       'https://http-intake.logs.datadoghq.com',
       'fooBarBaz',
-      []
+      [],
+      false
     )
   })
 })
diff --git a/action.yml b/action.yml
@@ -23,6 +23,10 @@ inputs:
   logs:
     description: 'A list of log objects to send, see docs for details'
     default: '[]'
+  ignore-timeouts:
+    description: 'Ignore timeout errors and continue execution'
+    required: false
+    default: 'false'
 runs:
   using: 'node20'
   main: 'dist/index.js'
diff --git a/src/datadog.ts b/src/datadog.ts
@@ -42,32 +42,51 @@ export function getClient(apiKey: string): httpm.HttpClient {
   })
 }
 
+function isTimeoutError(error: Error): boolean {
+  return error.message.includes('timeout') || error.message.includes('Timeout')
+}
+
 async function postMetricsIfAny(
   http: httpm.HttpClient,
   apiURL: string,
   metrics: {series: Array<Record<string, unknown>>},
-  endpoint: string
+  endpoint: string,
+  ignoreTimeouts: boolean
 ): Promise<void> {
   // POST data
   if (metrics.series.length) {
-    core.debug(`About to send ${metrics.series.length} metrics`)
-    const res: httpm.HttpClientResponse = await http.post(
-      `${apiURL}/api/${endpoint}`,
-      JSON.stringify(metrics)
-    )
-
-    if (res.message.statusCode === undefined || res.message.statusCode >= 400) {
-      throw new Error(
-        `HTTP request failed: ${res.message.statusMessage} ${res.message.statusCode}`
+    try {
+      core.debug(`About to send ${metrics.series.length} metrics`)
+      const res: httpm.HttpClientResponse = await http.post(
+        `${apiURL}/api/${endpoint}`,
+        JSON.stringify(metrics)
       )
+
+      if (
+        res.message.statusCode === undefined ||
+        res.message.statusCode >= 400
+      ) {
+        throw new Error(
+          `HTTP request failed: ${res.message.statusMessage} ${res.message.statusCode}`
+        )
+      }
+    } catch (error) {
+      if (ignoreTimeouts && isTimeoutError(error)) {
+        core.warning(
+          `Timeout occurred while sending metrics, but continuing due to ignore-timeout setting`
+        )
+        return
+      }
+      throw error
     }
   }
 }
 
 export async function sendMetrics(
   apiURL: string,
   apiKey: string,
-  metrics: Metric[]
+  metrics: Metric[],
+  ignoreTimeouts: boolean
 ): Promise<void> {
   const http: httpm.HttpClient = getClient(apiKey)
   // distributions use a different procotol.
@@ -89,27 +108,53 @@ export async function sendMetrics(
     })
   }
 
-  await postMetricsIfAny(http, apiURL, otherMetrics, 'v1/series')
-  await postMetricsIfAny(http, apiURL, distributions, 'v1/distribution_points')
+  await postMetricsIfAny(
+    http,
+    apiURL,
+    otherMetrics,
+    'v1/series',
+    ignoreTimeouts
+  )
+  await postMetricsIfAny(
+    http,
+    apiURL,
+    distributions,
+    'v1/distribution_points',
+    ignoreTimeouts
+  )
 }
 
 export async function sendEvents(
   apiURL: string,
   apiKey: string,
-  events: Event[]
+  events: Event[],
+  ignoreTimeouts: boolean
 ): Promise<void> {
   const http: httpm.HttpClient = getClient(apiKey)
   let errors = 0
 
   core.debug(`About to send ${events.length} events`)
   for (const ev of events) {
-    const res: httpm.HttpClientResponse = await http.post(
-      `${apiURL}/api/v1/events`,
-      JSON.stringify(ev)
-    )
-    if (res.message.statusCode === undefined || res.message.statusCode >= 400) {
-      errors++
-      core.error(`HTTP request failed: ${res.message.statusMessage}`)
+    try {
+      const res: httpm.HttpClientResponse = await http.post(
+        `${apiURL}/api/v1/events`,
+        JSON.stringify(ev)
+      )
+      if (
+        res.message.statusCode === undefined ||
+        res.message.statusCode >= 400
+      ) {
+        errors++
+        core.error(`HTTP request failed: ${res.message.statusMessage}`)
+      }
+    } catch (error) {
+      if (ignoreTimeouts && isTimeoutError(error)) {
+        core.warning(
+          `Timeout occurred while sending event, but continuing due to ignore-timeout setting`
+        )
+        continue
+      }
+      throw error
     }
   }
 
@@ -121,20 +166,34 @@ export async function sendEvents(
 export async function sendServiceChecks(
   apiURL: string,
   apiKey: string,
-  serviceChecks: ServiceCheck[]
+  serviceChecks: ServiceCheck[],
+  ignoreTimeouts: boolean
 ): Promise<void> {
   const http: httpm.HttpClient = getClient(apiKey)
   let errors = 0
 
   core.debug(`About to send ${serviceChecks.length} service checks`)
   for (const sc of serviceChecks) {
-    const res: httpm.HttpClientResponse = await http.post(
-      `${apiURL}/api/v1/check_run`,
-      JSON.stringify(sc)
-    )
-    if (res.message.statusCode === undefined || res.message.statusCode >= 400) {
-      errors++
-      core.error(`HTTP request failed: ${res.message.statusMessage}`)
+    try {
+      const res: httpm.HttpClientResponse = await http.post(
+        `${apiURL}/api/v1/check_run`,
+        JSON.stringify(sc)
+      )
+      if (
+        res.message.statusCode === undefined ||
+        res.message.statusCode >= 400
+      ) {
+        errors++
+        core.error(`HTTP request failed: ${res.message.statusMessage}`)
+      }
+    } catch (error) {
+      if (ignoreTimeouts && isTimeoutError(error)) {
+        core.warning(
+          `Timeout occurred while sending service check, but continuing due to ignore-timeout setting`
+        )
+        continue
+      }
+      throw error
     }
   }
 
@@ -148,21 +207,35 @@ export async function sendServiceChecks(
 export async function sendLogs(
   logApiURL: string,
   apiKey: string,
-  logs: Log[]
+  logs: Log[],
+  ignoreTimeouts: boolean
 ): Promise<void> {
   const http: httpm.HttpClient = getClient(apiKey)
   let errors = 0
 
   core.debug(`About to send ${logs.length} logs`)
   for (const log of logs) {
-    const res: httpm.HttpClientResponse = await http.post(
-      `${logApiURL}/v1/input`,
-      JSON.stringify(log)
-    )
-    if (res.message.statusCode === undefined || res.message.statusCode >= 400) {
-      errors++
-      core.error(`HTTP request failed: ${res.message.statusMessage}`)
-      throw new Error(`Failed sending ${errors} out of ${logs.length} events`)
+    try {
+      const res: httpm.HttpClientResponse = await http.post(
+        `${logApiURL}/v1/input`,
+        JSON.stringify(log)
+      )
+      if (
+        res.message.statusCode === undefined ||
+        res.message.statusCode >= 400
+      ) {
+        errors++
+        core.error(`HTTP request failed: ${res.message.statusMessage}`)
+        throw new Error(`Failed sending ${errors} out of ${logs.length} events`)
+      }
+    } catch (error) {
+      if (ignoreTimeouts && isTimeoutError(error)) {
+        core.warning(
+          `Timeout occurred while sending logs, but continuing due to ignore-timeout setting`
+        )
+        continue
+      }
+      throw error
     }
   }
 
diff --git a/src/run.ts b/src/run.ts
@@ -5,22 +5,23 @@ import * as dd from './datadog'
 export async function run(): Promise<void> {
   const apiKey: string = core.getInput('api-key', {required: true})
   const apiURL: string = core.getInput('api-url') || 'https://api.datadoghq.com'
+  const ignoreTimeouts: boolean = core.getInput('ignore-timeouts') === 'false'
 
   const metrics: dd.Metric[] =
     (yaml.safeLoad(core.getInput('metrics')) as dd.Metric[]) || []
-  await dd.sendMetrics(apiURL, apiKey, metrics)
+  await dd.sendMetrics(apiURL, apiKey, metrics, ignoreTimeouts)
 
   const events: dd.Event[] =
     (yaml.safeLoad(core.getInput('events')) as dd.Event[]) || []
-  await dd.sendEvents(apiURL, apiKey, events)
+  await dd.sendEvents(apiURL, apiKey, events, ignoreTimeouts)
 
   const serviceChecks: dd.ServiceCheck[] =
     (yaml.safeLoad(core.getInput('service-checks')) as dd.ServiceCheck[]) || []
-  await dd.sendServiceChecks(apiURL, apiKey, serviceChecks)
+  await dd.sendServiceChecks(apiURL, apiKey, serviceChecks, ignoreTimeouts)
 
   const logApiURL: string =
     core.getInput('log-api-url') || 'https://http-intake.logs.datadoghq.com'
   const logs: dd.Log[] =
     (yaml.safeLoad(core.getInput('logs')) as dd.Log[]) || []
-  await dd.sendLogs(logApiURL, apiKey, logs)
+  await dd.sendLogs(logApiURL, apiKey, logs, ignoreTimeouts)
 }
