From b240ec9cb5e20edf8b4fe676d84d3d3dc9a67c60 Mon Sep 17 00:00:00 2001 From: asonix Date: Fri, 8 Dec 2023 23:43:44 -0600 Subject: [PATCH] Add Prometheus, Hashes Endpoint, and Delete Endpoint documentation --- releases/0.5.0.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/releases/0.5.0.md b/releases/0.5.0.md index f09e596..7a6b5ea 100644 --- a/releases/0.5.0.md +++ b/releases/0.5.0.md @@ -411,12 +411,35 @@ For configuration information, see the example ### Prometheus Metrics +pict-rs 0.5 now optionally exposes a scrape endpoint for Prometheus metrics. This includes various +timings for requests, processing, and counts for pict-rs workings. It could be useful for admins to +help monitor the health of pict-rs as it runs. + +For configuration information, see the example +[pict-rs.toml](https://git.asonix.dog/asonix/pict-rs/src/branch/main/pict-rs.toml). + ### Internal Hashes Endpoint +pict-rs 0.5 offers a new internal endpoint at `/internal/hashes` which returns a paginated list of +all uploaded files, sorted from most recently uploaded to least recently uploaded. This endpoint +supports querying by timestamp in rfc3339 format in order to quickly jump deep into the list. The +number of returned results per page is also configurable. + +For more information about this API, see the +[pict-rs readme](https://git.asonix.dog/asonix/pict-rs#api). + ### Internal Delete Endpoint +pict-rs 0.5 offers a new internal endpoint for deleting aliases as `/internal/delete`. This is +distinct from the purge endpoint in that it doesn't purge a whole image with all it's aliases, +instead it simply deletes the provided alias and nothing more. It can be seen as an admin tool for +deleting an upload on behalf of a user. + +For more information about this API, see the +[pict-rs readme](https://git.asonix.dog/asonix/pict-rs#api). + ### Error Codes