Skip to content

Commit

Permalink
docs: added observability to decisiones
Browse files Browse the repository at this point in the history
documented the technology used for observability, traces and logs
  • Loading branch information
clsource authored Feb 25, 2025
1 parent 88c6f65 commit aa4aaf9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/modules/decisions/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
* xref:use-tbd-and-cc.adoc[]
* xref:use-bruno.adoc[]
* xref:use-telegram.adoc[]
* xref:use-grafana-prometheus.adoc[]
16 changes: 11 additions & 5 deletions docs/modules/decisions/pages/use-grafana-prometheus.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
=== Use Grafana + Prometheus
=== Use Observability and Telemetry

- Status: accepted
- Date: 2025-01-07
Expand All @@ -14,16 +14,22 @@ A monitoring system that stores and visualizes system metrics will be needed to

==== Decision Outcome

Chosen option: "`Grafana + Prometheus`", because
The following technologies will be used.

- Provides full control over metrics and monitoring infrastructure.
- Grafana integrates well with Prometheus.
- Elixir supports Prometheus through libraries such as https://github.com/deadtrickster/prometheus.ex[prometheus.ex].
- https://prometheus.io/[Prometheus] for event timeseries
- https://grafana.com/[Grafana] for dashboard and alerts.
- https://opentelemetry.io/[Open Telemetry] for service resource monitoring.
- https://grafana.com/oss/tempo/[Tempo] for tracing backend.
- https://grafana.com/oss/loki/[Loki] for log aggregation.
- https://vector.dev/[Vector.dev] for log distribution.
- https://kafka.apache.org/[Kafka] for event pipelines.

==== Consequences

- Grafana will be used to build and maintain dashboards.
- Infrastructure might require additional resources for deploying Prometheus and Grafana instances.
- Grafana, Prometheus, Tempo and Kafka will be optional extensions.
- Loki, Vector and Open Telemetry will be part of the core.

==== Links

Expand Down

0 comments on commit aa4aaf9

Please sign in to comment.