MPP-4012 - feat(glean): log API access as Glean server event #5500
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
groovecoder
force-pushed
the
add-api-count-MPP-4012
branch
2 times, most recently
from
742c483 to
a2534c3
Compare
Introduce a new `api.accessed` Glean event to capture accesses to Relay API endpoints. This includes the HTTP method and endpoint path, and logs events for all `/api/` prefixed routes via a new middleware component. - Added `record_api_accessed()` to `EventsServerEventLogger` - Extended `RelayGleanLogger` with `log_api_accessed()` for easier integration - Registered `GleanApiAccessMiddleware` to log access for all API routes - Added corresponding unit test for API access logging - Updated `relay-server-metrics.yaml` to define the `api.accessed` metric - Updated notification email for several existing metrics to use [email protected]
groovecoder
force-pushed
the
add-api-count-MPP-4012
branch
from
a2534c3 to
e14c6c3
Compare
groovecoder
commented
Apr 11, 2025
Comment on lines
+117
to
+119
| "endpoint": str(endpoint), | ||
| "method": str(method), | ||
| "fxa_id": str(fxa_id), |
There was a problem hiding this comment.
I'm not sure why glean_parser wrapped these argument values in str() calls this time, but not in other places?
…ents Add metric definitions for `text_received` and `call_received` to the Glean YAML. Log the events with `fxa_id` if metrics are enabled for the user.
groovecoder
changed the title
jwhitlock
approved these changes
Apr 14, 2025
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
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.
TODO
- https://bugzilla.mozilla.org/show_bug.cgi?id=1882565#c16
Introduce a new
api.accessedGlean event to capture accesses to Relay API endpoints. This includes the HTTP method and endpoint path, and logs events for all/api/prefixed routes via a new middleware component.record_api_accessed()toEventsServerEventLoggerRelayGleanLoggerwithlog_api_accessed()for easier integrationGleanApiAccessMiddlewareto log access for all API routesrelay-server-metrics.yamlto define theapi.accessedmetricThis PR fixes #MPP-4012 and #MPP-4014.
How to test:
pytestshould test that glean logging is working- https://app.circleci.com/pipelines/github/mozilla/fx-private-relay/21940/workflows/94f38d67-3f2c-4c0a-baac-19fb47402351/jobs/251876
- https://github.com/mozilla/fx-private-relay/actions/runs/14453273732/job/40530682690?pr=5500
l10n changes have been submitted to the l10n repository, if any.I've added or updated relevant docs in the docs/ directory.All UI revisions follow the coding standards, and use Protocol / Nebula colors where applicable (see/frontend/src/styles/colors.scss).