akoutmos
PromEx - Prometheus metrics and Grafana dashboards for all of your favorite Elixir libraries
Prometheus metrics and Grafana dashboards for all of your favorite Elixir libraries
I have been putting off creating an ElixirForum post about PromEx until it hit the coveted 1.0.0 mark. But that time has finally come! PromEx is a metrics framework that ties together all of the BEAM Telemetry libraries in a simple to use package. It comes with plugins for all of the popular Elixir ecosystem libraries including Phoenix, Ecto, LiveView, Oban, the BEAM itself, and may more coming soon. Each PromEx plugin also comes with an accompanying Grafana dashboard which PromEx will automatically upload for you on application start. PromEx will also annotate all of your PromEx Grafana dashboards so that you know when application instances come up and go down:
PromEx is extensible in that it also allows you to write you own plugins and dashboards to support gathering metrics specific to you application.
Check out the thorough Hex Docs to learn more about PromEx Contents — PromEx v1.0.0
And Check out the snapshots of the dashboards if you are curious what you get out of the box Dashboards Screenshots — PromEx v1.11.0
Most Liked
akoutmos
Version 1.4.0 of PromEx has been published to Hex.
Changelog for this version:
Changed
- The Phoenix plugin now requires an
:endpointconfiguration option to be passed to it containing the module
for which metrics will be captured.
Added
- Plug.Router plugin and dashboard.
- PlugCowboy plugin and dashboard.
- Phoenix plugin now supports multiple routers and multiple endpoints.
- Phoenix plugin and dashboards now contains endpoint configuration data.
- Phoenix plugin now captures socket metrics (dashboard not yet updated though).
- Ecto plugin captures total_time metrics (dashboard not yet updated though).
- Add an optional configuration to dashboard renderer and each plugin so that the
metrics_prefixcan be altered.
Fixed
- Oban dashboard overview stat panels.
akoutmos
akoutmos
Great question! The metrics plug that comes with PromEx has no authorization configuration available since I have another library that I maintain that deals with things like that. I will probably pull in authorization into the builtin plug since it is a common request in the near future. But for now I recommend people use Unplug which can unhook plugs from your plug pipeline.
PromEx is currently capturing metrics for The Changelog and you can look at how they secure the metrics endpoint using Unplug:
akoutmos
Version 1.6.0 of PromEx has been published to Hex
Changelog for this version:
Added
- Updated BEAM plugin to surface JIT support
- Broadway metrics plugin
- Broadway Grafana dashboard
Fixed
- LiveView plugin would detach exception handles when certain errors were encountered
Here is a snapshot of the Broadway dashboard:
akoutmos
Version 1.7.0 of PromEx has been published to Hex
This is a really exciting release as PromEx now allows you to bundle GrafanaAgent so that you can push metrics to a Prometheus instance via remote_write. That means that you can get up and running with services like GrafanaCloud in minutes! Imagine that, metrics and dashboards all up and running in 15 minutes
. Enjoy!
Changelog for this version:
Added
- Added ability to execute arbitrary function on resulting dashboard for user customization.
- The GrafanaClient is now considered part of the public API, and users can interact with Grafana directly. For example, users can publish their own Grafana annotations in addition to the annotations provided by PromEx.
- Added the ability to start GrafanaAgent via a port so that metrics can be published via
remote_writeto an other Prometheus instance. For example, if you are using GrafanaCloud, you can use PromEx to push metrics right to GrafanaCloud using the appropriate configuration. This feature is currently only available for Linux and OS X. - The
ETSCronFlusherGenServer can now be configured to flush the ETS buffer at whatever time interval you desire. The default is still every 7.5s.
Fixed
- Broadway metrics prefix.
- Broadway dashboard panel descriptions and titles.
- Fixed the
:default_selected_intervaloption in all dashboards. - Phoenix plugin manual metrics were ignoring the metric prefix option.
Changed
- Application plugin no longer logs warnings for missing GIT env vars.
- LifecycleAnnotator no longer logs warnings for missing GIT env vars.
- All plugin distribution buckets have been redefined. The reason for this being that prior to PromEx 1.7, some of the distribution buckets were a bit wasteful and were not adding value in terms of metrics data points. With this change,
users should notice a decline in data point cardinality without compromising resolution. - Application plugin has changed how it fetches dependency information. It is now using
Applciation.spec/1to get the list of applications that are started with your application. This should reduce noise in the Grafana dashboard as all
the default OTP and Elixir applications will not show up. - All Grafana dashboard now have a default panel sort order where the largest timeseries plot is first in the list when hovering over the visuals.
- All Grafana dashboards now filter the instance filter based on the selected job filter.
- The Oban plugin no longer collects metrics related to
:circuitevents as those have been removed from Oban starting with version 2.11 (Lock based leadership by sorentwo · Pull Request #606 · oban-bg/oban · GitHub). The Oban dashboard will be updated in the next release to remove the unused panels.











