{"id":16828401,"url":"https://github.com/pjfanning/micrometer-pekko","last_synced_at":"2025-03-22T04:30:29.200Z","repository":{"id":98104485,"uuid":"603587683","full_name":"pjfanning/micrometer-pekko","owner":"pjfanning","description":"A library for monitoring Apache Pekko that uses Micrometer metrics","archived":false,"fork":false,"pushed_at":"2025-03-11T18:20:20.000Z","size":503,"stargazers_count":8,"open_issues_count":6,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-18T07:51:47.855Z","etag":null,"topics":["apache-pekko","micrometer","pekko"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pjfanning.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"Contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"pjfanning"}},"created_at":"2023-02-19T00:44:49.000Z","updated_at":"2025-03-11T18:20:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c3c3885-cebc-4bc8-87f3-2828334d810d","html_url":"https://github.com/pjfanning/micrometer-pekko","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pjfanning%2Fmicrometer-pekko","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pjfanning%2Fmicrometer-pekko/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pjfanning%2Fmicrometer-pekko/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pjfanning%2Fmicrometer-pekko/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pjfanning","download_url":"https://codeload.github.com/pjfanning/micrometer-pekko/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244907420,"owners_count":20529850,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache-pekko","micrometer","pekko"],"created_at":"2024-10-13T11:26:26.933Z","updated_at":"2025-03-22T04:30:29.194Z","avatar_url":"https://github.com/pjfanning.png","language":"Scala","funding_links":["https://github.com/sponsors/pjfanning"],"categories":[],"sub_categories":[],"readme":"![Build Status](https://github.com/pjfanning/micrometer-pekko/actions/workflows/ci.yml/badge.svg?branch=main)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.pjfanning/micrometer-pekko_2.13/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.pjfanning/micrometer-pekko_2.13)\n\u003c!---\n[![codecov.io](https://codecov.io/gh/kontainers/micrometer-akka/coverage.svg?branch=main)](https://codecov.io/gh/kontainers/micrometer-akka/branch/main)\n---\u003e\n# micrometer-pekko\n\nThis 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. \nThis fork produces metrics in [Micrometer](http://micrometer.io/) format.\n\nThese are 3 previous iterations of this library:\n* [pjfanning/micrometer-akka](https://github.com/pjfanning/micrometer-akka)\n* [Kontainers/micrometer-akka](https://github.com/Kontainers/micrometer-akka)\n* [Prometheus-Akka](https://github.com/Workday/prometheus-akka)\n\n```sbt\n\"com.github.pjfanning\" %% \"micrometer-pekko\" % \"0.17.0\"\n```\n\nThere is a sample project at https://github.com/pjfanning/micrometer-pekko-sample.\n\n## Usage\n\nTo 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):\n\n-javaagent:/path/to/aspectjweaver-1.9.22.1.jar\n\nYou will also need to set up the Micrometer Meter Registry.\n\ncom.github.pjfanning.micrometer.pekko.PekkoMetricRegistry#setRegistry ([example](https://github.com/pjfanning/micrometer-pekko-sample/blob/main/src/main/scala/com/example/pekko/Main.scala))\n\n## Configuration\n\nThe 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.\n\n### Metrics\n\n#### Dispatcher\n\n- differs a little between ForkJoin dispatchers and ThreadPool dispatchers\n- ForkJoin: parallelism, activeThreadCount, runningThreadCount, queuedSubmissionCount, queuedTaskCountGauge stealCount\n- ThreadPool: activeThreadCount, corePoolSize, currentPoolSize, largestPoolSize, maxPoolSize, completedTaskCount, totalTaskCount\n\n#### Actor System\n\n- Actor Count\n- Unhandled Message Count\n- Dead Letter Count\n\n#### Actor\n\n- One metric per actor instance\n- mailboxSize (current size), processingTime, timeInMailbox, message count, error count\n\n#### Actor Router\n\n- One metric per router instance, summed across all routee actors\n- routingTime, timeInMailbox, message count, error count\n\n#### Actor Group\n\n- 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\n- actorCount (current active actors), mailboxSize (current size), processingTime, timeInMailbox, message count, error count\n\n## License\n\n```\nCopyright © 2017,2018 Workday, Inc.\nCopyright © 2013-2017 the kamon project \u003chttp://kamon.io/\u003e\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpjfanning%2Fmicrometer-pekko","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpjfanning%2Fmicrometer-pekko","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpjfanning%2Fmicrometer-pekko/lists"}