From d09f3710488127351ba9709df3823759d7c5562f Mon Sep 17 00:00:00 2001 From: Brian Clozel Date: Fri, 2 Jul 2021 14:57:25 +0200 Subject: [PATCH] Add missing configuration metadata for graphql metrics --- .../additional-spring-configuration-metadata.json | 14 ++++++++++++++ spring-graphql-docs/src/docs/asciidoc/index.adoc | 10 +++++++++- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/graphql-spring-boot-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/graphql-spring-boot-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 1e44e857..3d5b9dcf 100644 --- a/graphql-spring-boot-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/graphql-spring-boot-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -3,6 +3,20 @@ { "name": "spring.graphql.locations", "defaultValue": "classpath:graphql/" + }, + { + "name": "management.metrics.graphql.autotime.enabled", + "description": "Whether to automatically time graphql requests.", + "defaultValue": true + }, + { + "name": "management.metrics.graphql.autotime.percentiles", + "description": "Computed non-aggregable percentiles to publish." + }, + { + "name": "management.metrics.graphql.autotime.percentiles-histogram", + "description": "Whether percentile histograms should be published.", + "defaultValue": false } ] } \ No newline at end of file diff --git a/spring-graphql-docs/src/docs/asciidoc/index.adoc b/spring-graphql-docs/src/docs/asciidoc/index.adoc index f300d0ae..62c3df8a 100644 --- a/spring-graphql-docs/src/docs/asciidoc/index.adoc +++ b/spring-graphql-docs/src/docs/asciidoc/index.adoc @@ -263,7 +263,15 @@ spring.graphql.graphiql.path=/graphiql === Metrics When the starter `spring-boot-starter-actuator` is present on the classpath, metrics for -GraphQL requests are collected. You can configure metrics collection as follows: +GraphQL requests are collected. You can disable metrics collection as follows: + +[source,properties,indent=0,subs="verbatim,quotes"] +---- +management.metrics.graphql.autotime.enabled=false +---- + +Metrics can be exposed with an Actuator web endpoint. +The following sections assume that its exposure is enabled in your application configuration, as follows: [source,properties,indent=0,subs="verbatim,quotes"] ----