[PR #1957] [MERGED] Add doc updates for prometheus metrics #1937

New issue

Closed

opened 2026-03-02 11:59:50 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 11:59:50 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/karakeep-app/karakeep/pull/1957
Author: @claytono
Created: 9/16/2025
Status: ✅ Merged
Merged: 9/28/2025
Merged by: @MohamedBassem

Base: main ← Head: prom-docs

📝 Commits (1)

379f151 Add doc updates for prometheus metrics

📊 Changes

1 file changed (+2 additions, -1 deletions)

View changed files

📝 docs/docs/03-configuration.md (+2 -1)

📄 Description

This adds documentation for WORKERS_HOST and clarifies token requirements for PROMETHEUS_AUTH_TOKEN.

When setting up the prometheus metrics, I ran into a problem where the token I chose originally had special characters and would fail mysteriously with 400 Bad Request. This was reported in https://github.com/karakeep-app/karakeep/issues/1915, but not documented at that time. In addition, if you are using WORKERS_PORT to scrape metrics inside of a container, it won't be reachable since the default is 127.0.0.1. I had to override this undocumented config item to 0.0.0.0 so Prometheus could reach it.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/karakeep-app/karakeep/pull/1957 **Author:** [@claytono](https://github.com/claytono) **Created:** 9/16/2025 **Status:** ✅ Merged **Merged:** 9/28/2025 **Merged by:** [@MohamedBassem](https://github.com/MohamedBassem) **Base:** `main` ← **Head:** `prom-docs` --- ### 📝 Commits (1) - [`379f151`](https://github.com/karakeep-app/karakeep/commit/379f151e9a967f779f0cb6beccf6f5103a43c48b) Add doc updates for prometheus metrics ### 📊 Changes **1 file changed** (+2 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/docs/03-configuration.md` (+2 -1) </details> ### 📄 Description This adds documentation for `WORKERS_HOST` and clarifies token requirements for `PROMETHEUS_AUTH_TOKEN`. When setting up the prometheus metrics, I ran into a problem where the token I chose originally had special characters and would fail mysteriously with `400 Bad Request`. This was reported in https://github.com/karakeep-app/karakeep/issues/1915, but not documented at that time. In addition, if you are using `WORKERS_PORT` to scrape metrics inside of a container, it won't be reachable since the default is `127.0.0.1`. I had to override this undocumented config item to `0.0.0.0` so Prometheus could reach it. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem

2026-03-02 11:59:50 +03:00

closed this issue
added the
pull-request
label

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/karakeep#1937

No description provided.

Rows
Columns