Metrics

A metrics API endpoint can be found here /api/metrics. It follows Prometheus/OpenTelemetry format

The endpoint is disabled by default, it needs to be activated in the administration page, in the configuration panel :

⚠️ Once activated the endpoint is publicly available, an authentication process will be implemented soon

For now it provides basic statistics about your Koillection instance usage. Here's an exemple :

# HELP user number of registered users
# TYPE user counter
user_total 2
# HELP collection number of created collections
# TYPE collection counter
collection_total 2
collection_total{user="Benjamin"} 1
collection_total{user="Alicia"} 1
# HELP item number of created items
# TYPE item counter
item_total 3
item_total{user="Benjamin"} 3
item_total{user="Alicia"} 0
# HELP datum number of created data
# TYPE datum counter
datum_total 31
datum_total{user="Benjamin"} 30
datum_total{user="Alicia"} 1
# HELP tag number of created tags
# TYPE tag counter
tag_total 0
tag_total{user="Benjamin"} 0
tag_total{user="Alicia"} 0
# HELP tag_category number of created tag categories
# TYPE tag_category counter
tag_category_total 0
tag_category_total{user="Benjamin"} 0
tag_category_total{user="Alicia"} 0
# HELP wishlist number of created wishlists
# TYPE wishlist counter
wishlist_total 0
wishlist_total{user="Benjamin"} 0
wishlist_total{user="Alicia"} 0
# HELP wish number of created wishes
# TYPE wish counter
wish_total 0
wish_total{user="Benjamin"} 0
wish_total{user="Alicia"} 0
# HELP album number of created albums
# TYPE album counter
album_total 0
album_total{user="Benjamin"} 0
album_total{user="Alicia"} 0
# HELP photo number of created photos
# TYPE photo counter
photo_total 0
photo_total{user="Benjamin"} 0
photo_total{user="Alicia"} 0
# HELP template number of created templates
# TYPE template counter
template_total 1
template_total{user="Benjamin"} 1
template_total{user="Alicia"} 0
# HELP scraper number of created scrapers
# TYPE scraper counter
scraper_total 0
scraper_total{user="Benjamin"} 0
scraper_total{user="Alicia"} 0
# HELP used_disk_space_bytes used disk space by uploads (images, videos, files)
# UNIT used_disk_space_bytes bytes
# TYPE used_disk_space_bytes counter
used_disk_space_bytes_total 561152
used_disk_space_bytes_total{user="Benjamin"} 8192
used_disk_space_bytes_total{user="Alicia"} 8192
# HELP available_disk_space_bytes available disk space for uploads (images, videos, files)
# UNIT available_disk_space_bytes bytes
# TYPE available_disk_space_bytes counter
available_disk_space_bytes_total{user="Benjamin"} 536870912
available_disk_space_bytes_total{user="Alicia"} 536870912