From 284cb69138bf1e8a4436b78fedc574af0126bca5 Mon Sep 17 00:00:00 2001
From: Pascal Schmid <psschmid@gmx.de>
Date: Fri, 14 Jun 2024 23:23:50 +0200
Subject: [PATCH] Add observability doc

---
 README.md        |  4 +---
 observability.md | 38 +++++++++++++++++++++++++++++++++++++-
 2 files changed, 38 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index c351e6a..d4e7637 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,4 @@ Useful links for programming
     - tree
     - ...
 
-### Observability
-
-[see](observability.md)
\ No newline at end of file
+### [Observability](observability.md)
diff --git a/observability.md b/observability.md
index c5ac4a2..5137a1d 100644
--- a/observability.md
+++ b/observability.md
@@ -1 +1,37 @@
-# Observability
\ No newline at end of file
+# Observability
+
+## Logs
+
+- Unify code to log - configure to include module name: https://hexdocs.pm/logger/Logger.html
+- Failures
+- Audit logs
+
+## Metrics
+
+- Take time to calculate - they aren't free
+- Measure time
+- If something happens: do the metrics reflect the state you envisioned?
+    - Yes: good
+    - No: bad metric
+
+
+- Types of metrics
+    - Business
+        - Sales
+        - Marketing
+    - System
+        - CPU
+        - RAM
+        - Process count
+        - Performance
+        - Availability
+        - ...
+    - Product
+
+- Metrics kinds
+    - Leading (short time): test hypothesis 
+    - Lagging (long time): whether actions were successful
+
+## Alarms
+
+https://www.erlang.org/doc/apps/sasl/alarm_handler.html
\ No newline at end of file