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

Adds new metrics for some apollo specific env variables #4364

Merged
merged 5 commits into from
Dec 13, 2023

Conversation

BrynCooke
Copy link
Contributor

@BrynCooke BrynCooke commented Dec 12, 2023

Adds some metrics for some specific apollo env variables to show if they are set or not.
Uses the new metrics macros rather than the hash map to exercise more of the stack.
As a bonus, the thread that was used to continuously update the gauges is gone.

I had to make some changes to the asserting to allow asserting of all metrics rather than just specific ones hence all the snapshot changes. On the plus side they look better now.

Fixes #4290


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.

Copy link
Contributor

@BrynCooke, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

@router-perf
Copy link

router-perf bot commented Dec 12, 2023

CI performance tests

  • 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_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • large-request - Stress test with a 1 MB request payload
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • reload - Reload test over a long period of time at a constant rate of users
  • no-graphos - Basic stress test, no GraphOS.
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • xxlarge-request - Stress test with 100 MB request payload
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • const - Basic stress test that runs with a constant number of users
  • 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

Use the new metrics macros rather than the hash map to exercise more of the stack.
As a bonus, the thread that was used to continuously update the gauges is gone.
Fixes #4290
@BrynCooke BrynCooke force-pushed the bryn/env-observability branch from 4b769f6 to a87b283 Compare December 12, 2023 13:31
@BrynCooke BrynCooke requested a review from bnjjj December 12, 2023 13:38
Copy link
Contributor

@o0Ignition0o o0Ignition0o left a comment

Choose a reason for hiding this comment

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

Not sure I've understood everything, but lgtm overall.

apollo-router/src/configuration/metrics.rs Outdated Show resolved Hide resolved
data.meter
.u64_observable_gauge(metric_name)
.with_callback(move |observer| {
observer.observe(value, &attributes);
Copy link
Contributor

Choose a reason for hiding this comment

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

it s a pity oserve doesn't take an iterator :(

apollo-router/src/configuration/metrics.rs Outdated Show resolved Hide resolved
bryn added 2 commits December 13, 2023 11:11
@BrynCooke BrynCooke merged commit 4fadf3b into dev Dec 13, 2023
2 checks passed
@BrynCooke BrynCooke deleted the bryn/env-observability branch December 13, 2023 11:33
BrynCooke pushed a commit that referenced this pull request Feb 22, 2024
Metric attributes had an extra trailing dot that was introduced in #4364.

This PR strips off the extra dot that was introduced.

Fixes #4689
BrynCooke added a commit that referenced this pull request Feb 22, 2024
Internal config metric attributes had an extra trailing dot that was
introduced in #4364.

This PR strips off the extra dot that was introduced.

Fixes #4689

<!-- start metadata -->
---

**Checklist**

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

- [ ] Changes are compatible[^1]
- [ ] Documentation[^2] completed
- [ ] Performance impact assessed and acceptable
- Tests added and passing[^3]
    - [ ] Unit Tests
    - [ ] Integration Tests
    - [ ] Manual Tests

**Exceptions**

*Note any exceptions here*

**Notes**

[^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.

Co-authored-by: bryn <bryn@apollographql.com>
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.

Offline license - Operation metrics
2 participants