Couchbaseモニタリングの統合

当社のCouchbase 統合は、Couchbaseクラスタからインベントリとメトリックデータを収集してNew Relicプラットフォームに送信し、Couchbase環境の健全性を素早く確認することができます。クラスタ、ノード、クエリエンジン、バケットの各レベルでデータを収集するので、問題の発生源を追跡することができます。

統合をインストールし、収集するデータを確認するために読んでください。

互換性と要件

当社のインテグレーションは、Couchbaseバージョン4.0以上に対応しています。

統合をインストールする前に、次の要件を満たしていることを確認してください。

CouchbaseがKubernetesで実行されていない場合は、Couchbaseを実行しているホストにインフラストラクチャエージェントをインストールする必要があります。さもないと：
- Kubernetesで実行している場合は、これらの要件を参照してください。
- ECSで実行している場合は、これらの要件を参照してください。

クイックスタート

ガイド付きインストールで、Couchbaseクラスタを迅速にインスツルメントし、遠隔測定データを送信します。ガイド付きインストールでは、お客様の環境に合わせてカスタマイズしたCLIコマンドを作成し、New Relic CLIとインフラストラクチャ・エージェントをダウンロードしてインストールします。

始める準備はできましたか？これらのボタンのいずれかをクリックして試してください。

ガイド付きインストール

EUガイド付きインストール

ガイド付きインストールでは、インフラストラクチャ・エージェントを使用してCouchbaseの統合を設定します。それだけでなく、あなたの環境で稼働している他のアプリケーションやログ・ソースを発見し、どのようなものを導入すべきかを推奨します。

ガイド付きインストールは、ほとんどのセットアップで動作します。しかし、それがあなたのニーズに合わない場合は、あなたのCouchbaseクラスタの監視を開始するために以下の他の方法を見つけることができます。

インストールしてアクティブ化する

Couchbaseインテグレーションをインストールするには、お使いの環境の指示に従ってください。

インフラストラクチャエージェントをインストールし、 INTEGRATION_FILE_NAME変数をnri-couchbaseに置き換えます。
ディレクトリを統合フォルダに変更します。
```
cd /etc/newrelic-infra/integrations.d
```

サンプル構成ファイルのコピー：

sudo cp couchbase-config.yml.sample couchbase-config.yml

構成設定の説明に従って、 couchbase-config.ymlファイルを編集します。
インフラストラクチャエージェントを再起動します。

nri-couchbase .MSIインストーラーイメージを以下からダウンロードします。
https://download.newrelic.com/infrastructure_agent/windows/integrations/nri-couchbase/nri-couchbase-amd64.msi
Windowsコマンドプロンプトからインストールするには、次のコマンドを実行します。
```
msiexec.exe /qn /i PATH\TO\nri-couchbase-amd64.msi
```
IntegrationsディレクトリC:\Program Files\New Relic\newrelic-infra\integrations.d\で、次のコマンドを実行してサンプル構成ファイルのコピーを作成します。
```
cp couchbase-config.yml.sample couchbase-config.yml
```
構成設定の説明に従って、 couchbase-config.ymlファイルを編集します。
インフラストラクチャエージェントを再起動します。

その他の注意事項：

高度：統合はtarball形式でも利用可能であり、パッケージマネージャーの外部にインストールできます。
オンホスト統合は自動的に更新されません。最良の結果を得るには、統合パッケージとインフラストラクチャエージェントを定期的に更新してください。

このドキュメントはインストールで役立ちましたか。

構成

統合を構成する

インストール方法に応じて、統合を構成する方法はいくつかあります。

Kubernetes経由で有効になっている場合： Kubernetesで実行されているサービスの監視をご覧ください。
Amazon ECSを介して有効になっている場合： ECSで実行されている監視サービスを参照してください。
ホストにインストールされている場合：統合のYAML構成ファイルcouchbase-config.ymlの構成を編集します。

統合のYAML形式の構成では、必要なログイン資格情報を配置し、データの収集方法を構成できます。どのオプションを変更するかは、セットアップと設定によって異なります。

構成ファイルには、 interval 、 timeout 、 inventory_sourceなどのすべての統合に適用できる共通の設定があります。これらの一般的な設定についてすべて読むには、構成フォーマットのドキュメントを参照してください。

重要

従来の構成/定義ファイルをまだ使用している場合は、このドキュメントを参照してください。

Couchbase に関連する特定の設定は、構成ファイルのenvセクションを使用して定義されます。これらの設定は、Couchbase インスタンスへの接続、およびその他のセキュリティ設定と機能を制御します。有効な設定のリストについては、このドキュメントの次のセクションで説明します。

