Redis

Redis 統合では、パフォーマンスと使用状況に関連する指標を収集します。パフォーマンス指標は、CPU、メモリ、ネットワークスループットの状況を表し、使用状況の指標はキー、コマンド、レプリケーションの状況を表します。この統合では、Redis ログも収集され、JSON ペイロードが生成されます。このプロセス中に、ロールとレベルのシンボルは、人が読める形式に変換されます。

Redis の詳細については、Redis のドキュメントをご覧ください。

前提条件

Redis テレメトリーを収集するには、Ops エージェントをインストールする必要があります。

指標の場合は、バージョン 2.7.0 以降をインストールします。
ログの場合は、バージョン 2.5.0 以降をインストールします。

この統合は Redis バージョン 6.2 に対応しています。

Redis 用の Ops エージェントを構成する

Ops エージェントの構成のガイドに従って、Redis インスタンスからテレメトリーを収集するために必要な要素を追加し、エージェントを再起動します。

構成の例

次のコマンドは、Redis のテレメトリーを収集して取り込み、Ops エージェントを再起動するための構成を作成します。

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    redis:
      type: redis
  service:
    pipelines:
      redis:
        receivers:
        - redis
logging:
  receivers:
    redis:
      type: redis
  service:
    pipelines:
      redis:
        receivers:
        - redis
EOF

sudo service google-cloud-ops-agent restart
sleep 60

ログの収集を構成する

Redis からログを取り込むには、Redis が生成するログのレシーバを作成し、新しいレシーバのパイプラインを作成する必要があります。

redis ログのレシーバを構成するには、次のフィールドを指定します。

フィールド	デフォルト	説明
`exclude_paths`		`include_paths` の照合で除外するファイルシステムパスのパターンのリスト。
`include_paths`	`[/var/log/redis/redis-server.log, /var/log/redis_6379.log, /var/log/redis/redis.log, /var/log/redis/default.log, /var/log/redis/redis_6379.log]`	各ファイルのテーリングで読み込むファイルシステムのパスのリスト。パスには /var/log/redis/.log のように、ワイルドカード（``）を使用できます。
`record_log_file_path`	`false`	`true` に設定すると、ログレコードの取得元のファイルのパスが `agent.googleapis.com/log_file_path` ラベルの値として出力ログエントリに表示されます。ワイルドカードを使用する場合、レコードを取得したファイルのパスのみが記録されます。
`type`		値は、`redis` にする必要があります。
`wildcard_refresh_interval`	`60s`	include_paths のワイルドカードファイルパスの更新間隔。time.ParseDuration によって解析可能な時間として指定します（例: `30s` または `2m`）。このプロパティは、ログファイルのローテーションがデフォルトよりも短い間隔で実施され、ロギングのスループットが高い場合に有用な可能性があります。

ログの内容

logName は、構成で指定されたレシーバ ID から取得されます。LogEntry 内の詳細なフィールドは、次のとおりです。

redis ログの LogEntry には次のフィールドが含まれます。

フィールド	タイプ	説明
`jsonPayload.level`	文字列	ログエントリレベル
`jsonPayload.message`	文字列	ログメッセージ（指定した場合の詳細なスタックトレースを含む）
`jsonPayload.pid`	数値	ログを発行するプロセス ID
`jsonPayload.role`	文字列	Redis ロール文字（sentinel、RDB/AOF_writing_child、slave、master）から変換
`jsonPayload.roleChar`	文字列	Redis ロール文字（X、C、S、M）
`severity`	文字列（`LogSeverity`）	ログエントリレベル（変換済み）。

指標の収集を構成する

Redis から指標を取り込むには、Redis が生成する指標のレシーバーを作成してから、新しいレシーバー用のパイプラインを作成する必要があります。

このレシーバーでは、複数のエンドポイントのモニタリングなど、構成で複数のインスタンスを使用することはできません。このようなインスタンスはすべて同じ時系列に書き込まれるため、Cloud Monitoring ではインスタンスを区別できません。

redis 指標のレシーバーを構成するには、次のフィールドを指定します。

フィールド	デフォルト	説明
`address`	`localhost:6379`	Redis によって公開される URL。
`ca_file`		CA 証明書のパス。クライアントとして、これによりサーバー証明書が検証されます。空の場合、レシーバはシステムルート CA を使用します。
`cert_file`		mTLS で必要な接続に使用する TLS 証明書のパス。
`collection_interval`	`60s`	期間の値（例: `30s`、`5m`）。
`insecure`	`true`	セキュア TLS 接続を使用するかどうかを設定します。`false` に設定すると、TLS が有効になります。
`insecure_skip_verify`	`false`	証明書の検証をスキップするかどうかを指定します。`insecure` が `true` に設定されている場合、`insecure_skip_verify` 値は使用されません。
`key_file`		mTLS で必要な接続に使用する TLS キーのパス。
`password`		サーバーへの接続に使用するパスワード。
`type`		値は、`redis` にする必要があります。

モニタリング対象

次の表に、Ops エージェントが Redis インスタンスから収集する指標の一覧を示します。

