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

docs(telemetry): add docs about standard instruments for subgraph #5422

Merged
merged 6 commits into from
Jun 13, 2024

Conversation

bnjjj
Copy link
Contributor

@bnjjj bnjjj commented Jun 12, 2024

Added documentations about standard instruments available at the subgraph service:

  • http.client.request.body.size - A histogram of request body sizes for requests handled by subgraphs.
  • http.client.request.duration - A histogram of request durations for requests handled by subgraphs.
  • http.client.response.body.size - A histogram of response body sizes for requests handled by subgraphs.

These instruments are configurable in router.yaml:

telemetry:
  instrumentation:
    instruments:
      subgraph:
        http.client.request.body.size: true # (default false)
        http.client.request.duration: true # (default false)
        http.client.response.body.size: true # (default false)

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.

Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
@bnjjj bnjjj requested a review from a team as a code owner June 12, 2024 13:52
@bnjjj bnjjj self-assigned this Jun 12, 2024
@bnjjj bnjjj requested review from BrynCooke and removed request for a team June 12, 2024 13:52

This comment has been minimized.

@bnjjj bnjjj requested review from abernix and a team June 12, 2024 13:52
@router-perf
Copy link

router-perf bot commented Jun 12, 2024

CI performance tests

  • step - Basic stress test that steps up the number of users over time
  • reload - Reload test over a long period of time at a constant rate of users
  • step-with-prometheus - A copy of the step test with the Prometheus metrics exporter enabled
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • no-tracing - Basic stress test, no tracing
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • 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
  • xlarge-request - Stress test with 10 MB request payload
  • const - Basic stress test that runs with a constant number of users
  • 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
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • xxlarge-request - Stress test with 100 MB request payload
  • demand-control-uninstrumented - A copy of the step test, but with demand control monitoring enabled
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • large-request - Stress test with a 1 MB request payload
  • demand-control-instrumented - A copy of the step test, but with demand control monitoring and metrics enabled

Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
@bnjjj bnjjj enabled auto-merge (squash) June 12, 2024 13:58
Copy link
Member

@abernix abernix left a comment

Choose a reason for hiding this comment

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

Drive by comment. This is a well-prepared PR! I left one comment. It would be good for @BrynCooke and @Meschreiber to take a looksie beyond that.

.changesets/docs_bnjjj_docs_standard_instr.md Outdated Show resolved Hide resolved
Co-authored-by: Jesse Rosenberger <git@jro.cc>
Copy link
Contributor

@Meschreiber Meschreiber left a comment

Choose a reason for hiding this comment

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

Left some preposition nits, otherwise LGTM!

bnjjj and others added 2 commits June 13, 2024 10:05
Co-authored-by: Maria Elisabeth Schreiber <maria.schreiber@apollographql.com>
…#5319

Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
@bnjjj bnjjj disabled auto-merge June 13, 2024 08:58
@bnjjj bnjjj requested a review from abernix June 13, 2024 08:58
@bnjjj bnjjj enabled auto-merge (squash) June 13, 2024 08:58
@bnjjj bnjjj merged commit 2fec762 into dev Jun 13, 2024
12 of 14 checks passed
@bnjjj bnjjj deleted the bnjjj/docs_standard_instr branch June 13, 2024 09:17
@lrlna lrlna mentioned this pull request Jun 18, 2024
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