Couchbase インスタンスの設定

Couchbaseインテグレーションは、メトリクス(M)とインベントリ(I)の両方の情報を収集します。表の中で、 Applies To 列を使って、各コレクションで利用できる設定を確認してください。

'' '' '' '' '' '' '' '' '' '' '' '' ''

設定	説明	デフォルト	に適用されます
ホスト名	Couchbaseが稼働しているホスト名またはIP。	ローカルホスト	M / I
ポート	Couchbase APIがリスニングしているポート。	8091	M / I
QUERY_PORT	Couchbase N1QLサービスが待ち受けているポート。	8093	M / I
ユーザー名	Couchbase APIにアクセスするためのユーザー名です。	該当なし	M / I
パスワード	指定されたユーザーのパスワード。	該当なし	M / I
USE_SSL	Couchbaseとの通信にSSLを使用します。	false	M / I
CA_BUNDLE_FILE	ホスト上のSSL証明書の場所。 `USE_SSL`がtrueの場合にのみ必要です。	該当なし	M / I
CA_BUNDLE_DIR	代替認証局バンドルディレクトリ。	該当なし	M / I
タイムアウト	APIリクエストのタイムアウト（秒単位）。	30	M / I
ENABLE_BUCKETS	trueの場合、バケットのリソースを収集します。	true	M
バケット統計の有効化	trueの場合、追加のバケット統計を収集します。	true	M
クラスタとノードの有効化	trueの場合、クラスタとノードのリソースを収集します。	true	M
METRICS	メトリックのみの収集を有効にするには、 `true`に設定します。	false
在庫	インベントリのみの収集を有効にするには、 `true`に設定します。	false

これらの設定の値は、いくつかの方法で定義できます。

設定ファイルに直接値を追加します。これが最も一般的な方法です。
{{}}表記を使用して環境変数の値を置き換えます。これには、インフラストラクチャエージェントv1.14.0以降が必要です。詳細については、こちらをご覧になるか、以下の例をご覧ください。
シークレット管理を使用します。これを使用して、構成ファイルにプレーンテキストで公開されるパスワードなどの機密情報を保護します。詳細については、シークレット管理を参照してください。

ラベル/カスタム属性

ラベルを使用して、メトリックをさらに装飾できます。ラベルを使用すると、キーと値のペアの属性をメトリックに追加できます。これを使用して、メトリックをクエリ、フィルタリング、またはグループ化できます。
デフォルトのサンプル構成ファイルには、ラベルの例が含まれています。ただし、必須ではないため、選択した新しいものを削除、変更、または追加できます。

labels:
   env: production
   role: load_balancer

構成例

これは、ローカルホストからメトリックとインベントリを収集するために使用される基本構成です。

integrations:
  - name: nri-couchbase
    env:
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      environment: production
    inventory_source: config/couchbase

この構成では、15秒ごとにメトリックを収集し、60秒ごとにインベントリを収集します。

integrations:
  - name: nri-couchbase
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      environment: production

  - name: nri-couchbase
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 60s
    labels:
      environment: production
    inventory_source: config/couchbase

この構成では、環境変数COUCHBASE_HOSTを使用して、統合のHOSTNAME設定を設定しています。

integrations:
  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: {{COUCHBASE_HOST}}
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer

この構成では、同じ統合から複数の Couchbase サーバーを監視しています。最初のインスタンス ( HOSTNAME: 1st_couchbase_host ) ではメトリックとインベントリを収集しますが、2 番目のインスタンス ( HOSTNAME: 2nd_couchbase_host ) ではメトリックのみを収集します。

integrations:
  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: 1st_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer
  - name: nri-couchbase
    env:
      INVENTORY: "true"
      HOSTNAME: 1st_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/couchbase

  - name: nri-couchbase
    env:
      METRICS: "true"
      HOSTNAME: 2nd_couchbase_host
      PORT: 8091
      QUERY_PORT: 8093
      USERNAME: couchbase_user
      PASSWORD: couchbase_password
    interval: 15s
    labels:
      env: production
      role: load_balancer

データを見つけて使用する

統合データは統合ダッシュボードに報告されます。

Couchbaseのデータは、以下のイベントタイプに添付されています。

CouchbaseBucketSample
CouchbaseClusterSample
CouchbaseNodeSample
CouchbaseQueryEngineSample

トラブルシューティングの目的で、またはカスタムチャートとダッシュボードを作成するために、このデータをクエリできます。

データを検索して使用する方法の詳細については、統合データについてを参照してください。

メトリックデータ

