Upcoming Release Changes

[theguild-bot]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@envelop/prometheus@10.0.0

Major Changes

• #2217 7ac1d3c Thanks @EmrysMyrddin! - Adds a cache for metrics definition (Summary, Histogram and Counter).

  Fixes an issue preventing this plugin to be initialized multiple times, leading to metrics duplication error (https://github.com/ardatan/graphql-mesh/issues/6545).

  Behavior Breaking Change:

  Due to Prometheus client API limitations, a metric is only defined once for a given registry. This means that if the configuration of the metrics, it will be silently ignored on plugin re-initialization.

  This is to avoid potential loss of metrics data produced between the plugin re-initialization and the last pull by the prometheus agent.

  If you need to be sure metrics configuration is up to date after a plugin re-initialization, you can either:

  • restart the whole node process instead of just recreating a graphql server at runtime
  • clear the registry using registry.clear() before plugin re-initialization:

    function usePrometheusWithReset() {
      registry.clear()
      return usePrometheus({ ... })
    }

  • use a new registry for each plugin instance:

    function usePrometheusWithRegistry() {
      const registry = new Registry()
      return usePrometheus({
        registry,
        ...
      })
    }

  Keep in mind that this implies potential data loss in pull mode.

  API Breaking Change:

  To ensure metrics from being registered multiple times on the same registry, the signature of createHistogram, createSummary and createCounter have been changed to now include the registry as a mandatory parameter.

  If you were customizing metrics parameters, you will need to update the metric definitions

  usePrometheus({
    execute: createHistogram({
  +   registry: registry
      histogram: new Histogram({
        name: 'my_custom_name',
        help: 'HELP ME',
        labelNames: ['opText'] as const,
  -     registers: [registry],
      }),
      fillLabelsFn: () => {}
    }),
    requestCount: createCounter({
  +   registry: registry
      histogram: new Histogram({
        name: 'my_custom_name',
        help: 'HELP ME',
        labelNames: ['opText'] as const,
  -     registers: [registry],
      }),
      fillLabelsFn: () => {}
    }),
    requestSummary: createSummary({
  +   registry: registry
      histogram: new Histogram({
        name: 'my_custom_name',
        help: 'HELP ME',
        labelNames: ['opText'] as const,
  -     registers: [registry],
      }),
      fillLabelsFn: () => {}
    }),
  })

Patch Changes

• Updated dependencies [dc1222f]:
  • @envelop/core@5.0.1

@envelop/core@5.0.1

Patch Changes

• #2215 dc1222f Thanks @benjie! - feat: add useValidationRule() plugin

@envelop/opentelemetry@6.3.1

Patch Changes

• #2218 75b73fb Thanks @EmrysMyrddin! - dependencies updates:

  • Updated dependency @opentelemetry/api@^1.8.0 ↗︎ (from ^1.0.0, in dependencies)

• Updated dependencies [dc1222f]:

  • @envelop/core@5.0.1

[github-actions[bot]]

### 💻 Website Preview The latest changes are available as preview in: [https://e7c2d14d.envelop.pages.dev](https://e7c2d14d.envelop.pages.dev)

[github-actions[bot]]

🚀 Snapshot Release (rc)

The latest changes of this PR are available as rc on npm (based on the declared changesets):	Package	Version	Info
@envelop/opentelemetry	6.3.1-rc-20240506122222-88fbfd26	npm ↗︎ unpkg ↗︎

[theguild-bot]

✅ Benchmark Results

     ✓ no_errors
     ✓ expected_result

     checks.............................................: 100.00% ✓ 873756      ✗ 0     
     ✓ { mode:envelop-cache-and-no-internal-tracing }...: 100.00% ✓ 212754      ✗ 0     
     ✓ { mode:envelop-cache-jit }.......................: 100.00% ✓ 335222      ✗ 0     
     ✓ { mode:envelop-just-cache }......................: 100.00% ✓ 211594      ✗ 0     
     ✓ { mode:graphql-js }..............................: 100.00% ✓ 114186      ✗ 0     
     data_received......................................: 3.3 GB  28 MB/s
     data_sent..........................................: 190 MB  1.6 MB/s
     envelop_init.......................................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     envelop_total......................................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     event_loop_lag.....................................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-and-no-internal-tracing }...: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     graphql_context....................................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     graphql_execute....................................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     graphql_parse......................................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     graphql_validate...................................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     http_req_blocked...................................: avg=1.86µs  min=731ns    med=1.64µs max=9.64ms  p(90)=2.23µs  p(95)=2.41µs 
     http_req_connecting................................: avg=16ns    min=0s       med=0s     max=1.09ms  p(90)=0s      p(95)=0s     
     http_req_duration..................................: avg=2.46ms  min=158.84µs med=2.13ms max=84.65ms p(90)=4.48ms  p(95)=4.94ms 
       { expected_response:true }.......................: avg=2.46ms  min=158.84µs med=2.13ms max=84.65ms p(90)=4.48ms  p(95)=4.94ms 
     ✓ { mode:envelop-cache-and-no-internal-tracing }...: avg=2.55ms  min=367.92µs med=2.24ms max=21.16ms p(90)=4.43ms  p(95)=4.82ms 
     ✓ { mode:envelop-cache-jit }.......................: avg=1.5ms   min=158.84µs med=1.2ms  max=18.45ms p(90)=2.45ms  p(95)=2.61ms 
     ✓ { mode:envelop-just-cache }......................: avg=2.55ms  min=390.28µs med=2.23ms max=34.76ms p(90)=4.41ms  p(95)=4.82ms 
     ✓ { mode:graphql-js }..............................: avg=4.99ms  min=687.28µs med=4.21ms max=84.65ms p(90)=8.4ms   p(95)=9.09ms 
     http_req_failed....................................: 0.00%   ✓ 0           ✗ 436878
     http_req_receiving.................................: avg=31.25µs min=12.6µs   med=27.7µs max=18.04ms p(90)=41.52µs p(95)=46.69µs
     http_req_sending...................................: avg=11.93µs min=4.19µs   med=9.99µs max=12.04ms p(90)=13.99µs p(95)=17.73µs
     http_req_tls_handshaking...........................: avg=0s      min=0s       med=0s     max=0s      p(90)=0s      p(95)=0s     
     http_req_waiting...................................: avg=2.42ms  min=132.59µs med=2.08ms max=84.5ms  p(90)=4.43ms  p(95)=4.89ms 
     http_reqs..........................................: 436878  3640.507199/s
     iteration_duration.................................: avg=2.73ms  min=358.49µs med=2.38ms max=85.12ms p(90)=4.75ms  p(95)=5.24ms 
     iterations.........................................: 436878  3640.507199/s
     vus................................................: 10      min=10        max=10  
     vus_max............................................: 20      min=20        max=20