remove service check and pin docker version for testing

Author: HadhemiDD

n8n/datadog_checks/n8n/check.py

@@ -8,7 +8,6 @@
 from datadog_checks.n8n.metrics import METRIC_MAP
 
 DEFAULT_READY_ENDPOINT = '/healthz/readiness'
-DEFAULT_HEALTH_ENDPOINT = '/healthz'
 DEFAULT_VERSION_ENDPOINT = '/rest/settings'
 
 
@@ -25,7 +24,6 @@ def __init__(self, name, init_config, instances=None):
         self.openmetrics_endpoint = self.instance["openmetrics_endpoint"]
         self.tags = self.instance.get('tags', [])
         self._ready_endpoint = DEFAULT_READY_ENDPOINT
-        self._health_endpoint = DEFAULT_HEALTH_ENDPOINT
         self._version_endpoint = DEFAULT_VERSION_ENDPOINT
         # Get the N8N API port if specified, otherwise use the default 5678.
         self.server_port = str(self.instance.get('server_port', 5678))
@@ -69,33 +67,20 @@ def _submit_version_metadata(self):
         except Exception as e:
             self.log.debug("Error retrieving version metadata: %s", e)
 
-    def _check_n8n_health(self):
-        endpoint = urljoin(self.openmetrics_endpoint, self._health_endpoint)
-        response = self.http.get(endpoint)
-
-        # Any 4xx or 5xx response from the API endpoint (/healthz) means the n8n process is not responding
-        if 400 <= response.status_code and response.status_code < 600:
-            self.service_check('health.status', AgentCheck.CRITICAL, self.tags)
-        if response.status_code == 200:
-            self.service_check('health.status', AgentCheck.OK, self.tags)
-        else:
-            self.service_check('health.status', AgentCheck.UNKNOWN, self.tags)
-
     def _check_n8n_readiness(self):
         endpoint = urljoin(self.openmetrics_endpoint, self._ready_endpoint)
         response = self.http.get(endpoint)
 
-        # Any 4xx or 5xx response from the API endpoint (/healthz/readiness)
-        # means the n8n Database is not ready to accept requests
-        if 400 <= response.status_code and response.status_code < 600:
-            self.service_check('health.status', AgentCheck.CRITICAL, self.tags)
-        if response.status_code == 200:
-            self.service_check('health.status', AgentCheck.OK, self.tags)
+        # Check if status_code is available
+        if response.status_code is None:
+            self.log.warning("The readiness endpoint did not return a status code")
         else:
-            self.service_check('health.status', AgentCheck.UNKNOWN, self.tags)
+            metric_tags = self.tags + [f'status_code:{response.status_code}']
+
+        # Submit metric with value 1 and status_code as tag
+        self.gauge('readiness.check', 1, tags=metric_tags)
 
     def check(self, instance):
         super().check(instance)
         self._submit_version_metadata()
-        self._check_n8n_health()
         self._check_n8n_readiness()

n8n/hatch.toml

@@ -2,3 +2,10 @@
 
 [[envs.default.matrix]]
 python = ["3.13"]
+
+version = ["118.1"]
+
+[envs.default.overrides]
+matrix.version.env-vars = [
+  { key = "N8N_VERSION", value = "118.1", if = ["118.1"] },
+]

n8n/metadata.csv

@@ -66,6 +66,7 @@ n8n.queue.job.waiting.total,gauge,,,,Number of jobs currently waiting in the que
 n8n.queue.jobs.count,count,,,,Total number of queue jobs,0,n8n,,,
 n8n.queue.jobs.duration.seconds.count,count,,,,The count of job duration in seconds,0,n8n,,,
 n8n.queue.jobs.duration.seconds.sum,count,,,,The sum of job duration in seconds,0,n8n,,,
+n8n.readiness.check,gauge,,,,Readiness check metric with status code as tag,0,n8n,,,status_code
 n8n.version.info,gauge,,,,n8n version info.,0,n8n,,,
 n8n.workflow.executions.active,gauge,,,,Number of active workflow executions,0,n8n,,,
 n8n.workflow.executions.count,count,,,,Total number of workflow executions,0,n8n,,,

n8n/tests/docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM docker.n8n.io/n8nio/n8n:latest
+FROM docker.n8n.io/n8nio/n8n:${N8N_VERSION}
 
 # Set environment variables to enable metrics and logging
 ENV N8N_METRICS=true \

n8n/tests/test_e2e.py

@@ -11,4 +11,18 @@
 def test_check_n8n_e2e(dd_agent_check, instance):
     aggregator = dd_agent_check(instance, rate=True)
     aggregator.assert_service_check('n8n.openmetrics.health', ServiceCheck.OK, count=2)
+    
+    # Assert the readiness check metric is present with status_code tag
+    aggregator.assert_metric('n8n.readiness.check', value=1, count=1)
+    
+    # Verify the metric has a status_code tag
+    metrics = aggregator.metrics('n8n.readiness.check')
+    assert len(metrics) > 0, "n8n.readiness.check metric not found"
+    
+    # Check that status_code tag is present
+    tags = metrics[0].tags
+    status_code_tags = [tag for tag in tags if tag.startswith('status_code:')]
+    assert len(status_code_tags) == 1, f"Expected exactly one status_code tag, got {len(status_code_tags)}"
+    assert status_code_tags[0] == 'status_code:200', f"Expected status_code:200, got {status_code_tags[0]}"
+    
     assert_service_checks(aggregator)

n8n/tests/test_unit.py

@@ -3,6 +3,7 @@
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
 from datadog_checks.n8n import N8nCheck
+from datadog_checks.dev.utils import get_metadata_metrics
 
 from . import common
 
@@ -15,6 +16,7 @@ def test_unit_metrics(dd_run_check, instance, aggregator, mock_http_response):
     for metric in common.TEST_METRICS:
         aggregator.assert_metric(metric)
     aggregator.assert_all_metrics_covered()
+    aggregator.assert_metrics_using_metadata(get_metadata_metrics())
 
 
 def test_metrics_custom_prefx(dd_run_check, aggregator, mock_http_response):
@@ -29,3 +31,4 @@ def test_metrics_custom_prefx(dd_run_check, aggregator, mock_http_response):
     for metric in common.TEST_METRICS:
         aggregator.assert_metric(metric)
     aggregator.assert_all_metrics_covered()
+    aggregator.assert_metrics_using_metadata(get_metadata_metrics())