Couchbase 統合は、次のメトリックデータ属性を収集します。cluster.やnode.など、一部のメトリック名には、カテゴリインジケータとピリオドがプレフィックスとして付けられます。

Couchbaseバケットのサンプルメトリクス

これらの属性は、 CouchbaseBucketSampleイベントタイプに関連付けられています。

メトリック	説明
`bucket.activeResidentItemsRatio`	このバケツのRAMにキャッシュされているアクティブなアイテムの割合。
`bucket.averageDiskCommitTimeInMilliseconds`	バケットの平均ディスクコミット時間（単位：ミリ秒）。
`bucket.averageDiskUpdateTimeInMilliseconds`	バケットの平均ディスク更新時間（単位：ミリ秒）。
`bucket.cacheMissRatio`	このバケットの1秒あたりの読み込み回数が、RAMではなくディスクからの場合の割合。
`bucket.currentConnections`	外部のクライアントSDK、プロキシ、TAPリクエスト、内部の統計収集からの接続を含む、このサーバーへの接続数。
`bucket.dataUsedInBytes`	このバケツで使用されたデータの量（バイト）。
`bucket.decrementHitsPerSecond`	バケットの1秒あたりのデクリメントヒット数。
`bucket.decrementMissesPerSecond`	バケットの1秒あたりのデクリメントミスの回数。
`bucket.deleteHitsPerSecond`	このバケツの1秒あたりの削除ヒット数。
`bucket.deleteMissesPerSecond`	このバケットの1秒あたりの削除ミスの数。
`bucket.diskCreateOperationsPerSecond`	このバケットで1秒間にディスク上に作成された新しいアイテムの数。
`bucket.diskFetchesPerSecond`	バケット上のディスクからアイテムを取得するために1秒間に必要な操作回数。
`bucket.diskUpdateOperationsPerSecond`	このバケツの1秒あたりのディスク上の更新アイテム数。
`bucket.diskUsedInBytes`	バケットに使用されているディスク容量をバイト単位で表します。
`bucket.diskWriteQueue`	バケット内でディスクへの書き込みを待っているアイテムの数。
`bucket.ejectionsPerSecond`	このバケットでディスクに排出される1秒あたりの総アイテム数
`bucket.evictionPolicy`	バケットの立ち退きポリシー。
`bucket.evictionsPerSecond`	バケットから退避される1秒あたりのアイテム数です。
`bucket.getHitsPerSecond`	このバケツに入っているデータの、1秒あたりの取得操作回数。
`bucket.getMissesPerSecond`	このバケットに含まれていないデータの1秒あたりの取得操作回数。
`bucket.hitRatio`	このバケツからのデータで提供されたgetリクエストの割合。
`bucket.incrementHitsPerSecond`	バケットの1秒あたりのインクリメントヒットの数。
`bucket.incrementMissesPerSecond`	バケットの1秒あたりのインクリメントミスの回数。
`bucket.itemCount`	バケットに保存されているオブジェクトの数です。
`bucket.memoryHighWaterMarkInBytes`	バケット上の自動消去のハイウォーターマーク（単位：バイト）。
`bucket.memoryLowWaterMarkInBytes`	バケットの自動消去のローウォーターマーク（単位：バイト）。
`bucket.memoryUsedInBytes`	バケットに使用されているRAMの量（バイト単位）です。
`bucket.metadataInRAMInBytes`	このバケットのメタデータに使用されているRAMの量（単位：バイト）。
`bucket.missesPerSecond`	バケットの1秒あたりのミスの数。
`bucket.nodeLocator`	ノードロケーターの種類。
`bucket.outOfMemoryErrorsPerSecond`	このバケツで発生したハードアウトオブメモリーエラーの数。
`bucket.OverheadInBytes`	バケット上の一時的なデータ（パーシステンスキュー、レプリケーションキュー、チェックポイントなど）が使用する余分なメモリの量（単位：バイト）。
`bucket.pendingResidentItemsRatio`	このバケットのRAMにキャッシュされている保留項目の割合。
`bucket.quotaUtilization`	バケットで現在使用されているRAMクオータの割合。
`bucket.readOperationsPerSecond`	このバケットからの1秒あたりの読み込み（取得操作）の回数。
`bucket.readRatePerSecond`	バケットの1秒あたりの読み取りバイト数。
`bucket.replicaIndex`	バケットのレプリカインデックスを有効にするかどうかを定義します。
`bucket.replicaNumber`	このバケットのレプリカの数。
`bucket.replicaResidentItemsRatio`	このバケツのRAMにキャッシュされているレプリカアイテムの割合。
`bucket.residentItemsRatio`	このバケツのRAMにキャッシュされている全アイテムの割合。
`bucket.temporaryOutOfMemoryErrorsPerSecond`	このバケットのメモリ不足のために、クライアントSDKに毎秒送られるバックオフの数。
`bucket.threadsNumber`	データバケットの同時読み取り、同時書き込み数。
`bucket.totalOperationsPerSecond`	バケットの1秒あたりの総操作数。
`bucket.writeOperationsPerSecond`	このバケットへの1秒あたりの書き込み（セット操作）の回数。
`bucket.writeRatePerSecond`	バケットの書き込まれたバイト数です。

