From 07008a544700a11f4bb295a97df00bfaf3c88e64 Mon Sep 17 00:00:00 2001 From: Jacobo de Vera Date: Fri, 1 May 2026 20:04:20 +0100 Subject: [PATCH 1/2] Fix monitoring metrics format in provider guide The documented graphite path and metric set did not match the actual emission. Update the provider guide to describe: - the six-segment path including the user partition between command name and metric leaf - the four metric leaves (count, duration, ok, ko) as independent siblings rather than ok/ko compounds of count and duration - the nanosecond unit on duration - the three lines emitted per invocation --- .../en/docs/overview/provider-guide.md | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/gh-pages/content/en/docs/overview/provider-guide.md b/gh-pages/content/en/docs/overview/provider-guide.md index eec3b29a..8ad06f23 100644 --- a/gh-pages/content/en/docs/overview/provider-guide.md +++ b/gh-pages/content/en/docs/overview/provider-guide.md @@ -173,12 +173,22 @@ You will have different monitoring vectors for each partition, which will help y ## Monitoring -Command launcher current implements a built-in graphite exporter. It reports the following metrics to graphite: +Command launcher implements a built-in graphite exporter. Every command invocation emits three independent metric lines over UDP (port 3341) under the prefix: -1. success command execution count: `devtools.cdt.[package name].[group].[name].ok.count` -2. success command duration: `devtools.cdt.[package name].[group].[name].ok.duration` -3. fail command execution count: `devtools.cdt.[package name].[group].[name].ko.count` -4. fail command duration: `devtools.cdt.[package name].[group].[name].ko.duration` +``` +devtools.cdt.[package name].[group].[name].[partition].[metric] +``` + +where `[partition]` is the user partition (0-9, see [Progressive Rollout](#progressive-rollout)) and `[metric]` is one of `count`, `duration`, `ok`, or `ko`. + +Each invocation emits: + +1. `…count` — value `1`, always emitted. +2. `…duration` — execution time in **nanoseconds**, always emitted. +3. `…ok` — value `1`, emitted only when the command succeeded (exit code 0, no error). +4. `…ko` — value `1`, emitted only when the command failed (non-zero exit code or error). + +`ok` and `ko` are siblings of `count` and `duration` — they are not modifiers of them. A successful invocation produces three lines: `…count`, `…duration`, and `…ok`. A failed invocation produces `…count`, `…duration`, and `…ko`. You can add your custom metrics exporter by a `__metrics__` command hook in a system package, see [system package](../system-package) From 8bc070c586d1feaf47d8c5d83fee29fbaad38c62 Mon Sep 17 00:00:00 2001 From: Jacobo de Vera Date: Fri, 1 May 2026 21:41:54 +0100 Subject: [PATCH 2/2] Add language to fenced code block in monitoring section Fixes markdownlint MD040 (fenced-code-language) reported by the gh-pages CI lint job. The new code block in the Monitoring section of the provider guide was missing a language tag; using `text` to match the existing convention elsewhere in the file. --- gh-pages/content/en/docs/overview/provider-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gh-pages/content/en/docs/overview/provider-guide.md b/gh-pages/content/en/docs/overview/provider-guide.md index 8ad06f23..262726b7 100644 --- a/gh-pages/content/en/docs/overview/provider-guide.md +++ b/gh-pages/content/en/docs/overview/provider-guide.md @@ -175,7 +175,7 @@ You will have different monitoring vectors for each partition, which will help y Command launcher implements a built-in graphite exporter. Every command invocation emits three independent metric lines over UDP (port 3341) under the prefix: -``` +```text devtools.cdt.[package name].[group].[name].[partition].[metric] ```