Expose success metric

Author: fooker

prometheus_script_wrapper/__init__.py

@@ -82,6 +82,10 @@ def main(prefix: str, output: Path, labels: List[Tuple[str, str]], script: List[
     exit_code_metric.add_sample(exit_code_metric.name, value=exit_code, labels=labels)
     registry.add(exit_code_metric)
 
+    success_metric = Metric(name=f"{prefix}_success", documentation="Whether the wrapped script succeeded.", typ="gauge")
+    success_metric.add_sample(success_metric.name, value=int(exit_code == 0), labels=labels)
+    registry.add(success_metric)
+
     runtime_metric = Metric(name=f"{prefix}_runtime_seconds", documentation="Runtime duration of the script in seconds", typ="gauge")
     runtime_metric.add_sample(runtime_metric.name, value=runtime, labels=labels)
     registry.add(runtime_metric)

tests/test_output.py

@@ -19,6 +19,7 @@ def test_success(tmp_path):
     with (tmp_path / "out.prom").open("r") as f:
         content = f.read()
         assert "test_exit_code 0" in content
+        assert "test_success 1" in content
         assert "test_runtime_seconds" in content
         assert "test_success_timestamp_seconds" in content
 
@@ -35,6 +36,7 @@ def test_failure(tmp_path):
     with (tmp_path / "out.prom").open("r") as f:
         content = f.read()
         assert "test_exit_code 1" in content
+        assert "test_success 0" in content
         assert "test_runtime_seconds" in content
         assert "test_success_timestamp_seconds" not in content  # Should not be present for failures
 
@@ -60,6 +62,7 @@ def test_exit_code(tmp_path):
     with (tmp_path / "out.prom").open("r") as f:
         content = f.read()
         assert "test_exit_code 42" in content
+        assert "test_success 0" in content
 
 
 def test_custom_metrics(tmp_path):
@@ -89,7 +92,6 @@ def test_custom_metrics(tmp_path):
     assert os.path.exists(tmp_path / "out.prom")
     with (tmp_path / "out.prom").open("r") as f:
         content = f.read()
-        assert "test_exit_code" in content
         assert "test_runtime_seconds" in content
         assert "test_script_test_count_total 42" in content
         assert 'test_script_test_gauge{mylabel="test"} 23' in content
@@ -140,6 +142,7 @@ def test_extra_labels(tmp_path):
     with (tmp_path / "out.prom").open("r") as f:
         content = f.read()
         assert 'test_exit_code{x="one",y="two"}' in content
+        assert 'test_success{x="one",y="two"}' in content
         assert 'test_runtime_seconds{x="one",y="two"}' in content
         assert 'test_script_test_count_total{x="one",y="two"} 42' in content
         assert 'test_script_test_gauge{mylabel="test",x="one",y="two"} 23' in content
@@ -170,6 +173,4 @@ def test_argument_passing(tmp_path):
     assert os.path.exists(tmp_path / "out.prom")
     with (tmp_path / "out.prom").open("r") as f:
         content = f.read()
-        assert "test_exit_code" in content
-        assert "test_runtime_seconds" in content
         assert 'test_script_test_count_total{test="--extra"} 1337' in content