1738880 - Document file name requirement for metrics.yaml/pings.yaml due to probe-scraper

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, defect, P1)

Description

[Jan-Erik Rediger [:janerik]]

On the metrics yaml doc page we document that the metric definition file can have any name.
While the Glean tooling locally (glean_parser) supports that, probe-scraper currently requires fixed names.

We should adjust the docs accordingly to point this out.

Comment 1

[William Lachance (:wlach)]

Feels a bit unfortunate to have to talk about probe scraper specifics in the docs, but this is a gotcha worth noting.

Comment 2

[Michael Droettboom [:mdroettboom]]

What would it take to remove this restriction in probe_scraper. From the code, it just looks like an arbitrary sanity check, not anything that's required.

Comment 3

[Michael Droettboom [:mdroettboom]]

Filed https://github.com/mozilla/probe-scraper/issues/364 to explore whether we could just remove the restriction from probe-scraper instead.

Comment 4

[Jan-Erik Rediger [:janerik]]

Attachment: pr 577: Bug 1738880 - Alllow any filename ending in .yaml for metrics and ping files

Comment 5

[Jan-Erik Rediger [:janerik]]

badboy merged PR #577: "Bug 1738880 - Alllow any filename ending in .yaml for metrics and ping files" in 8016393.