Statistics and metrics of AxoSyslog

The AxoSyslog application collects various statistics and metrics about its performance and status for observability and monitoring. Which metrics and statistics are collected depends on the configuration of AxoSyslog and the value of the stats(level()) global option.

Metrics and statistics

• AxoSyslog provides detailed metrics about its performance and status for observability and monitoring. We recommend using Prometheus to scrape these metrics, see Collect metrics with Prometheus for details. To display the current metrics locally in Prometheus-compatible format, run:

  syslog-ng-ctl stats prometheus
  

  Note that which metrics are shown depends on the current value of the stats(level()) global option (you can list the available metrics by running syslog-ng --metrics-registry). For details on what the metrics mean, see Metrics reference.

• Statistics are a legacy way to access the status of AxoSyslog. Metrics are newer and in active development. Many metrics aren’t available as legacy statistics.

  You can access legacy statistics using the following methods.

  • The syslog-ng-ctl query command gives structured access to the selected legacy statistics..
  • The syslog-ng-ctl stats command lists all the available legacy statistics in bulk.
  • Using the internal() source. We recommend using either of the previous two methods instead.

  For details about the available counters and the output format, see Statistics reference.