Skip to content

Commit

Permalink
Document when dependencies are needed (#241)
Browse files Browse the repository at this point in the history
While we declare dependencies in micrometer-core's published POM, we didn't explain them in documentation. This adds that explanation, especially given we have recently made changes to verify that these dependencies are not needed at compile time and are only needed at runtime if the corresponding feature is used.

Closes gh-240
  • Loading branch information
shakuzen authored Aug 4, 2022
1 parent b48f740 commit b745539
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/docs/concepts/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ Micrometer is _not_ a distributed tracing system or an event logger. In Micromet
For better understanding the differences among these different types of systems (Metrics, Distributed Tracing, and Logging) we recommend Adrian Cole's talk, titled https://www.dotconferences.com/2017/04/adrian-cole-observability-3-ways-logging-metrics-tracing[Observability
3 Ways].

== Dependencies

The `micrometer-core` module aims to have minimal dependencies. It does not require any third-party (non-Micrometer) dependencies on the classpath at compile time for applications using Micrometer.

Use of the link:#_pause_detection[pause detection] feature requires the https://github.com/LatencyUtils/LatencyUtils:[LatencyUtils] dependency to be available on the classpath at runtime. If your application does not use the pause detection feature, you can exclude LatencyUtils from your runtime classpath.

https://github.com/HdrHistogram/HdrHistogram:[HdrHistogram] is needed on the classpath at runtime if you use link:#_histograms_and_percentiles[client-side percentiles]. If you are not using client-side percentiles, you may exclude HdrHistogram from your application's runtime classpath.

== Supported Monitoring Systems

include::implementations.adoc[leveloffset=+1]
Expand Down

0 comments on commit b745539

Please sign in to comment.