1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
.. -*- rst -*-
.. groonga-command
.. database: commands_status
``status``
==========
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.
Syntax
------
This command takes no parameters::
status
.. _status-usage:
Usage
-----
Here is a simple example:
.. groonga-command
.. include:: ../../example/reference/commands/status.log
.. status
It returns the current status of the context that processes the
request. See :ref:`status-return-value` for details.
Parameters
----------
This section describes all parameters.
Required parameters
^^^^^^^^^^^^^^^^^^^
There is no required parameter.
Optional parameters
^^^^^^^^^^^^^^^^^^^
There is no optional parameter.
.. _status-return-value:
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,
"n_jobs": N_JOBS,
"features": FEATURES,
"apache_arrow": APACHE_ARROW_INFORMATION,
"memory_map_size": MEMORY_MAP_SIZE,
"n_workers": N_WORKERS,
"default_n_workers": DEFAULT_N_WORKERS,
"os": OS,
"cpu": CPU_N_WORKERS
}
]
See :doc:`/reference/command/output_format` for ``HEADER``.
Here are descriptions about values. See :ref:`status-usage` for real
values:
.. list-table::
:header-rows: 1
* - 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:
* :doc:`select`
* :doc:`logical_select`
* :doc:`logical_range_filter`
* :doc:`logical_count`
- ``29.4``
* - ``command_version``
- The :doc:`/reference/command/command_version` that is used by
the context.
- ``1``
* - ``default_command_version``
- The default :doc:`/reference/command/command_version` of the
Groonga process.
- ``1``
* - ``max_command_version``
- The max :doc:`/reference/command/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:
* :doc:`select`
* :doc:`logical_select`
* :doc:`logical_range_filter`
* :doc:`logical_count`
- ``29``
* - ``start_time``
- .. versionadded:: 5.0.8
The time that the Groonga process started in UNIX time.
- ``1441761403``
* - ``starttime``
- .. deprecated:: 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``
* - ``n_jobs``
- The number of unprocessed jobs.
- ``0``
* - ``features``
- .. versionadded:: 10.0.1
The list of Groonga's features and status (enabled or disabled).
- .. code-block::
{
"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,
"blosc": true,
"back_trace": true,
"reference_count": false
}
* - ``apache_arrow``
- .. versionadded:: 10.0.1
The information about Apache Arrow that Groonga currently uses. It's only displayed when Apache Arrow is enabled.
- .. code-block::
{
"version_major": 2,
"version_minor": 0,
"version_patch": 0,
"version": "2.0.0"
}
* - ``memory_map_size``
- The total mapped memory size by this Groonga process in bytes.
- ``2929``
* - ``n_workers``
- .. versionadded:: 13.1.2
The value of ``n_workers`` set in this context.
- ``0``
* - ``default_n_workers``
- .. versionadded:: 13.1.2
The default ``n_workers`` value of the Groonga process.
- ``0``
* - ``os``
- .. versionadded:: 14.0.8
The OS name.
- ``Linux``, ``Darwin``, ``Windows`` and so on
* - ``cpu``
- .. versionadded:: 14.0.8
The CPU architecture name.
- ``x86_64``, ``arm64`` and so on
|