カウチベースクラスターサンプルメトリクス

これらの属性は、 CouchbaseClusterSampleイベントタイプに関連付けられています。

メトリック	説明
`cluster.autoFailoverCount`	クラスター上の自動フェイルオーバーの数です。
`cluster.autoFailoverEnabled`	クラスタでフェイルオーバーが有効になっているかどうかを示します。
`cluster.databaseFragmentationThreshold`	コンパクションが発生するデータベース内のパーセンテージレベル。
`cluster.diskFreeInBytes`	このクラスターの空きディスク容量（単位：バイト）。
`cluster.diskQuotaTotalInBytes`	Couchbaseで利用可能なディスクの総容量をバイト単位で表示しています。
`cluster.diskTotalInBytes`	利用可能なディスクの総容量（単位：バイト）。
`cluster.diskUsedbyDataInBytes`	このクラスター上のバケットデータが使用するディスクのサイズ（単位：バイト）。
`cluster.diskUsedInBytes`	このクラスターの使用済みディスク容量（単位：バイト）。
`cluster.indexFragmentationThreshold`	コンパクションが発生するインデックス内のパーセンテージレベル。
`cluster.maximumBucketCount`	このクラスターがサポートするバケットの最大数。
`cluster.memoryQuotaTotalInBytes`	Couchbaseが使用できるRAMの総量（バイト）。
`cluster.memoryQuotaTotalPerNodeInBytes`	ノードごとにCouchbaseが使用できるRAMの総量をバイトで表したものです。
`cluster.memoryQuotaUsedInBytes`	Couchbaseが使用しているRAMの総量（バイト単位）。
`cluster.memoryQuotaUsedPerNodeInBytes`	ノードごとにCouchbaseが使用しているRAMの総量（バイト単位）。
`cluster.memoryTotalInBytes`	このクラスター上の総RAMをバイト単位で表します。
`cluster.memoryUsedByDataInBytes`	このクラスターのバケットデータが使用しているRAMの総量（単位：バイト）。
`cluster.memoryUsedInBytes`	このクラスターで使用されているRAMの総量（バイト）です。
`cluster.viewFragmentationThreshold`	コンパクションのトリガーとなる、すべてのビューインデックスファイル内の断片化の割合です。

Couchbaseノードのサンプルメトリクス

これらの属性は、 CouchbaseNodeSampleイベントタイプに関連付けられています。

メトリック	説明
`node.cpuUtilization`	ノードのCPU使用率です。
`node.memoryFreeInBytes`	ノードの空きメモリ（単位：バイト）。
`node.memoryTotalInBytes`	ノードに割り当てられているメモリの総量（バイト）です。
`node.recoveryType`	ノードのリカバリータイプです。
`node.services`	ノードのサービスです。
`node.status`	ノードのステータス。( `0` = 不健康、 `1` = 健康)
`node.swapTotalInBytes`	ノードのスワップスペースの合計（バイト）です。
`node.swapUsedInBytes`	ノードの使用されているスワップスペース（単位：バイト）。
`node.uptimeInMilliseconds`	ノードのアップタイムをミリ秒単位で表します。

Couchbase クエリエンジンのサンプルメトリクス

これらの属性は、 CouchbaseQueryEngineSampleイベントタイプに関連付けられています。

メトリック	説明
`queryengine.activeRequests`	現在のアクティブなリクエストの数。
`queryengine.averageRequestTimeInMilliseconds`	このクエリエンジンの平均リクエスト時間（単位：ミリ秒）。
`queryengine.completedLimit`	Couchbaseがクエリログに残すクエリの数。
`queryengine.completedRequests`	現在の完了したリクエストの数
`queryengine.completedThresholdInMilliseconds`	クエリがCouchbaseのクエリ・ログに記録されるまでの最小時間をミリ秒単位で指定します。
`queryengine.cores`	このクエリエンジンで利用可能なコアの数。
`queryengine.garbageCollectionNumber`	最後のガベージコレクションの番号。
`queryengine.garbageCollectionPaused`	ガベージコレクションが一時停止している時間の割合。
`queryengine.garbageCollectionTimePausedInMilliseconds`	ガベージコレクションが一時停止している時間をミリ秒単位で指定します。
`queryengine.medianRequestTimeInMilliseconds`	このクエリエンジンのリクエスト時間の中央値（単位：ミリ秒）。
`queryengine.preparedStatementUtilization`	準備されたステートメントであるリクエストの割合
`queryengine.requestsLast15MinutesPerSecond`	過去15分間の1秒あたりのリクエスト数の平均値。
`queryengine.requestsLast1MinutesPerSecond`	過去1分間の1秒あたりのリクエスト数の平均値。
`queryengine.requestsLast5MinutesPerSecond`	過去5分間の1秒あたりのリクエスト数の平均値。
`queryengine.requestTime80thPercentileInMilliseconds`	このクエリエンジンのリクエスト時間の80パーセンタイル（単位：ミリ秒）。
`queryengine.requestTime95thPercentileInMilliseconds`	このクエリエンジンのリクエスト時間の95パーセンタイル（単位：ミリ秒）。
`queryengine.requestTime99thPercentileInMilliseconds`	このクエリエンジンのリクエスト時間の99パーセンタイル（単位：ミリ秒）。
`queryengine.systemCPUUtilization`	このクエリエンジンのCPU使用率
`queryengine.systemMemoryInBytes`	このクエリエンジンで予約されている仮想アドレス空間をバイト単位で表します。
`queryengine.totalMemoryInBytes`	このクエリエンジンでヒープオブジェクトに割り当てられたメモリの累積量（単位：バイト）。
`queryengine.totalThreads`	このクエリエンジンで使用されているスレッドの総数。
`queryengine.uptimeInMilliseconds`	このクエリエンジンの稼働時間（単位：ミリ秒
`queryengine.usedMemoryInBytes`	このクエリエンジンのヒープオブジェクトに割り当てられているメモリの量（単位：バイト）。
`queryengine.userCPUUtilization`	このクエリエンジンのユーザーCPU使用率。

在庫データ

Couchbaseインテグレーションでは、Couchbaseデータベースの構成パラメータを取得します。このデータは、Infrastructure Inventoryページ、 config/couchbase ソースの下で利用できます。インベントリデータの詳細については、 Understand data を参照してください。

このインテグレーションでは、以下のCouchbase構成パラメータのデータを取得します。

名前	説明
`Node locator`	ノードロケーターの種類。
`Proxy port`	バケットが通信するためのプロキシポート。
`Type`	バケットの種類です。
`UUID`	バケットのUUIDです。

名前	説明
`Collection node`	メトリクスの収集に使用されるノードです。
`Couchbase version`	このクラスターで稼働しているCouchbaseのバージョンです。
`UUID`	クラスターのUUIDです。

名前	説明
`Cluster membership`	ノードのクラスター・メンバーシップです。
`Hostname`	ノードのホスト名です。
`Operating system`	ノードのオペレーティング・システム。
`Port`	ノードのポートです。
`Recovery type`	ノードのリカバリータイプです。
`Services`	ノードのサービスをコンマで区切ったリスト。
`Version`	このノードで稼働しているCouchbaseのバージョンです。

名前	説明
`Node hostname`	このクエリエンジンが動作するノードのホスト名。
`Node port`	このクエリエンジンが動作しているノードのポートです。
`Version`	このクエリエンジンのバージョンです。

ソースコードを確認してください

この統合はオープンソースソフトウェアです。つまり、ソースコードを参照して改善を送信したり、独自のフォークを作成してビルドしたりできます。

この機械翻訳は参考用に提供されます。

互換性と要件

クイックスタート

インストールしてアクティブ化する

ECS

Kubernetes

Linux

ウィンドウズ

このドキュメントはインストールで役立ちましたか。

構成

統合を構成する

重要

Couchbase インスタンスの設定

ラベル/カスタム属性

構成例

基本構成

メトリック/在庫間隔が異なる基本構成

環境変数の置換

マルチインスタンスモニタリング

データを見つけて使用する

メトリックデータ

Couchbaseバケットのサンプルメトリクス

カウチベースクラスターサンプルメトリクス

Couchbaseノードのサンプルメトリクス

Couchbase クエリエンジンのサンプルメトリクス

在庫データ

バケットのパラメータ

クラスターパラメータ

ノードパラメータ

クエリエンジンのパラメータ

ソースコードを確認してください