prometheus / prometheus/client_python

OpenMetrics version header out-of-date / Support latest OpenMetrics format

Open
#901 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4.4k
Forks
876
Avg merge
8d 4h
Merged PRs (30d)
1

Description

Hi,
Looking at the Content-Type header

CONTENT_TYPE_LATEST = 'application/openmetrics-text; version=0.0.1; charset=utf-8'

The version=0.0.1 should be bumped. Looking at the spec:

The content type MUST be: application/openmetrics-text; version=1.0.0; charset=utf-8

I'm afraid I haven't been able to find any clear doc detailing changes between 0.0.1 and 1.0.0 so I don't know if it's as simple as just updating that line.

FWIW I've seen other places encountering the same trouble with the MUST restriction: prometheus/prometheus#9430, prometheus/client_java#702

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.

Research direction

Start in prometheus_client/openmetrics/exposition.py at CONTENT_TYPE_LATEST and compare its header with the OpenMetrics specification linked in the issue. Determine whether the 0.0.1-to-1.0.0 change requires more than the header update; done means the client supports the latest required format without contradicting the referenced compatibility concerns.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
observability
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.