LumeWeb
/
tusd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add information about metrics endpoint to README

This commit is contained in:
Marius 2018-11-19 17:28:11 +00:00 committed by GitHub
parent 27c9c4aab5
commit d81a8a088d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -136,6 +136,12 @@ Usage of tusd:
Print tusd version information 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 ## Using tusd manually
Besides from running tusd using the provided binary, you can embed it into Besides from running tusd using the provided binary, you can embed it into