Daml

Configure Metrics

Note

This page is a work in progress. It may contain incomplete or incorrect information.

Configure Metrics

Metrics provide quantitative information about the internal state of a running system, which is key for monitoring of its health and performance and observability of its operating behavior.

Participant Nodes can report these metrics on an HTTP endpoint. This should then be periodically scraped by a separate monitoring system such as Prometheus, which can store it as time-series data for querying, alerting, dashboards, etc.

Export Metrics for Scraping

Export application metrics by enabling the Prometheus reporter with the configuration canton.monitoring.metrics.reporters = [{ type = prometheus }]

Metrics will be available for scraping in OpenMetrics format at http://<host>:9464/, by default.

You can also export JVM metrics with

canton.monitoring.metrics.reporters.jvm-metrics.enabled = yes

e.g.

canton.monitoring.metrics {
    jvm-metrics.enabled = yes
    reporters = [{
        type = prometheus
        address = 0.0.0.0
        // This will expose the prometheus metrics on port 9000
        port = 9000
    }]
}

See the metrics reference for the full list of metrics exported.

Deprecated Reporters

Other reporters (jmx, graphite, and csv) are supported, but they are deprecated. Any such reporter should be migrated to Prometheus.

JMX-based reporting (for testing purposes only) can be enabled using:

canton.monitoring.metrics.reporters = [{ type = jmx }]

Additionally, metrics can be written to a file:

canton.monitoring.metrics.reporters = [{
  type = jmx
}, {
  type = csv
  directory = "metrics"
  interval = 5s // default
  filters = [{
    contains = "canton"
  }]
}]

or reported via Graphite (to Grafana) using:

canton.monitoring.metrics.reporters = [{
  type = graphite
  port = 2003
  interval = 30s // default
  filters = [{
    contains = "canton"
  }]
}]

When using the graphite or the csv reporter, Canton periodically evaluates all metrics matching the given filters. Filter for only those metrics that are relevant to you.

← Back to Documentation