Skip to content

Commit

Permalink
Add information about metrics endpoint to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Acconut authored Nov 19, 2018
1 parent 27c9c4a commit d81a8a0
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d81a8a0

Please sign in to comment.