Monitoring Your Elixir Application with Prometheus
0 likes360 views
The document provides a detailed guide on setting up and monitoring an Elixir application using Prometheus and Grafana. It includes instructions for defining metrics, setting up instrumentation, creating telemetry events, and viewing metrics via Prometheus and Grafana. Additional resources and tools for application monitoring are also mentioned.
![Setup
mix.exs
[
{:prometheus_ex, "~> 3.0"},
{:prometheus_plugs, "~> 1.1"},
{:telemetry, "~> 0.3"},
]](https://image.slidesharecdn.com/prometheus-190303000421/85/Monitoring-Your-Elixir-Application-with-Prometheus-8-320.jpg)
![Our firstInstrumenter
defmodule Metrics.AccountInstrumenter do
use Prometheus.Metric
def setup() do
events = [
[:create],
[:session, :login],
[:session, :logout],
]
Enum.each(events, &setup_event/1)
end
end](https://image.slidesharecdn.com/prometheus-190303000421/85/Monitoring-Your-Elixir-Application-with-Prometheus-15-320.jpg)
![Triggering Events
0.3.0
:telemetry.execute([:grapevine, :accounts, :create], 1)](https://image.slidesharecdn.com/prometheus-190303000421/85/Monitoring-Your-Elixir-Application-with-Prometheus-20-320.jpg)
![Triggering Events
0.4.0
:telemetry.execute([:grapevine, :accounts, :create],
%{value: 1})](https://image.slidesharecdn.com/prometheus-190303000421/85/Monitoring-Your-Elixir-Application-with-Prometheus-21-320.jpg)
![RegisterTelemetry
Callbacks
defmodule Metrics.AccountInstrumenter do
defp setup_event(event) do
name = Enum.join(event, "_")
name = "grapevine_accounts_#{name}"
Counter.declare(
name: String.to_atom("#{name}_total"),
help: "Total of account event #{name}"
)
# [:grapevine, :accounts, :create]
event = [:grapevine, :accounts | event]
:telemetry.attach(name, event, &handle_event/4, nil)
end
end](https://image.slidesharecdn.com/prometheus-190303000421/85/Monitoring-Your-Elixir-Application-with-Prometheus-22-320.jpg)
![Handling Events
def handle_event(event, count, metadata, config)
def handle_event([:grapevine, :accounts, :create], _, _, _) do
Logger.info("New account created!")
Counter.inc(name: :grapevine_accounts_create_total)
end](https://image.slidesharecdn.com/prometheus-190303000421/85/Monitoring-Your-Elixir-Application-with-Prometheus-24-320.jpg)
![Scrape Config
scrape_configs:
- job_name: 'grapevine'
static_configs:
- targets: ['localhost:4100']](https://image.slidesharecdn.com/prometheus-190303000421/85/Monitoring-Your-Elixir-Application-with-Prometheus-28-320.jpg)
![Rules
alert: New User Registered
expr: increase(grapevine_account_create_total[5m]) > 0
annotations:
subject: "Grapevine - New user registered"
description: ""](https://image.slidesharecdn.com/prometheus-190303000421/85/Monitoring-Your-Elixir-Application-with-Prometheus-31-320.jpg)
Monitoring Your Elixir Application with Prometheus
- 2. SmartLogic We build web and mobile applications Have a project? We can help. smartlogic.io // contact@smartlogic.io
- 3. » Context » Setup » Metrics » Instrument » Prometheus » Grafana » Alerting
- 4. Prometheus From metrics to insight prometheus.io
- 5. Grafana The open platform for beautiful analytics and monitoring grafana.com
- 6. Other Options » NewRelic » CloudWatch » DataDog » Scout » statsd » Graphite » ...
- 7. Grapevine Community site for text based games grapevine.haus https://github.com/oestrich/grapevine
- 8. Setup mix.exs [ {:prometheus_ex, "~> 3.0"}, {:prometheus_plugs, "~> 1.1"}, {:telemetry, "~> 0.3"}, ]
- 9. DefineYour Metrics Exporter defmodule Metrics.PlugExporter do use Prometheus.PlugExporter end
- 10. Addto Endpoint defmodule Web.Endpoint do # ... plug Metrics.PlugExporter # ... end
- 11. Metrics Setup defmodule Metrics.Setup do def setup do Metrics.PlugExporter.setup() end end
- 12. Add SetuptoYour Application defmodule Grapevine.Application do def start(_type, _args) do # ... Metrics.Setup.setup() # ... Supervisor.start_link(children, opts) end end
- 13. Metrics! Available at http://localhost:4100/metrics # TYPE erlang_vm_atom_count gauge # HELP erlang_vm_atom_count The number of atom ... erlang_vm_atom_count 38398 # TYPE erlang_vm_atom_limit gauge # HELP erlang_vm_atom_limit The maximum number ... erlang_vm_atom_limit 1048576 # Many more
- 15. Our firstInstrumenter defmodule Metrics.AccountInstrumenter do use Prometheus.Metric def setup() do events = [ [:create], [:session, :login], [:session, :logout], ] Enum.each(events, &setup_event/1) end end
- 16. Our firstInstrumenter defmodule Metrics.AccountInstrumenter do defp setup_event(event) do name = Enum.join(event, "_") name = "grapevine_accounts_#{name}" Counter.declare( name: String.to_atom("#{name}_total"), help: "Total of account event #{name}" ) #... end end
- 17. Prometheus Naming » Prefix with application name » Use base units (seconds not milliseconds) » Suffix with unit Prometheus Docs
- 18. Addto our Setupmodule def setup do Metrics.AccountInstrumenter.setup() Metrics.PlugExporter.setup() end
- 19. Metrics # TYPE grapevine_accounts_session_login_total counter # HELP grapevine_accounts_session_login_total Total count ... grapevine_accounts_session_login_total 0
- 20. Triggering Events 0.3.0 :telemetry.execute([:grapevine, :accounts, :create], 1)
- 21. Triggering Events 0.4.0 :telemetry.execute([:grapevine, :accounts, :create], %{value: 1})
- 22. RegisterTelemetry Callbacks defmodule Metrics.AccountInstrumenter do defp setup_event(event) do name = Enum.join(event, "_") name = "grapevine_accounts_#{name}" Counter.declare( name: String.to_atom("#{name}_total"), help: "Total of account event #{name}" ) # [:grapevine, :accounts, :create] event = [:grapevine, :accounts | event] :telemetry.attach(name, event, &handle_event/4, nil) end end
- 24. Handling Events def handle_event(event, count, metadata, config) def handle_event([:grapevine, :accounts, :create], _, _, _) do Logger.info("New account created!") Counter.inc(name: :grapevine_accounts_create_total) end
- 25. Concurrency » :telemetry.execute runs in the process that calls it » Prometheus counters/gauges/etc are tracked via public ETS tables
- 26. Viewing our Metrics » /metrics » Prometheus server » Grafana
- 27. Basic Prometheus Setup » Scrape configs » Rules
- 28. Scrape Config scrape_configs: - job_name: 'grapevine' static_configs: - targets: ['localhost:4100']
- 31. Rules alert: New User Registered expr: increase(grapevine_account_create_total[5m]) > 0 annotations: subject: "Grapevine - New user registered" description: ""
- 34. Dashboards
- 36. Demo
- 37. Twitch Live dev streams every Monday at 12PM Eastern twitch.tv/smartlogictv