From 6c299d6d0ffb53e1f713903db0b9dc07b92f7dbf Mon Sep 17 00:00:00 2001
From: Tochemey <tochemey@hotmail.com>
Date: Sun, 31 Dec 2023 23:32:20 +0000
Subject: [PATCH] docs: add metric information to readme

---
 readme.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/readme.md b/readme.md
index d16b1ac8..4f345d43 100644
--- a/readme.md
+++ b/readme.md
@@ -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)
@@ -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.