Skip to content

Commit

Permalink
Upcoming Release Changes (#3407)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
theguild-bot and github-actions[bot] committed Aug 14, 2024
1 parent 88393b3 commit d2e4557
Show file tree
Hide file tree
Showing 6 changed files with 94 additions and 86 deletions.

This file was deleted.

53 changes: 0 additions & 53 deletions .changeset/chilly-ladybugs-smoke.md

This file was deleted.

7 changes: 0 additions & 7 deletions .changeset/clever-doors-listen.md

This file was deleted.

18 changes: 0 additions & 18 deletions .changeset/cuddly-needles-cry.md

This file was deleted.

93 changes: 93 additions & 0 deletions packages/plugins/prometheus/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,98 @@
# @graphql-yoga/plugin-prometheus

## 6.0.0

### Major Changes

- [#3391](https://github.com/dotansimha/graphql-yoga/pull/3391)
[`0788d8a`](https://github.com/dotansimha/graphql-yoga/commit/0788d8ab90642a87af0623cfacfdb85aa9f38500)
Thanks [@EmrysMyrddin](https://github.com/EmrysMyrddin)! - **Breaking Change:** Rename all metrics
options to their actual metric name to avoid confusion.

All metric options have been moved under a mandatory `metrics` key, and the name of each options
have been renamed to match the default metric name.

The plugin option argument is also now mandatory.

```diff
export const serveConfig = defineConfig({
plugins: pluginCtx => [
usePrometheus({
...pluginCtx,

// Enable all available metrics
- http: true
- requestSummary: true,
- parse: true,
- validate: true,
- contextBuilding: true,
- execute: true,
- subscribe: true,
- errors: true,
- deprecatedFields: true,
- requestTotalDuration: true,
- schemaChangeCount: true,

// Warning: enabling resolvers level metrics will introduce significant overhead
- resolvers: true,
+ metrics: {
+ graphql_yoga_http_duration: true,
+ graphql_envelop_request_time_summary: true,
+ graphql_envelop_phase_parse: true,
+ graphql_envelop_phase_validate: true,
+ graphql_envelop_phase_context: true,
+ graphql_envelop_phase_execute: true,
+ graphql_envelop_phase_subscribe: true,
+ graphql_envelop_error_result: true,
+ graphql_envelop_deprecated_field: true,
+ graphql_envelop_request_duration: true,
+ graphql_envelop_schema_change: true,

// Warning: enabling resolvers level metrics will introduce significant overhead
+ graphql_envelop_execute_resolver: true,
+ }
})
]
})
```

- [#3408](https://github.com/dotansimha/graphql-yoga/pull/3408)
[`88393b3`](https://github.com/dotansimha/graphql-yoga/commit/88393b3fae602c969ce99a0075439e1322c896d3)
Thanks [@dotansimha](https://github.com/dotansimha)! - By default, the following metrics are now
enabled:

- `graphql_envelop_deprecated_field`
- `graphql_envelop_request`
- `graphql_envelop_request_duration`
- `graphql_envelop_request_time_summary`
- `graphql_envelop_phase_parse`
- `graphql_envelop_phase_validate`
- `graphql_envelop_phase_context`
- `graphql_envelop_error_result`
- `graphql_envelop_phase_execute`
- `graphql_envelop_phase_subscribe`
- `graphql_envelop_schema_change`
- `graphql_yoga_http_duration`

### Minor Changes

- [#3391](https://github.com/dotansimha/graphql-yoga/pull/3391)
[`0788d8a`](https://github.com/dotansimha/graphql-yoga/commit/0788d8ab90642a87af0623cfacfdb85aa9f38500)
Thanks [@EmrysMyrddin](https://github.com/EmrysMyrddin)! - Add missing labels `path` and `phase`
of `graphql_envelop_error_result` metric to the configuration.

Add missing labels `method` and `statusCode` of `graphql_yoga_http_duration` metric to the
configuration.

### Patch Changes

- [#3391](https://github.com/dotansimha/graphql-yoga/pull/3391)
[`0788d8a`](https://github.com/dotansimha/graphql-yoga/commit/0788d8ab90642a87af0623cfacfdb85aa9f38500)
Thanks [@EmrysMyrddin](https://github.com/EmrysMyrddin)! - dependencies updates:
- Updated dependency
[`@envelop/[email protected]` ↗︎](https://www.npmjs.com/package/@envelop/prometheus/v/11.0.0)
(from `^10.0.0`, in `dependencies`)

## 5.3.3

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/prometheus/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@graphql-yoga/plugin-prometheus",
"version": "5.3.3",
"version": "6.0.0",
"type": "module",
"description": "Prometheus plugin for GraphQL Yoga.",
"repository": {
Expand Down

0 comments on commit d2e4557

Please sign in to comment.