Skip to content

docs: instrumentation examples#6487

Merged
shorgi merged 12 commits intodevfrom
eh/DOC-246/tlm-usecases
Jan 10, 2025
Merged

docs: instrumentation examples#6487
shorgi merged 12 commits intodevfrom
eh/DOC-246/tlm-usecases

Conversation

@shorgi
Copy link
Contributor

@shorgi shorgi commented Dec 18, 2024

Add example configurations for common use cases of selectors and conditions

Fast follows:

  1. Add examples to other router telemetry reference pages
  2. Integrate or move router telemetry reference content into Routing section

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Dec 18, 2024

✅ Docs Preview Ready

No new or changed pages found.

@github-actions

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Dec 18, 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

@shorgi
Copy link
Contributor Author

shorgi commented Dec 18, 2024

!docs preview main

@shorgi
Copy link
Contributor Author

shorgi commented Dec 19, 2024

!docs preview main

@shorgi shorgi changed the title [WIP] docs: instrumentation examples docs: instrumentation examples Dec 20, 2024
@shorgi
Copy link
Contributor Author

shorgi commented Dec 20, 2024

!docs preview main

@shorgi shorgi marked this pull request as ready for review December 20, 2024 00:09
@shorgi shorgi requested a review from a team as a code owner December 20, 2024 00:09
@shorgi shorgi requested a review from BrynCooke December 20, 2024 00:09

### Setting JSON paths

Configuring selectors with JSON paths, such as supergraph `response_data` and `response_errors`:
Copy link
Contributor

Choose a reason for hiding this comment

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

This will create a high cardinality metric:

A better example is this:

telemetry:
  exporters:
    metrics:
      prometheus:
        enabled: true
  instrumentation:
    instruments:
      supergraph:
        my.request.on_graphql_error:
          value: event_unit
          type: counter
          unit: error
          description: my description
          condition:
            exists:
              response_errors: "$.[0].extensions.code"
          attributes:
            response_errors:
              response_errors: "$.[0].extensions.code"

@shorgi shorgi requested a review from BrynCooke January 7, 2025 21:44
@shorgi shorgi merged commit 553083e into dev Jan 10, 2025
@shorgi shorgi deleted the eh/DOC-246/tlm-usecases branch January 10, 2025 20:15
mergify bot added a commit to BrynCooke/router that referenced this pull request Jan 15, 2025
* Cleanup post router-bridge removal (apollographql#6512)

* docs: instrumentation examples (apollographql#6487)

Co-authored-by: Bryn Cooke <BrynCooke@gmail.com>

* chore(deps): Update dev dependencies with `npm audit fix` (apollographql#6544)

* Needs backporting

---------

Co-authored-by: Simon Sapin <simon@apollographql.com>
Co-authored-by: Edward Huang <edward.huang@apollographql.com>
Co-authored-by: Jesse Rosenberger <git@jro.cc>
Co-authored-by: bryn <bryn@apollographql.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
mergify bot pushed a commit to BrynCooke/router that referenced this pull request Jan 22, 2025
* Cleanup post router-bridge removal (apollographql#6512)

* docs: instrumentation examples (apollographql#6487)

Co-authored-by: Bryn Cooke <BrynCooke@gmail.com>

* chore(deps): Update dev dependencies with `npm audit fix` (apollographql#6544)

* Needs backporting

* Needs backporting

---------

Co-authored-by: Simon Sapin <simon@apollographql.com>
Co-authored-by: Edward Huang <edward.huang@apollographql.com>
Co-authored-by: Jesse Rosenberger <git@jro.cc>
Co-authored-by: bryn <bryn@apollographql.com>
BrynCooke added a commit to BrynCooke/router that referenced this pull request Jan 22, 2025
* Cleanup post router-bridge removal (apollographql#6512)

* docs: instrumentation examples (apollographql#6487)

Co-authored-by: Bryn Cooke <BrynCooke@gmail.com>

* chore(deps): Update dev dependencies with `npm audit fix` (apollographql#6544)

* Needs backporting

* Needs backporting

---------

Co-authored-by: Simon Sapin <simon@apollographql.com>
Co-authored-by: Edward Huang <edward.huang@apollographql.com>
Co-authored-by: Jesse Rosenberger <git@jro.cc>
Co-authored-by: bryn <bryn@apollographql.com>
(cherry picked from commit 99f5b36)
@abernix abernix mentioned this pull request Feb 5, 2025
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