Files
pezkuwi-subxt/substrate/utils/prometheus
Max Inden 9d49d917f6 *: Rename prometheus-exporter crate to substrate-prometheus-end… (#5076)
This patch renames the crate for the following two reasons:

1. The prometheus-exporter crate introduces native in-process Prometheus
style instrumentation to the Substrate project. Within the Prometheus
ecosystem the term "exporter" is used for external processes exposing
metrics for e.g. the Linux Kernel. In-process exposition would be
described via the term "endpoint".

2. "prometheus-exporter" is generic and ignores the fact that it is only
usable within the context of Substrate. In addition the name
"prometheus-exporter" is already taken on crates.io.
2020-02-27 17:48:26 +01:00
..

Substrate Prometheus Exporter

Introduction

Prometheus is one of the most widely used monitoring tools for managing highly available services supported by Cloud Native Computing Foundation. By providing Prometheus metrics in Substrate, node operators can easily adopt widely used display/alert tools such as Grafana and Alertmanager. Easy access to such monitoring tools will benefit parachain developers/operators and validators to have much higher availability of their services.

Metrics will be served under /metrics on TCP port 9615 by default.

Quick Start

  1. From the root of the repository start Substrate cargo run --release.

  2. In another terminal run curl localhost:9615/metrics to retrieve the metrics.

To learn how to configure Prometheus see the Prometheus Getting Started guide.