Skip to content

Commit

Permalink
docs: fixed headers in grafana docs
Browse files Browse the repository at this point in the history
* added grafana to decisions

* fixed headers
  • Loading branch information
clsource authored Feb 25, 2025
1 parent d66be03 commit 83d7b3e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
10 changes: 5 additions & 5 deletions docs/modules/decisions/pages/use-golden-signals.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
=== Use golden signals
= Use golden signals

- Status: accepted
- Date: 2025-01-09
==== Context and Problem Statement
== Context and Problem Statement

To ensure the reliability and performance of the application, we need a monitoring strategy that provides actionable insights into system health and user experience. A structured approach to identifying and addressing performance bottlenecks or failures is essential.

Golden signals (latency, traffic, errors, and saturation) are widely recognized as the key indicators for monitoring distributed systems and identifying potential issues before they impact users.

==== Considered Options
== Considered Options

- https://sre.google/sre-book/monitoring-distributed-systems/#xref_monitoring_golden-signals[Golden Signals] (latency, traffic, errors, saturation)

==== Decision Outcome
== Decision Outcome

Chosen option: "`Golden Signals`", because

Expand All @@ -26,7 +26,7 @@ Chosen option: "`Golden Signals`", because
- They allow for proactive identification of issues and facilitate targeted alerting and troubleshooting.


==== Consequences
== Consequences

Monitoring will focus on the following four signals:

Expand Down
12 changes: 6 additions & 6 deletions docs/modules/decisions/pages/use-grafana-prometheus.adoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
=== Use Observability and Telemetry
= Use Observability and Telemetry

- Status: accepted
- Date: 2025-01-07
==== Context and Problem Statement
== Context and Problem Statement

A monitoring system that stores and visualizes system metrics will be needed to ensure the reliability and performance of the application.

==== Considered Options
== Considered Options

- https://grafana.com/docs/grafana/latest/getting-started/get-started-grafana-prometheus/[Grafana + Prometheus]: Grafana provides visualization and Prometheus provides metrics collection.
- https://hexdocs.pm/telemetry/[Telemetry] library with https://hexdocs.pm/phoenix_live_dashboard/Phoenix.LiveDashboard.html[Phoenix LiveDashboard]: LiveDashboard lacks customizability and Telemetry doesn't persist metrics by itself.

==== Decision Outcome
== Decision Outcome

The following technologies will be used.

Expand All @@ -24,14 +24,14 @@ The following technologies will be used.
- https://vector.dev/[Vector.dev] for log distribution.
- https://kafka.apache.org/[Kafka] for event pipelines.

==== Consequences
== 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
== Links

- https://hexdocs.pm/telemetry_metrics_prometheus/TelemetryMetricsPrometheus.html
- https://github.com/deadtrickster/prometheus-plugs
Expand Down

0 comments on commit 83d7b3e

Please sign in to comment.