diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 102 |
1 files changed, 44 insertions, 58 deletions
@@ -11,15 +11,23 @@ Kamon is currently available for Scala 2.10, 2.11 and 2.12. Supported releases and dependencies are shown below. -| kamon | status | jdk | scala | akka | -|:------:|:------:|:----:|------------------|:------:| -| 0.6.6 | stable | 1.7+, 1.8+ | 2.10, 2.11, 2.12 | 2.3.x, 2.4.x | +| kamon | status | jdk | scala +|:------:|:------:|:----:|------------------ +| 1.0.0 | stable | 1.7+, 1.8+ | 2.10, 2.11, 2.12 -To get started with SBT, simply add the following to your `build.sbt` +To get started with SBT, simply add the following to your `build.sbt` or `pom.xml` file: ```scala -libraryDependencies += "io.kamon" %% "kamon-core" % "0.6.6" +libraryDependencies += "io.kamon" %% "kamon-core" % "1.0.0.6" +``` + +```xml +<dependency> + <groupId>io.kamon</groupId> + <artifactId>kamon-core_2.12</artifactId> + <version>1.0.0</version> +</dependency> ``` ### Documentation @@ -29,46 +37,38 @@ Kamon information and documentation is available on the ### Modules ### -* [Play Framework] -* [Spray] -* [Akka] -* [Akka Remote] -* [Akka Http] -* [Scala] -* [Annotation] -* [System Metrics] -* [JDBC] -* [Elasticsearch] +We started migrating modules to Kamon `1.0.0` based on the usage data we have, community demand and time availability, but +not all have been upgraded just yet. + +Now, the lucky modules currently available are: + - [Core](https://github.com/kamon-io/kamon) includes all metrics, tracing and context management APIs. + - [Akka](https://github.com/kamon-io/kamon-akka) for actor metrics and tracing inside a single JVM. + - [Akka Remote](https://github.com/kamon-io/kamon-akka-remote) has now serialization and remoting metrics and is able + to trace messages across remote actor systems. + - [Akka HTTP](https://github.com/kamon-io/kamon-akka-http) with client and service side tracing and HTTP server metrics. + - [Futures](https://github.com/kamon-io/kamon-futures) bring automatic context propagation for Scala, Finagle and + Scalaz futures. + - [Executors](https://github.com/kamon-io/kamon-executors) collects executor service metrics. + - [Play Framework](https://github.com/kamon-io/kamon-futures) with client and server side tracing. + - [JDBC](https://github.com/kamon-io/kamon-jdbc) gives you metrics and tracing for JDBC statements execution and + Hikari pool metrics. + - [Logback](https://github.com/kamon-io/kamon-logback) comes with utilities for adding trace IDs to your logs and + instrumentation to keep context when using async appenders. + - [System Metrics](https://github.com/kamon-io/kamon-system-metrics) gathers host, process and JVM metrics. ### Backends ### -* [Log Reporter] -* [StatsD] -* [Datadog] -* [SPM] -* [InfluxDB] -* [New Relic] -* [FluentD] -* [JMX] -* [Riemann] -* [Khronus] - + - [Promethus](https://github.com/kamon-io/kamon-prometheus) exposes a scrape endpoint with all available metrics. + - [Zipkin](https://github.com/kamon-io/kamon-zipkin) for reporting trace data. + - [Jaeger](https://github.com/kamon-io/kamon-jaeger) reports tracing data as well. + - [Kamino](https://github.com/kamino-apm/kamino-reporter) reports metrics and tracing data to [Kamino][8] -### Projects using Kamon ### - -If you have a project you'd like to include in this list, either open a PR or let us know in [the gitter channel](https://gitter.im/kamon-io/Kamon) and we'll add a link to it here. - -* [kamon-prometheus](https://github.com/MonsantoCo/kamon-prometheus): A Kamon backend to support Prometheus -* [spray-kamon-metrics](https://github.com/MonsantoCo/spray-kamon-metrics): Better Kamon metrics for Spray services -* [camel-kamon](https://github.com/osinka/camel-kamon): Kamon metrics and traces for Apache Camel routes, processors -* [kamon-play-extensions](https://github.com/agiledigital/kamon-play-extensions): Kamon extensions for use in Play2 applications. -* [kamon-logstash](https://github.com/darienmt/kamon-logstash): Kamon-logstash backend module. ## License This software is licensed under the Apache 2 license, quoted below. -Copyright © 2013-2016 the kamon project <http://kamon.io> +Copyright © 2013-2018 the kamon project <http://kamon.io> Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of @@ -82,25 +82,11 @@ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - -[Play Framework]: https://github.com/kamon-io/kamon-play -[Spray]: https://github.com/kamon-io/kamon-spray -[Akka]:https://github.com/kamon-io/kamon-akka -[Akka Remote]: https://github.com/kamon-io/kamon-akka-remote -[Akka Http]: https://github.com/kamon-io/kamon-akka-http -[Scala]: https://github.com/kamon-io/kamon-scala -[Annotation]: https://github.com/kamon-io/kamon-annotation -[System Metrics]: https://github.com/kamon-io/kamon-system-metrics -[JDBC]: https://github.com/kamon-io/kamon-jdbc -[Elasticsearch]: https://github.com/kamon-io/kamon-elasticsearch - -[Log Reporter]: https://github.com/kamon-io/kamon-log-reporter -[SPM]: https://github.com/kamon-io/kamon-spm -[Datadog]: https://github.com/kamon-io/kamon-datadog -[FluentD]: https://github.com/kamon-io/kamon-fluentd -[JMX]: https://github.com/kamon-io/kamon-jmx -[StatsD]: https://github.com/kamon-io/kamon-statsd -[Riemann]: https://github.com/kamon-io/kamon-riemann -[Khronus]: https://github.com/kamon-io/kamon-khronus -[New Relic]: https://github.com/kamon-io/kamon-newrelic -[InfluxDB]: https://github.com/kamon-io/kamon-influxdb +[1]: https://github.com/dpsoft +[2]: https://github.com/ivantopo +[3]: /documentation/1.x/recipes/migrating-from-kamon-0.6.x/ +[4]: https://research.google.com/pubs/pub36356.html +[5]: https://twitter.github.io/finagle/guide/Contexts.html +[6]: https://grpc.io/grpc-java/javadoc/io/grpc/Context.html +[7]: https://gitter.im/kamon-io/Kamon +[8]: https://kamino.io/
\ No newline at end of file |