7.3.58. status#

7.3.58.1. Summary#

status returns the current status of the context that processes the request.

Context is an unit that processes requests. Normally, context is created for each thread.

7.3.58.2. Syntax#

This command takes no parameters:

status

7.3.58.3. Usage#

Here is a simple example:

Execution example:

status
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "uptime": 0,
#     "n_jobs": 0,
#     "features": {
#       "onigmo": true,
#       "kqueue": false,
#       "epoll": true,
#       "mruby": true,
#       "nfkc": true,
#       "zlib": true,
#       "zstandard": true,
#       "mecab": true,
#       "lz4": true,
#       "xxhash": false,
#       "apache_arrow": true,
#       "poll": false,
#       "rapidjson": false,
#       "message_pack": true
#     },
#     "max_command_version": 3,
#     "start_time": 1660788276,
#     "cache_hit_rate": 0.0,
#     "memory_map_size": 99733504,
#     "version": "12.0.6-7-g92560bb",
#     "alloc_count": 410,
#     "command_version": 1,
#     "starttime": 1660788276,
#     "apache_arrow": {
#       "version_patch": 0,
#       "version_minor": 0,
#       "version": "9.0.0",
#       "version_major": 9
#     },
#     "default_command_version": 1,
#     "n_queries": 0
#   }
# ]

It returns the current status of the context that processes the request. See Return value for details.

7.3.58.4. Parameters#

This section describes all parameters.

7.3.58.4.1. Required parameters#

There is no required parameter.

7.3.58.4.2. Optional parameters#

There is no optional parameter.

7.3.58.5. Return value#

The command returns the current status as an object:

[
  HEADER,
  {
    "alloc_count": ALLOC_COUNT,
    "cache_hit_rate": CACHE_HIT_RATE,
    "command_version": COMMAND_VERSION,
    "default_command_version": DEFAULT_COMMAND_VERSION,
    "max_command_version": MAX_COMMAND_VERSION,
    "n_queries": N_QUERIES,
    "start_time": START_TIME,
    "starttime": STARTTIME,
    "uptime": UPTIME,
    "version": VERSION,
    "features": FEATURES,
    "apache_arrow": APACHE_ARROW_INFORMATION
  }
]

See Output format for HEADER.

Here are descriptions about values. See Usage for real values:

Key

Description

Example

alloc_count

The number of allocated memory blocks that aren’t freed. If this value is continuously increased, there may be a memory leak.

1400

cache_hit_rate

Percentage of cache used responses in the Groonga process. If there are 10 requests and 7 responses are created from cache, cache_hit_rate is 70.0. The percentage is computed from only requests that use commands that support cache.

Here are commands that support cache:

29.4

command_version

The Command version that is used by the context.

1

default_command_version

The default Command version of the Groonga process.

1

max_command_version

The max Command version of the Groonga process.

2

n_queries

The number of requests processed by the Groonga process. It counts only requests that use commands that support cache.

Here are commands that support cache:

29

start_time

New in version 5.0.8.

The time that the Groonga process started in UNIX time.

1441761403

starttime

Deprecated since version 5.0.8: Use start_time instead.

1441761403

uptime

The elapsed time since the Groonga process started in second.

For example, 216639 means that 2.5 (= 216639 / 60 / 60 / 24 = 2.507) days.

216639

version

The version of the Groonga process.

5.0.7

features

New in version 10.0.1.

The list of Groonga’s features and status (enabled or disabled).

{
   "nfkc": true,
   "mecab": true,
   "message_pack": true,
   "mruby": true,
   "onigmo": true,
   "zlib": true,
   "lz4": false,
   "zstandard": false,
   "kqueue": false,
   "epoll": true,
   "poll": false,
   "rapidjson": false,
   "apache_arrow": false,
   "xxhash": false
}

apache_arrow

New in version 10.0.1.

The information about Apache Arrow that Groonga currently uses. It’s only displayed when Apache Arrow is enabled.

{
   "version_major": 2,
   "version_minor": 0,
   "version_patch": 0,
   "version": "2.0.0"
}