Search:

Search all manuals
Search this manual
Manual
Couchbase Server Manual 2.0
Community Wiki and Resources
Download Couchbase Server 2.0
Couchbase Developer Guide 2.0
Client Libraries
Couchbase Server Forum
Additional Resources
Community Wiki
Community Forums
Couchbase SDKs
Parent Section
7.5 cbstats Tool
Chapter Sections
Chapters

7.5.2. Getting Warmup Information

Be aware that this tool is a per-node, per-bucket operation. That means that if you want to perform this operation, you must specify the IP address of a node in the cluster and a named bucket. If you do not provided a named bucket, the server will apply the setting to any default bucket that exists at the specified node. If you want to perform this operation for an entire cluster, you will need to perform the command for every node/bucket combination that exists for that cluster.

You can use cbstats to get information about server warmup, including the status of warmup and whether warmup is enabled. The following are two alternates to filter for the information:

cbstats hostname:port -b bucket1 -p bucket_password | grep 'warmup'

cbstats hostname:port -b bucket1 -p bucket_password raw warmup
ep_warmup_threadIndicates if the warmup has completed. Returns "running" or "complete".
ep_warmup_stateIndicates the current progress of the warmup:
  • Initial. Start warmup processes.

  • EstimateDatabaseItemCount. Estimating database item count.

  • KeyDump. Begin loading keys and metadata, but not documents, into RAM.

  • CheckForAccessLog. Determine if an access log is available. This log indicates which keys have been frequently read or written.

  • LoadingAccessLog. Load information from access log.

  • LoadingData. This indicates the server is loading data first for keys listed in the access log, or if no log available, based on keys found during the 'Key Dump' phase.

  • Done. Server is ready to handle read and write requests.

High-level warmup statistics that are available are as follows:

NameDescriptionValue Type
ep_warmup_dupsNumber of failures due to duplicate keysInteger
ep_warmup_estimated_key_countEstimated number of keys in databaseInteger (DEFAULT = "unknown")
ep_warmup_estimated_value_countEstimated number of key data to read based on the access logInteger (DEFAULT = "unknown")
ep_warmup_keys_timeTotal time spent by loading persisted keysInteger
ep_warmup_min_item_thresholdEnable data traffic after loading this number of key dataInteger
ep_warmup_min_memory_thresholdEnable data traffic after filling this % of memoryInteger (%)
ep_warmup_oomNumber of out of memory failures during warmupInteger
ep_warmup_stateWhat is current warmup stateString, refer to WarmupStateTable
ep_warmup_threadIs warmup running?String ("running", "complete")
ep_warmup_timeTotal time spent by loading data (warmup)Integer (milliseconds)

There are also additional lower-level, detailed statistics returned by passing the keyword "warmup" for the command. For instance:

cbstats hostname:port -p bucketname -b bucket_password raw warmup

The additional lower-level stats are as follows. Note that some of these items are also available as higher-level summary statistics about warmup:

NameDescriptionValue Type
ep_warmupIs warmup enabled?String ("enabled")
ep_warmup_key_countHow many keys have been loaded?Integer
ep_warmup_value_countHow many key values (data) have been loaded?Integer
ep_warmup_dupsNumber of failures due to duplicate keysInteger
ep_warmup_estimated_key_countEstimated number of keys in databaseInteger (DEFAULT = "unknown")
ep_warmup_estimated_value_countEstimated number of key data to read based on the access logInteger (DEFAULT = "unknown")
ep_warmup_keys_timeTotal time spent by loading persisted keysInteger
ep_warmup_min_item_thresholdEnable data traffic after loading this number of key dataInteger
ep_warmup_min_memory_thresholdEnable data traffic after filling this % of memoryInteger (%)
ep_warmup_oomNumber of out of memory failures during warmupInteger
ep_warmup_stateWhat is current warmup stateString, refer to WarmupStateTable
ep_warmup_threadIs warmup running?String ("running", "complete")
ep_warmup_timeTotal time spent by loading data (warmup)Integer (milliseconds)