Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.

Commit 3b144c2

Browse files
authored
Merge pull request #241 from jmccaull/tracing_metrics_readme_update
update readme with info on tracing/metrics options
2 parents a94cf30 + 67347de commit 3b144c2

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
- [Enable Graph*i*QL](#enable-graphiql)
1818
- [Supported GraphQL-Java Libraries](#supported-graphql-java-libraries)
1919
- [GraphQL Java Tools](#graphql-java-tools)
20+
- [Tracing and Metrics](#tracing-and-metrics)
2021
- [Contributions](#contributions)
2122
- [Licenses](#licenses)
2223

@@ -272,7 +273,23 @@ graphql:
272273
By default GraphQL tools uses the location pattern `**/*.graphqls` to scan for GraphQL schemas on the classpath.
273274
Use the `schemaLocationPattern` property to customize this pattern.
274275

276+
# Tracing and Metrics
275277

278+
[Apollo style tracing](https://github.com/apollographql/apollo-tracing) along with two levels of metrics based on them are currently configurable.
279+
Full tracing is based on the GraphQl java implementation, and can be enabled in the application.yml or application.properties file:
280+
```yaml
281+
graphql:
282+
servlet:
283+
tracing-enabled: true
284+
```
285+
the default value is false, with "metrics-only" being available. Metrics-only does not add the tracing extension to the response.
286+
287+
Metrics utilize one of two forms of tracing to feed information to Micrometer. If tracing is enabled, or set to "metrics-only", full tracing metrics will be collected, otherwise a tracing implementation that does not collect field data will be injected. Metrics can be configured in the application.yml or application.properties to either true or false, with a default of false:
288+
```yaml
289+
graphql:
290+
servlet:
291+
actuator-metrics: true
292+
```
276293
# Contributions
277294

278295
Contributions are welcome. Please respect the [Code of Conduct](http://contributor-covenant.org/version/1/3/0/).

0 commit comments

Comments
 (0)