Kouhei Sutou
null+****@clear*****
Fri Sep 11 23:15:27 JST 2015
Kouhei Sutou 2015-09-11 23:15:27 +0900 (Fri, 11 Sep 2015) New Revision: 7e46382f8403b964808f3df826b78d0ddacb9de2 https://github.com/groonga/groonga/commit/7e46382f8403b964808f3df826b78d0ddacb9de2 Message: doc status: rewrite GitHub: fix #399 Reported by Hiroyuki Sato. Thanks!!! Modified files: doc/locale/ja/LC_MESSAGES/reference.po doc/source/example/reference/commands/status.log doc/source/reference/commands/status.rst Modified: doc/locale/ja/LC_MESSAGES/reference.po (+145 -21) =================================================================== --- doc/locale/ja/LC_MESSAGES/reference.po 2015-09-11 23:15:14 +0900 (6d3f90d) +++ doc/locale/ja/LC_MESSAGES/reference.po 2015-09-11 23:15:27 +0900 (6237042) @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: 1.2.1\n" "Report-Msgid-Bugs-To: \n" -"PO-Revision-Date: 2015-09-10 22:43+0900\n" +"PO-Revision-Date: 2015-09-11 23:08+0900\n" "Last-Translator: Masafumi Yokoyama <yokoyama �� clear-code.com>\n" "Language-Team: Japanese\n" "Language: ja\n" @@ -9565,40 +9565,167 @@ msgstr "" msgid "``status``" msgstr "" -msgid "status - groongaプロセスの状態表示" +msgid "" +"``status`` returns the current status of the context that processes the " +"request." msgstr "" +"``status`` はこのリクエストを処理しているコンテキストの現在のステータスを返し" +"ます。" msgid "" -"Groonga組込コマンドの一つであるstatusについて説明します。組込コマンドは、" -"groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリク" -"エストを送信することによって実行します。" +"Context is an unit that processes requests. Normally, context is created for " +"each thread." +msgstr "" +"コンテキストはリクエストを処理する単位です。通常、各スレッドごとにコンテキス" +"トを作ります。" + +msgid "Here is a simple example:" +msgstr "以下は簡単な使用例です。" + +# e00eb783c12c44c2b3e718c8bac4c690 +msgid "" +"It returns the current status of the context that processes the request. " +"See :ref:`status-return-value` for details." msgstr "" +"このリクエストを処理しているコンテキストの現在のステータスを返します。詳細" +"は :ref:`status-return-value` を参照してください。" + +msgid "The command returns the current status as an object::" +msgstr "このコマンドはオブジェクトとして現在のステータスを返します。::" msgid "" -"statusコマンドは、groongaプロセスの状態を表示します。主にgroongaサーバプロセ" -"スに対して使用することを想定しています。" +"Here are descriptions about values. See :ref:`status-usage` for real values:" msgstr "" +"以下は値の説明です。実際の値は :ref:`status-usage` を参照してください。" + +msgid "Key" +msgstr "キー" msgid "``alloc_count``" msgstr "" msgid "" -"groongaプロセスの内部でアロケートされ、まだ解放されてないメモリブロックの数を" -"示します。Groongaをbuildする際に、configureオプションで --enable-exact-alloc-" -"countが指定されていたならば、正確な値を返します。それ以外の場合は不正確な値を" -"返す場合があります。" +"The number of allocated memory blocks that aren't freed. If this value is " +"continuously increased, there may be a memory leak." msgstr "" +"まだ解放されていないメモリーブロックの数です。もし、この値が継続的に増えて" +"いっているならメモリーリークがあるかもしれません。" -msgid "``starttime``" -msgstr "開始時間" +msgid "``1400``" +msgstr "" -msgid "groongaプロセスが起動した時刻のtvsec値を返します。" +msgid "``cache_hit_rate``" msgstr "" +msgid "" +"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." +msgstr "" +"このGroongaプロセスがキャッシュを使って返したレスポンスの割合です。もし、10リ" +"クエストのうち7つのレスポンスはキャッシュを使ったなら、 ``cache_hit_rate`` " +"は ``70.0`` になります。この割合はキャッシュをサポートしているコマンドを使っ" +"たリクエストのみで計算します。" + +msgid "Here are commands that support cache:" +msgstr "以下はキャッシュをサポートしているコマンドです。" + +msgid ":doc:`logical_select`" +msgstr "" + +msgid ":doc:`logical_range_filter`" +msgstr "" + +msgid ":doc:`logical_count`" +msgstr "" + +msgid "``29.4``" +msgstr "" + +msgid "``command_version``" +msgstr "" + +msgid "" +"The :doc:`/reference/command/command_version` that is used by the context." +msgstr "" +"このコンテキストが使っている :doc:`/reference/command/command_version` です。" + +msgid "``1``" +msgstr "" + +msgid "``default_command_version``" +msgstr "" + +msgid "" +"The default :doc:`/reference/command/command_version` of the Groonga process." +msgstr "" +"このGroongaプロセスのデフォルト :doc:`/reference/command/command_version` で" +"す。" + +msgid "``max_command_version``" +msgstr "" + +msgid "" +"The max :doc:`/reference/command/command_version` of the Groonga process." +msgstr "" +"このGroongaプロセスがサポートしている最大 :doc:`/reference/command/" +"command_version` です。" + +msgid "``2``" +msgstr "" + +msgid "``n_queries``" +msgstr "" + +msgid "" +"The number of requests processed by the Groonga process. It counts only " +"requests that use commands that support cache." +msgstr "" +"このGroongaプロセスが処理したリクエスト数です。ただし、キャッシュをサポートし" +"たコマンドを使ったリクエストだけを数えます。" + +msgid "``29``" +msgstr "" + +msgid "``start_time``" +msgstr "" + +msgid "The time that the Groonga process started in UNIX time." +msgstr "このGroongaプロセスが起動した時間です。UNIX時間です。" + +msgid "``1441761403``" +msgstr "" + +msgid "``starttime``" +msgstr "" + +msgid "Use ``start_time`` instead." +msgstr "代わりに ``start_time`` を使ってください。" + msgid "``uptime``" -msgstr "稼動時間" +msgstr "" + +msgid "The elapsed time since the Groonga process started in second." +msgstr "このGroongaプロセスが起動してから経過した時間です。単位は秒です。" -msgid "groongaプロセスが起動してから経過した秒数を返します。" +msgid "" +"For example, ``216639`` means that ``2.5`` (= ``216639 / 60 / 60 / 24 = " +"2.507``) days." +msgstr "" +"たとえば、 ``216639`` は ``2.5`` （= ``216639 / 60 / 60 / 24 = 2.507`` ）日と" +"いう意味です。" + +msgid "``216639``" +msgstr "" + +msgid "``version``" +msgstr "" + +msgid "The version of the Groonga process." +msgstr "このGroongaプロセスのバージョンです。" + +msgid "``5.0.7``" msgstr "" msgid "``suggest``" @@ -10483,8 +10610,8 @@ msgid "" "and the table is removed, tables and columns that refer the table are broken." msgstr "" "どちらのケースも参照先がなくなることを防ぎます。もし、削除対象のテーブルが型" -"として参照されているままそのテーブルが削除されてしまうと、そのテーブルを参" -"照しているテーブルとカラムは壊れてしまいます。" +"として参照されているままそのテーブルが削除されてしまうと、そのテーブルを参照" +"しているテーブルとカラムは壊れてしまいます。" msgid "" "If the target table satisfies one of them, ``table_remove`` is failed. The " @@ -12402,9 +12529,6 @@ msgstr "" msgid "There are required parameters which depends on type of query." msgstr "必須の引数があります。どれが必須かはクエリーの種類に依存します。" -msgid "Key" -msgstr "" - msgid "Note" msgstr "" Modified: doc/source/example/reference/commands/status.log (+6 -5) =================================================================== --- doc/source/example/reference/commands/status.log 2015-09-11 23:15:14 +0900 (0a8486a) +++ doc/source/example/reference/commands/status.log 2015-09-11 23:15:27 +0900 (44524fc) @@ -8,14 +8,15 @@ Execution example:: # 0.000355720520019531 # ], # { - # "uptime": 1, + # "uptime": 0, # "max_command_version": 2, - # "n_queries": 0, + # "start_time": 1441980651, # "cache_hit_rate": 0.0, - # "version": "5.0.6-128-g8029ddb", + # "version": "5.0.7-126-gb6fd7f7", # "alloc_count": 206, # "command_version": 1, - # "starttime": 1439994621, - # "default_command_version": 1 + # "starttime": 1441980651, + # "default_command_version": 1, + # "n_queries": 0 # } # ] Modified: doc/source/reference/commands/status.rst (+117 -21) =================================================================== --- doc/source/reference/commands/status.rst 2015-09-11 23:15:14 +0900 (0beb42e) +++ doc/source/reference/commands/status.rst 2015-09-11 23:15:27 +0900 (2f8b0d7) @@ -2,7 +2,8 @@ .. highlightlang:: none -.. _command-status: +.. groonga-command +.. database: commands_status ``status`` ========== @@ -10,46 +11,141 @@ Summary ------- -status - groongaプロセスの状態表示 - -Groonga組込コマンドの一つであるstatusについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。 +``status`` returns the current status of the context that processes +the request. -statusコマンドは、groongaプロセスの状態を表示します。主にgroongaサーバプロセスに対して使用することを想定しています。 +Context is an unit that processes requests. Normally, context is +created for each thread. Syntax ------ -:: - status +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. -Return value ------------- - -:: - - 下記の項目がハッシュ形式で出力されます。 +Required parameters +^^^^^^^^^^^^^^^^^^^ -``alloc_count`` +There is no required parameters. - groongaプロセスの内部でアロケートされ、まだ解放されてないメモリブロックの数を示します。Groongaをbuildする際に、configureオプションで --enable-exact-alloc-countが指定されていたならば、正確な値を返します。それ以外の場合は不正確な値を返す場合があります。 +Optional parameters +^^^^^^^^^^^^^^^^^^^ -``starttime`` +There is no optional parameters. - groongaプロセスが起動した時刻のtvsec値を返します。 +.. _status-return-value: -``uptime`` - - groongaプロセスが起動してから経過した秒数を返します。 +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 + } + ] + +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`` -------------- next part -------------- HTML����������������������������...下載
