MutexStats¶

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

admin/v2alpha/mutex_stats.proto

admin.v3.MutexStats¶

Proto representation of the statistics collected upon absl::Mutex contention, if Envoy is run under --enable-mutex-tracing. For more information, see the absl::Mutex [docs](https://abseil.io/about/design/mutex#extra-features).

NB: The wait cycles below are measured by absl::base_internal::CycleClock, and may not correspond to core clock frequency. For more information, see the CycleClock [docs](https://github.com/abseil/abseil-cpp/blob/master/absl/base/internal/cycleclock.h).

{
  "num_contentions": "...",
  "current_wait_cycles": "...",
  "lifetime_wait_cycles": "..."
}

num_contentions: (uint64) The number of individual mutex contentions which have occurred since startup.

current_wait_cycles: (uint64) The length of the current contention wait cycle.

lifetime_wait_cycles: (uint64) The lifetime total of all contention wait cycles.