Skip to content

Commit

Permalink
docs: add metric information to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tochemey committed Dec 31, 2023
1 parent f51555f commit 6c299d6
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Also, check reference section at the end of the post for more material regarding
- [Observability](#observability)
- [Logging](#logging)
- [Tracing](#tracing)
- [Metric](#metrics)
- [Testkit](#testkit)
- [Use Cases](#use-cases)
- [Installation](#installation)
Expand Down Expand Up @@ -234,6 +235,21 @@ Go-Akt uses under the hood [OpenTelemetry](https://opentelemetry.io/docs/instrum
One just need to use the `WithTracing` option when instantiating a Go-Akt actor system and use the default [Telemetry](./telemetry/telemetry.go)
engine or set a custom one with `WithTelemetry` option of the actor system.

#### Metrics

One can enable/disable metrics on a Go-Akt actor system to collect the following metrics:
- Actor Metrics:
- Number of children
- Number of messages stashed
- Number of Restarts
- Last message received processing latency in milliseconds
- System Metrics:
- Total Number of Actors

Go-Akt uses under the hood [OpenTelemetry](https://opentelemetry.io/docs/instrumentation/go/) to instrument a system.
One just need to use the `WithMetric` option when instantiating a Go-Akt actor system and use the default [Telemetry](./telemetry/telemetry.go)
engine or set a custom one with `WithTelemetry` option of the actor system.

#### Logging

A simple logging interface to allow custom logger to be implemented instead of using the default logger.
Expand Down

0 comments on commit 6c299d6

Please sign in to comment.