Skip analytics for configured ignore header - #1
Closed
Gutts-n wants to merge 2 commits into
Closed
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Collaborator
Author
|
Closing in favor of #2 - now that I have push access to this repo, opened the same branch directly against it instead of from the fork. |
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
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.
What changed
A request carrying the configured ignore header/value now skips analytics
entirely - not logged with a distinguishing field, just never recorded.
New config (module-level, read from env at import like the existing
CKANEXT_ANALYTICS_SERVICE):CKANEXT_ANALYTICS_IGNORE_HEADER- header name to check (e.g.Request-Source)CKANEXT_ANALYTICS_IGNORE_VALUES- comma-separated values that triggerthe skip (e.g.
data-explorer), matched case-insensitivelyBoth empty (the default) disables the check - every tracked request is
logged, same as before this PR.
Why
Part of the NESO API-usage-metrics work (neso-nextgen-shared#152). Data
Explorer sends
Request-Source: data-exploreron its calls(neso-nextgen-shared#145). Original version of this PR captured the header
into the event and left filtering to the BigQuery/dashboard layer -
@sagargg pointed out on the matching datastore
PR
that's the wrong layer: better to not log this traffic at all than log it
and filter downstream. Reworked accordingly, same change applied to
datopian/datastore#19 (the Datastore API's own analytics middleware).
Verified
pytest ckanext/analytics/tests/test_event.py- 48 passed (ran locallywith a minimal flask+pytest venv,
--ckan-iniaddopts overridden sinceno CKAN environment was available locally).
still records, header present with a non-matching value still records,
check disabled by default (unconfigured) never skips.
Not verified: end-to-end against a live CKAN + Loki + BigQuery pipeline.