https://github.com/pjfanning/micrometer-pekko
A library for monitoring Apache Pekko that uses Micrometer metrics
https://github.com/pjfanning/micrometer-pekko
apache-pekko micrometer pekko
Last synced: about 1 month ago
JSON representation
A library for monitoring Apache Pekko that uses Micrometer metrics
- Host: GitHub
- URL: https://github.com/pjfanning/micrometer-pekko
- Owner: pjfanning
- License: apache-2.0
- Created: 2023-02-19T00:44:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T18:20:20.000Z (about 2 months ago)
- Last Synced: 2025-03-18T07:51:47.855Z (about 2 months ago)
- Topics: apache-pekko, micrometer, pekko
- Language: Scala
- Homepage:
- Size: 491 KB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://maven-badges.herokuapp.com/maven-central/com.github.pjfanning/micrometer-pekko_2.13)
# micrometer-pekko
This project is a fork of an early version of [Kamon-Akka](https://kamon.io/docs/latest/instrumentation/akka/). The Kamon team have done a great job and if you are just experimenting with metrics collection, then their tools and documentation are a great starting point.
This fork produces metrics in [Micrometer](http://micrometer.io/) format.
These are 3 previous iterations of this library:
* [pjfanning/micrometer-akka](https://github.com/pjfanning/micrometer-akka)
* [Kontainers/micrometer-akka](https://github.com/Kontainers/micrometer-akka)
* [Prometheus-Akka](https://github.com/Workday/prometheus-akka)
```sbt
"com.github.pjfanning" %% "micrometer-pekko" % "0.17.0"
```
There is a sample project at https://github.com/pjfanning/micrometer-pekko-sample.
## Usage
To enable monitoring, include the appropriate jar as a dependency and include the following Java runtime flag in your Java startup command (aspectjweaver is a transitive dependency of micrometer-pekko):
-javaagent:/path/to/aspectjweaver-1.9.22.1.jar
You will also need to set up the Micrometer Meter Registry.
com.github.pjfanning.micrometer.pekko.PekkoMetricRegistry#setRegistry ([example](https://github.com/pjfanning/micrometer-pekko-sample/blob/main/src/main/scala/com/example/pekko/Main.scala))
## Configuration
The metrics are configured using [application.conf](https://github.com/typesafehub/config) files. There is a default [reference.conf](https://github.com/pjfanning/micrometer-pekko/blob/main/src/main/resources/reference.conf) that enables only some metrics.
### Metrics
#### Dispatcher
- differs a little between ForkJoin dispatchers and ThreadPool dispatchers
- ForkJoin: parallelism, activeThreadCount, runningThreadCount, queuedSubmissionCount, queuedTaskCountGauge stealCount
- ThreadPool: activeThreadCount, corePoolSize, currentPoolSize, largestPoolSize, maxPoolSize, completedTaskCount, totalTaskCount
#### Actor System
- Actor Count
- Unhandled Message Count
- Dead Letter Count
#### Actor
- One metric per actor instance
- mailboxSize (current size), processingTime, timeInMailbox, message count, error count
#### Actor Router
- One metric per router instance, summed across all routee actors
- routingTime, timeInMailbox, message count, error count
#### Actor Group
- Each actor group has its own include/exclude rules and you can define many groups with individual actors being allowed to be included in many groups - the metrics are summed across all actors in the group
- actorCount (current active actors), mailboxSize (current size), processingTime, timeInMailbox, message count, error count
## License
```
Copyright © 2017,2018 Workday, Inc.
Copyright © 2013-2017 the kamon project
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 the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```