Skip to content

Commit

Permalink
Docs: Add MP Metrics API in some cases
Browse files Browse the repository at this point in the history
(cherry picked from commit 58ff626)
  • Loading branch information
ebullient authored and gsmet committed Apr 3, 2021
1 parent 2a3445f commit c5fdfb0
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/src/main/asciidoc/micrometer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,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

0 comments on commit c5fdfb0

Please sign in to comment.