https://github.com/kamon-io/kamon-spm
Kamon SPM Integration
https://github.com/kamon-io/kamon-spm
Last synced: 11 months ago
JSON representation
Kamon SPM Integration
- Host: GitHub
- URL: https://github.com/kamon-io/kamon-spm
- Owner: kamon-io
- License: other
- Created: 2016-12-03T02:49:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-31T13:19:29.000Z (about 7 years ago)
- Last Synced: 2025-01-09T08:13:27.816Z (about 1 year ago)
- Language: Scala
- Homepage: http://kamon.io/backends/spm
- Size: 110 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
SPM Integration 
==========================
[](https://gitter.im/kamon-io/Kamon?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://maven-badges.herokuapp.com/maven-central/io.kamon/kamon-spm_2.12)
Reporting Metrics to SPM
=======================
[SPM] is a proactive performance monitoring solution that provides anomaly detection, alerting, transaction tracing, network topology discovery and log correlation available in the Cloud and On Premises.
Installation
------------
[Sign up]. [Create 'Akka' app] in SPM. Get your SPM app token. Add `kamon-spm` dependency to your project.
### Getting Started
Kamon akka-spm module is currently available for Scala 2.10, 2.11 and 2.12.
Supported releases and dependencies are shown below.
| kamon-spm | status | jdk | scala |
|:------:|:------:|:----:|------------------|
| 1.1.1 | stable | 1.8+ | 2.10, 2.11, 2.12 |
| 1.1.2 | stable | 1.8+ | 2.10, 2.11, 2.12 |
| 1.1.3 | stable | 1.8+ | 2.10, 2.11, 2.12 |
To get started with SBT, simply add the following to your `build.sbt`
file:
```scala
libraryDependencies += "io.kamon" %% "kamon-spm" % "1.1.3"
```
Configuration
-------------
SPM backend extension requires the property `kamon.spm.token` to be defined. SPM provides reports for `akka-actor`, `akka-router`, `akka-dispatcher` and `system-metrics` categories. By default all entities for given categories are included.
```
kamon {
spm {
token = "[place-token-here]"
}
reporters = ["kamon.spm.SPMReporter"]
}
kamon.util.filters {
"akka.tracked-actor" {
includes = [ "**" ]
}
"akka.tracked-dispatcher" {
includes = [ "**" ]
}
"akka.tracked-router" {
includes = [ "**" ]
}
}
```
To see a full example of Kamon SPM Backend configuration look at [application.conf] in [Sample Akka app] with Kamon and SPM.
**Note:** By default this extension uses hostname resolved using `InetAddress.getLocalHost.getHostName`. However, hostname can be redefined using `kamon.spm.hostname-alias` property.
Visualisation
-------------
Overview:
Actors:
Dispatchers:
Routers:
CPU:
[SPM]: https://sematext.com/spm
[Sign up]: https://apps.sematext.com/ui/registration
[Create 'Akka' app]: https://apps.sematext.com/ui/integrations
[Sample Akka app]: https://github.com/sematext/kamon-spm-example
[application.conf]: https://github.com/sematext/kamon-spm-example/blob/master/src/main/resources/application.conf