feat: Generate metrics documentation #65
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
khvn26
force-pushed
the
feat/docgen-metrics
branch
from
d5b8a67 to
7c427d1
Compare
…terprise_mode` pytest markers
emyller
reviewed
Apr 29, 2025
|
|
||
| Counter. | ||
|
|
||
| Total number of tests run by pytest |
emyller
reviewed
Apr 29, 2025
emyller
approved these changes
Apr 29, 2025
matthewelwell
requested changes
Apr 29, 2025
| def __call__(self, name: str = "") -> "Snapshot": ... | ||
|
|
||
|
|
||
| class Snapshot: |
|
|
||
|
|
||
| @pytest.fixture | ||
| def snapshot(request: pytest.FixtureRequest) -> SnapshotFixture: |
matthewelwell
approved these changes
Apr 30, 2025
This was referenced Jul 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the
flagsmith docgen metricscommand. The output is valid Markdown describing all Prometheus metrics exported by the application.Besides that, several improvements and fixes are introduced:
prometheus_multiproc_diris only used with tests where it's needed (currently just the one that tests the/metricsendpoint).snapshotfixture added totest_toolsto enable snapshot testing. Snapshots are a convenient way to implement tests where outputs are asserted against reference values.pytest --snapshot-updateoption refreshes the snapshots automatically for the tests being run, and xfails the affected tests.clear_lru_cachesfixture is tuned to expect dirty caches before the test starts.