From b10a670083028436af99a96ddf69c45e31b16327 Mon Sep 17 00:00:00 2001 From: TheGuildBot <59414373+theguild-bot@users.noreply.github.com> Date: Tue, 13 Aug 2024 12:24:36 +0300 Subject: [PATCH] Upcoming Release Changes (#2286) Co-authored-by: github-actions[bot] --- .changeset/heavy-houses-kick.md | 51 ------------------- .changeset/proud-insects-tell.md | 5 -- packages/plugins/prometheus/CHANGELOG.md | 62 ++++++++++++++++++++++++ packages/plugins/prometheus/package.json | 2 +- 4 files changed, 63 insertions(+), 57 deletions(-) delete mode 100644 .changeset/heavy-houses-kick.md delete mode 100644 .changeset/proud-insects-tell.md diff --git a/.changeset/heavy-houses-kick.md b/.changeset/heavy-houses-kick.md deleted file mode 100644 index e9ba44706..000000000 --- a/.changeset/heavy-houses-kick.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -'@envelop/prometheus': major ---- - -**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 - -- 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_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, -+ } - }) - ] -}) -``` diff --git a/.changeset/proud-insects-tell.md b/.changeset/proud-insects-tell.md deleted file mode 100644 index 170f2fe76..000000000 --- a/.changeset/proud-insects-tell.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@envelop/prometheus': minor ---- - -Add missing labels `path` and `phase` of `graphql_envelop_error_result` metric to the configuration. diff --git a/packages/plugins/prometheus/CHANGELOG.md b/packages/plugins/prometheus/CHANGELOG.md index 97cc1f49d..fc363a71c 100644 --- a/packages/plugins/prometheus/CHANGELOG.md +++ b/packages/plugins/prometheus/CHANGELOG.md @@ -1,5 +1,67 @@ # @envelop/prometheus +## 11.0.0 + +### Major Changes + +- [#2270](https://github.com/n1ru4l/envelop/pull/2270) + [`73eb69f`](https://github.com/n1ru4l/envelop/commit/73eb69fd9d67b24d7598d1ce6195911688077c5d) + 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 + + - 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_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, + + } + }) + ] + }) + ``` + +### Minor Changes + +- [#2270](https://github.com/n1ru4l/envelop/pull/2270) + [`73eb69f`](https://github.com/n1ru4l/envelop/commit/73eb69fd9d67b24d7598d1ce6195911688077c5d) + Thanks [@EmrysMyrddin](https://github.com/EmrysMyrddin)! - Add missing labels `path` and `phase` + of `graphql_envelop_error_result` metric to the configuration. + ## 10.0.0 ### Major Changes diff --git a/packages/plugins/prometheus/package.json b/packages/plugins/prometheus/package.json index 60a5654a9..13a0ab8a0 100644 --- a/packages/plugins/prometheus/package.json +++ b/packages/plugins/prometheus/package.json @@ -1,6 +1,6 @@ { "name": "@envelop/prometheus", - "version": "10.0.0", + "version": "11.0.0", "type": "module", "repository": { "type": "git",