Nebulex.Adapters.Common.Info (Nebulex v3.0.0-rc.1)

View Source

A simple/default implementation for Nebulex.Adapter.Info behaviour.

The implementation defines the following information specifications:

  • :server - A map with general information about the cache server. Includes the following keys:

    • :nbx_version - The Nebulex version.
    • :cache_module - The defined cache module.
    • :cache_adapter - The cache adapter.
    • :cache_name - The cache name.
    • :cache_pid - The cache PID.
  • :stats - A map with the cache statistics keys, as specified by Nebulex.Adapters.Common.Info.Stats.

The info data will look like this:

%{
  server: %{
    nbx_version: "3.0.0",
    cache_module: "MyCache",
    cache_adapter: "Nebulex.Adapters.Local",
    cache_name: "MyCache",
    cache_pid: #PID<0.111.0>
  },
  stats: %{
    deletions: 0,
    evictions: 0,
    expirations: 0,
    hits: 0,
    misses: 0,
    updates: 0,
    writes: 0
  }
}