Metric collection

BookKeeper enables metrics collection through a variety of stats providers.

For a full listing of available metrics, see the Metrics reference doc.

Stats providers

BookKeeper has stats provider implementations for these sinks:

Provider	Provider class name
Codahale Metrics	org.apache.bookkeeper.stats.CodahaleMetricsProvider
Prometheus	org.apache.bookkeeper.stats.prometheus.PrometheusMetricsProvider

The Codahale Metrics stats provider is the default provider.

Enabling stats providers in bookies

There are two stats-related configuration parameters available for bookies:

Parameter	Description	Default
enableStatistics	Whether statistics are enabled for the bookie	false
statsProviderClass	The stats provider class used by the bookie	org.apache.bookkeeper.stats.CodahaleMetricsProvider

To enable stats:

• set the enableStatistics parameter to true
• set statsProviderClass to the desired provider (see the table above for a listing of classes)