Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate histogram metrics to {f,u}64_histogram! #6356

Merged
merged 11 commits into from
Dec 20, 2024

Conversation

goto-bus-stop
Copy link
Member

@goto-bus-stop goto-bus-stop commented Nov 28, 2024

This is part 2 of... 4 or 5? of a series of work to move over to our new telemetry macros, and a follow-up to #6350.

We have both a u64_histogram! and a f64_histogram! macro, but we don't have any legacy metrics using u64. We do have one that could: apollo.router.operations.batching.size.

The tracing::info!(histogram.) syntax continues to be supported in the 1.x branch of the router.


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.

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Nov 28, 2024

✅ Docs Preview Ready

No new or changed pages found.

@router-perf
Copy link

router-perf bot commented Nov 28, 2024

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

Comment on lines 200 to 205
f64_histogram!(
"apollo.router.operations.batching.size",
"Number of queries contained within each query batch",
result.len() as f64,
mode = BatchingMode::BatchHttpLink.to_string() // Only supported mode right now
);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we safely change this to u64_histogram!, or would that be a breaking change?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it breaks anything. @BrynCooke do you know ?

@goto-bus-stop goto-bus-stop force-pushed the renee/ROUTER-297-histograms branch from 6294bac to 8b333e5 Compare December 3, 2024 14:59
Base automatically changed from renee/ROUTER-297-monotonic-counters to dev December 3, 2024 15:12
@goto-bus-stop goto-bus-stop force-pushed the renee/ROUTER-297-histograms branch from 8b333e5 to eed5480 Compare December 3, 2024 15:16

This comment has been minimized.

@goto-bus-stop goto-bus-stop marked this pull request as ready for review December 3, 2024 15:34
@goto-bus-stop goto-bus-stop requested review from a team as code owners December 3, 2024 15:34
Comment on lines 200 to 205
f64_histogram!(
"apollo.router.operations.batching.size",
"Number of queries contained within each query batch",
result.len() as f64,
mode = BatchingMode::BatchHttpLink.to_string() // Only supported mode right now
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it breaks anything. @BrynCooke do you know ?

apollo-router/src/uplink/mod.rs Outdated Show resolved Hide resolved
@goto-bus-stop goto-bus-stop requested a review from bnjjj December 20, 2024 13:46
@goto-bus-stop goto-bus-stop merged commit d01fa60 into dev Dec 20, 2024
12 of 13 checks passed
@goto-bus-stop goto-bus-stop deleted the renee/ROUTER-297-histograms branch December 20, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants