7.3.59. status — Groonga v14.1.2ドキュメント

本文へスキップ
`Ctrl`+`K`

# 7.3.59. `status`

## 7.3.59.1. 概要

`status` はこのリクエストを処理しているコンテキストの現在のステータスを返します。

コンテキストはリクエストを処理する単位です。通常、各スレッドごとにコンテキストを作ります。

## 7.3.59.2. 構文

このコマンドに引数はありません:

    status

## 7.3.59.3. 使い方

以下は簡単な使用例です。

実行例:

    status
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   {
    #     "alloc_count": 29,
    #     "starttime": 1696558618,
    #     "start_time": 1696558618,
    #     "uptime": 0,
    #     "version": "2.9.1",
    #     "n_queries": 0,
    #     "cache_hit_rate": 0.0,
    #     "command_version": 1,
    #     "default_command_version": 1,
    #     "max_command_version": 3,
    #     "n_jobs": 0,
    #     "features": {
    #       "nfkc": true,
    #       "mecab": true,
    #       "message_pack": true,
    #       "mruby": true,
    #       "onigmo": true,
    #       "zlib": true,
    #       "lz4": true,
    #       "zstandard": true,
    #       "kqueue": false,
    #       "epoll": true,
    #       "poll": false,
    #       "rapidjson": false,
    #       "apache_arrow": true,
    #       "xxhash": true,
    #       "blosc": true,
    #       "bfloat16": true,
    #       "h3": true,
    #       "simdjson": true,
    #       "llama.cpp": true,
    #       "back_trace": true,
    #       "reference_count": false
    #     },
    #     "apache_arrow": {
    #       "version_major": 2,
    #       "version_minor": 9,
    #       "version_patch": 1,
    #       "version": "2.9.1"
    #     },
    #     "memory_map_size": 2929,
    #     "n_workers": 0,
    #     "default_n_workers": 0,
    #     "os": "Linux",
    #     "cpu": "x86_64"
    #   }
    # ]

このリクエストを処理しているコンテキストの現在のステータスを返します。詳細は 戻り値 を参照してください。

## 7.3.59.4. 引数

このセクションではすべての引数について説明します。

### 7.3.59.4.1. 必須引数

必須の引数はありません。

### 7.3.59.4.2. 省略可能引数

省略可能な引数はありません。

## 7.3.59.5. 戻り値

このコマンドはオブジェクトとして現在のステータスを返します。:

    [
      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
      }
    ]

`HEADER` については 出力形式 を参照してください。

以下は値の説明です。実際の値は 使い方 を参照してください。

キー | 説明 | 例
--- | --- | ---
`alloc_count` | まだ解放されていないメモリーブロックの数です。もし、この値が継続的に増えていっているならメモリーリークがあるかもしれません。 | `1400`
`cache_hit_rate` | このGroongaプロセスがキャッシュを使って返したレスポンスの割合です。もし、10リクエストのうち7つのレスポンスはキャッシュを使ったなら、 `cache_hit_rate` は `70.0` になります。この割合はキャッシュをサポートしているコマンドを使ったリクエストのみで計算します。 以下はキャッシュをサポートしているコマンドです。 select logical_select logical_range_filter logical_count | `29.4`
`command_version` | このコンテキストが使っている コマンドバージョン です。 | `1`
`default_command_version` | このGroongaプロセスのデフォルト コマンドバージョン です。 | `1`
`max_command_version` | このGroongaプロセスがサポートしている最大 コマンドバージョン です。 | `2`
`n_queries` | このGroongaプロセスが処理したリクエスト数です。ただし、キャッシュをサポートしたコマンドを使ったリクエストだけを数えます。 以下はキャッシュをサポートしているコマンドです。 select logical_select logical_range_filter logical_count | `29`
`start_time` | Added in version 5.0.8. このGroongaプロセスが起動した時間です。UNIX時間です。 | `1441761403`
`starttime` | バージョン 5.0.8 で非推奨: 代わりに `start_time` を使ってください。 | `1441761403`
`uptime` | このGroongaプロセスが起動してから経過した時間です。単位は秒です。 たとえば、 `216639` は `2.5` （= `216639 / 60 / 60 / 24 = 2.507` ）日という意味です。 | `216639`
`version` | このGroongaプロセスのバージョンです。 | `5.0.7`
`n_jobs` | 未処理のジョブ数です。 | `0`
`features` | Added in version 10.0.1. Groongaの機能と、その機能が有効かどうかの一覧です。 |
    {
       "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` | Added in version 10.0.1. Groongaの使用しているApache Arrowの情報です。Apache Arrowが有効な場合のみ表示されます。 |
    {
       "version_major": 2,
       "version_minor": 0,
       "version_patch": 0,
       "version": "2.0.0"
    }
`memory_map_size` | このGroongaプロセスのメモリーマップサイズの合計です。単位はバイトです。 | `2929`
`n_workers` | Added in version 13.1.2. このコンテキストで設定されている `n_workers` の値です。 | `0`
`default_n_workers` | Added in version 13.1.2. このGroongaプロセスのデフォルト `n_workers` の値です。 | `0`
`os` | Added in version 14.0.8. OS名です。 | `Linux` 、 `Darwin` 、 `Windows` など
`cpu` | Added in version 14.0.8. CPUのアーキテクチャー名です。 | `x86_64` 、 `arm64` など