dru5k1/pict-rs
1
0
Fork 0
forked from asonix/pict-rs
Code Pull requests Activity

Add Prometheus, Hashes Endpoint, and Delete Endpoint documentation

Browse source
This commit is contained in:
asonix 2023-12-08 23:43:44 -06:00
parent 3978b6dd6d
commit b240ec9cb5
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
releases/0.5.0.md
View file

@ -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