Draft
Conversation
Generates `docs/.../events.md` via `flagsmith docgen events` — the new subcommand shipped in Flagsmith/flagsmith-common#202. The catalogue lists every structured event the backend emits, the log level each is emitted at, its source locations, and the attributes it carries, so product and ops can curate the OTel allowlist without grepping the codebase. Wired into `make generate-docs` so the catalogue stays in sync with the source on the existing pre-commit hook — any PR that adds or changes an emit surfaces the diff in review. Points `flagsmith-common` at the PR branch for smoke testing; switch to a released version before merging. beep boop
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
github-actions
bot
added
api
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7286 +/- ##
=======================================
Coverage 98.37% 98.37%
=======================================
Files 1364 1364
Lines 51071 51071
=======================================
Hits 50239 50239
Misses 832 832 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Thanks for submitting a PR! Please check the boxes below:
docs/if required so people know about the feature.Changes
Contributes to Flagsmith/flagsmith-common#201. Depends on Flagsmith/flagsmith-common#202.
Adds a checked-in markdown catalogue of every structured event the backend emits, generated from the source on each pre-commit run. Product and ops can use it to curate the OTel allowlist without grepping the codebase, and any PR that adds, renames, or changes an emit will surface the diff in review — so event-level changes stop being invisible.
flagsmith docgen events, shipped in the linked flagsmith-common PR, writes todocs/docs/administration-and-security/platform-configuration/events.md. The existing pre-commit hook that runsmake -C api generate-docsnow keeps this file in sync alongside the metrics doc.Follow-ups, not in this PR: CODEOWNERS wiring so the catalogue page auto-requests a named stakeholder on changes, and GitHub-linked source locations.
This PR is draft because it points
flagsmith-commonat the PR branch for smoke testing. Before merging, flagsmith-common has to release a new version and this PR has to switch to it.How did you test this code?
Ran
make -C api generate-docslocally against the feat branch of flagsmith-common. The resultingevents.mdcaptures every domain called out in the linked issue — code_references, workflows, launch_darkly, feature_health, sentry_change_tracking — plus emits from app_analytics, dynamodb, gitlab, platform_hub, and segments.Review the generated
events.mdfor anything that reads oddly or is missing a known emit.