Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add MP Metrics API in some cases #15998

Merged
merged 1 commit into from
Mar 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/src/main/asciidoc/micrometer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,16 @@ public MeterFilter renameApplicationMeters() {
}
----

Ensure the following dependency is present in your `pom.xml` file if you require the Microprofile Metrics API:

[source,xml]
----
<dependency>
<groupId>org.eclipse.microprofile.metrics</groupId>
<artifactId>microprofile-metrics-api</artifactId>
</dependency>
----

NOTE: The MP Metrics API compatibility layer will be moved to a different extension in the future.

== Configuration Reference
Expand Down
15 changes: 15 additions & 0 deletions docs/src/main/asciidoc/smallrye-graphql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -849,6 +849,21 @@ When `SomeBusinessException` occurs, the error output will contain the Error cod

<1> The error code

== Additional Notes

If you are using the `smallrye-graphql` extension and the `micrometer` metrics extension is present and metrics are
enabled, you may encounter a `java.lang.NoClassDefFoundError` as some versions of the `smallrye-graphql` extension
have runtime requirements on the Microprofile Metrics API. Add the following Microprofile Metrics API dependency
to resolve the issue:

[source,xml]
----
<dependency>
<groupId>org.eclipse.microprofile.metrics</groupId>
<artifactId>microprofile-metrics-api</artifactId>
</dependency>
----

== Conclusion

SmallRye GraphQL enables clients to retrieve the exact data that is
Expand Down