From 718e40f97c27f3c74ab9dc5f4c5aefad19ffe60e Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Fri, 4 Aug 2023 16:41:50 +0300 Subject: [PATCH] docs: document -metrics flag in command line reference Document the -metrics command line flag in the command line reference of nfd-master and nfd-worker. --- docs/reference/master-commandline-reference.md | 14 ++++++++++++++ docs/reference/worker-commandline-reference.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/docs/reference/master-commandline-reference.md b/docs/reference/master-commandline-reference.md index c83b2d61be..381f3ee7f8 100644 --- a/docs/reference/master-commandline-reference.md +++ b/docs/reference/master-commandline-reference.md @@ -48,6 +48,20 @@ Example: nfd-master -port=443 ``` +### -metrics + +The `-metrics` flag specifies the port on which to expose +[Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the +metrics server on nfd-master. + +Default: 8081 + +Example: + +```bash +nfd-master -metrics=12345 +``` + ### -instance The `-instance` flag makes it possible to run multiple NFD deployments in diff --git a/docs/reference/worker-commandline-reference.md b/docs/reference/worker-commandline-reference.md index e88f78f4a1..cbccf2ce9d 100644 --- a/docs/reference/worker-commandline-reference.md +++ b/docs/reference/worker-commandline-reference.md @@ -212,6 +212,20 @@ Example: nfd-worker -enable-nodefeature-api ``` +### -metrics + +The `-metrics` flag specifies the port on which to expose +[Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the +metrics server on nfd-worker. + +Default: 8081 + +Example: + +```bash +nfd-worker -metrics=12345 +``` + ### -no-publish The `-no-publish` flag disables all communication with the nfd-master and the