From d81a8a088d688f971a8b5d78d15358930fa6fd3b Mon Sep 17 00:00:00 2001 From: Marius Date: Mon, 19 Nov 2018 17:28:11 +0000 Subject: [PATCH] Add information about metrics endpoint to README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b2baa77..4f7eaf8 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,12 @@ Usage of tusd: Print tusd version information ``` +## Monitoring tusd + +tusd exposes metrics at the `/metrics` endpoint ([example](https://master.tus.io/metrics)) in the [Prometheus Text Format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format). This allows you to hook up Prometheus or any other compatible service to your tusd instance and let it monitor tusd. Alternatively, there are many [parsers and client libraries](https://prometheus.io/docs/instrumenting/clientlibs/) available for consuming the metrics format directly. + +The endpoint contains details about Go's internals, general HTTP numbers and details about tus uploads and tus-specific errors. It can be completely disabled using the `-expose-metrics false` flag and it's path can be changed using the `-metrics-path /my/numbers` flag. + ## Using tusd manually Besides from running tusd using the provided binary, you can embed it into