From 2b16e64b33c52591fce73bd3367ca48fa0b1ee19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samuel=20Jir=C3=A9nius?= Date: Wed, 3 Jul 2024 10:38:52 +0200 Subject: [PATCH] GH-255: Added metrics config information to README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index bdecbcf..6f14cd8 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,7 @@ resgate [options] | -r, --reqtimeout <seconds> | Timeout duration for NATS requests | `3000` | -u, --headauth <method> | Resource method for header authentication | | -t, --wsheadauth <method> | Resource method for WebSocket header authentication | +| -m, --metricsport <port> | HTTP port for OpenMetrics connections | `0` (disabled) |     --apiencoding <type> | Encoding for web resources: json, jsonflat | `json` |     --putmethod <methodName> | Call method name mapped to HTTP PUT requests | |     --deletemethod <methodName> | Call method name mapped to HTTP DELETE requests | @@ -148,6 +149,12 @@ Configuration is a JSON encoded file. If no config file is found at the given pa // If the port value is missing or 0, standard http(s) port is used. "port": 8080, + // Metrics port for the OpenMetrics http server to listen on. + // If the port value is missing or 0, metrics are disabled. + // Must be different from the configured api port. + // Metrics are available at the path: /metrics + "metricsPort": 0, + // Path for accessing the RES API WebSocket. "wsPath": "/",