Expose the `addr` bit of prometheus' start_http_server() in the config

Open
#59 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
prometheus, python
Domain
observability-sre

Research direction

Start by searching for the metrics configuration and the prometheus.start_http_server call. Expose the server address separately from the port so a non-standard address can be configured, and verify that existing port-based configuration still works.

Written by the indexing model from the issue text.

Description

listen_port being passed on to prometheus.start_http_server makes it a whole listen_address, rather than just a port, making configs look confusing when you actually need not-just-a-port in there.

Perhaps it'd be worth to rename it, keeping the existing one as a deprecated alias for a while?

metrics in the configuration only exposes port as a configurable, making it tricky to listen on non-standard addresses if needed.

Dominant language
Python
Stars
249
Forks
84
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mautrix/python

All issues in mautrix/python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.