指標タイプ
種類、タイプモニタリング対象リソース	ラベル
`workload.googleapis.com/redis.clients.blocked`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.clients.connected`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.clients.max_input_buffer`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.clients.max_output_buffer`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.commands.processed`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.connections.received`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.connections.rejected`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.cpu.time`
`CUMULATIVE`、`DOUBLE` gce_instance	`state`
`workload.googleapis.com/redis.keys.evicted`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.keys.expired`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.keyspace.hits`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.keyspace.misses`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.latest_fork`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.memory.fragmentation_ratio`
`GAUGE`、`DOUBLE` gce_instance
`workload.googleapis.com/redis.memory.lua`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.memory.peak`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.memory.rss`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.memory.used`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.net.input`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.net.output`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/redis.rdb.changes_since_last_save`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.replication.backlog_first_byte_offset`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.replication.offset`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/redis.slaves.connected`
`GAUGE`、`INT64` gce_instance

構成を確認する

このセクションでは、Redis レシーバが正しく構成されていることを確認する方法について説明します。Ops エージェントがテレメトリーの収集を開始するまでに 1～2 分かかる場合があります。

Redis ログが Cloud Logging に送信されていることを確認するには、次のようにします。

Google Cloud コンソールのナビゲーションパネルで、[ロギング] を選択してから、[ログエクスプローラ] を選択します。
[ログエクスプローラ] に移動
エディタに次のクエリを入力し、[クエリを実行] をクリックします。
```
resource.type="gce_instance"
log_id("redis")
```

Redis 指標が Cloud Monitoring に送信されていることを確認するには、次のようにします。

Google Cloud コンソールのナビゲーションパネルでモニタリングを選択し、次に Metrics Explorer を選択します。
Metrics Explorer に移動
クエリビルダーペインのツールバーで、名前が [MQL] または [PromQL] のボタンを選択します。
[言語] 切り替えで [MQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定を行うのと同じツールバーにあります。

エディタに次のクエリを入力し、[クエリを実行] をクリックします。

fetch gce_instance
| metric 'workload.googleapis.com/redis.clients.max_input_buffer'
| every 1m

ダッシュボードを表示する

Redis 指標を表示するには、グラフまたはダッシュボードが構成されている必要があります。Redis インテグレーションには、1 つ以上のダッシュボードが含まれています。インテグレーションを構成して Ops エージェントが指標データの収集を開始すると、ダッシュボードは自動的にインストールされます。

インテグレーションをインストールすることなく、ダッシュボードの静的プレビューを表示することもできます。

インストールされているダッシュボードを表示する手順は次のとおりです。

Google Cloud コンソールのナビゲーションパネルで、[Monitoring] を選択してから、[ダッシュボード] を選択します。
[ダッシュボード] に移動
[ダッシュボードリスト] タブを選択し、[統合] カテゴリを選択します。
表示するダッシュボードの名前をクリックします。

インテグレーションを構成してもダッシュボードがインストールされていない場合は、Ops エージェントが実行されていることを確認します。ダッシュボードにグラフの指標データがない場合、ダッシュボードのインストールは失敗します。Ops エージェントが指標の収集を開始した後に、ダッシュボードがインストールされます。

ダッシュボードの静的プレビューを表示する手順は次のとおりです。

Google Cloud コンソールのナビゲーションパネルで、[Monitoring] を選択してから、[インテグレーション] を選択します。
[インテグレーション] に移動
[デプロイメントプラットフォーム] フィルタの [Compute Engine] をクリックします。
Redis のエントリを見つけて、[詳細を表示] をクリックします。
[ダッシュボード] タブを選択すると、静的プレビューが表示されます。ダッシュボードがインストールされている場合は、[ダッシュボードを表示] をクリックして移動できます。

Cloud Monitoring のダッシュボードについて詳しくは、ダッシュボードとグラフをご覧ください。

[インテグレーション] ページの使用方法については、インテグレーションを管理するをご覧ください。

アラートポリシーをインストールする

アラートポリシーは、指定した条件が成立した際に通知するように Cloud Monitoring に指示します。Redis インテグレーションには、使用する 1 つ以上のアラートポリシーが含まれています。これらのアラートポリシーは、Monitoring の [インテグレーション] ページで表示してインストールできます。

使用可能なアラートポリシーの説明を表示してインストールする手順は次のとおりです。

Google Cloud コンソールのナビゲーションパネルで、[Monitoring] を選択してから、[インテグレーション] を選択します。
[インテグレーション] に移動
Redis のエントリを見つけて、[詳細を表示] をクリックします。
[アラート] タブを選択します。このタブには、利用可能なアラートポリシーの説明と、それらをインストールするためのインターフェースが表示されます。
アラートポリシーをインストールします。アラートポリシーでは、アラートがトリガーされた通知の送信先を特定する必要があるため、インストール環境の情報が必要になります。アラートポリシーをインストールする手順は次のとおりです。
1. 利用可能なアラートポリシーのリストから、インストールするアラートポリシーを選択します。
2. [通知の構成] セクションで、1 つ以上の通知チャンネルを選択します。通知チャンネルの使用を無効にすることもできますが、無効にすると、アラートポリシーは通知なく起動します。Monitoring でステータスを確認できますが、通知は受信しません。
  
  通知チャンネルの詳細については、通知チャンネルを管理するをご覧ください。
3. [ポリシーの作成] をクリックします。

Cloud Monitoring のアラートポリシーの詳細については、アラートの概要をご覧ください。