Skip to content

Fix JWT metrics discrepancy#7258

Merged
goto-bus-stop merged 2 commits intodevfrom
simon/jwt-metrics
Apr 16, 2025
Merged

Fix JWT metrics discrepancy#7258
goto-bus-stop merged 2 commits intodevfrom
simon/jwt-metrics

Conversation

@SimonSapin
Copy link
Contributor

This fixes the apollo.router.operations.authentication.jwt counter metric to behave as documented: emitted for every request that uses JWT, with the authentication.jwt.failed attribute set to true or false for failed or successful authentication.

Previously, it was only used for failed authentication.

The attribute-less and accidentally-differently-named apollo.router.operations.jwt counter was and is only emitted for successful authentication, but is deprecated now.


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

This fixes the `apollo.router.operations.authentication.jwt` counter metric to behave [as documented](https://www.apollographql.com/docs/graphos/routing/security/jwt#observability): emitted for every request that uses JWT, with the `authentication.jwt.failed` attribute set to true or false for failed or successful authentication.

Previously, it was only used for failed authentication.

The attribute-less and accidentally-differently-named `apollo.router.operations.jwt` counter was and is only emitted for successful authentication, but is deprecated now.
@SimonSapin SimonSapin requested a review from a team April 14, 2025 14:27
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Apr 14, 2025

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: 3a391d56577eed42b059427f

@github-actions

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Apr 14, 2025

CI performance tests

  • connectors-const - Connectors stress test that runs with a constant number of users
  • const - Basic stress test that runs with a constant number of users
  • demand-control-instrumented - A copy of the step test, but with demand control monitoring and metrics enabled
  • demand-control-uninstrumented - A copy of the step test, but with demand control monitoring enabled
  • enhanced-signature - Enhanced signature enabled
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_big_cap_high_rate_callback - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity using callback mode
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • extended-reference-mode - Extended reference mode enabled
  • large-request - Stress test with a 1 MB request payload
  • no-tracing - Basic stress test, no tracing
  • reload - Reload test over a long period of time at a constant rate of users
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • step-local-metrics - Field stats that are generated from the router rather than FTV1
  • step-with-prometheus - A copy of the step test with the Prometheus metrics exporter enabled
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • xxlarge-request - Stress test with 100 MB request payload

@SimonSapin SimonSapin requested a review from a team as a code owner April 14, 2025 14:29
@goto-bus-stop goto-bus-stop added the backport-1.x Backport this PR to 1.x label Apr 16, 2025
@goto-bus-stop goto-bus-stop merged commit f57b207 into dev Apr 16, 2025
15 of 16 checks passed
@goto-bus-stop goto-bus-stop deleted the simon/jwt-metrics branch April 16, 2025 14:02
SimonSapin added a commit that referenced this pull request Apr 16, 2025
(cherry picked from commit f57b207)

# Conflicts:
#	apollo-router/src/plugins/authentication/mod.rs
goto-bus-stop added a commit that referenced this pull request Apr 17, 2025
Co-authored-by: Renée Kooi <renee.kooi@apollographql.com>
@abernix abernix mentioned this pull request Apr 29, 2025
@abernix abernix mentioned this pull request May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-1.x Backport this PR to 1.x

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants