docs icon indicating copy to clipboard operation
docs copied to clipboard

docs: properly document prometheus protocols

Open ywwg opened this issue 1 year ago • 3 comments

name encoding schemes are only really documented in code. we should have a reference.

  • [ ] new Protocol doc under Concepts
  • [ ] update https://github.com/prometheus/docs/blob/main/content/docs/instrumenting/exposition_formats.md

ywwg avatar Nov 25 '24 16:11 ywwg

changed the name of the bug to indicate its wider scope

ywwg avatar Jan 28 '25 14:01 ywwg

Maybe the "Specifications" section would be more appropriate than "Concepts"? The former is where the remote-write protocols are formally specified.

(In different news, I think we should reorganize the sections. Among others, I think it would make more sense to merge concepts and specifications, cf. https://github.com/prometheus/docs/issues/2547 .)

beorn7 avatar Jan 28 '25 16:01 beorn7

In other different news, this issue might better live in prometheus/docs.

beorn7 avatar Jan 28 '25 16:01 beorn7