• ログイン無料アカウント

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

英語版と齟齬がある場合、英語版の定めが優先するものとします。より詳しい情報については、本リンクをご参照ください。

問題を作成する

Couchbaseモニタリングの統合

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

インテグレーションのインストールと、当社がどのようなデータを収集するかについてお読みください。

互換性および要件

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

インテグレーションをインストールする前に、以下の要件を満たしていることを確認してください。

クイックスタート

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

A screenshot of the guided install CLI.

始める準備はできていますか?ボタンの1つをクリックし、試行してください。

ガイド付きインストール

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

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

インストールと有効化

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

' '

追加の注:

設定

インテグレーションの設定

インストールの方法により、インテグレーションの設定方法はいくつかあります。

インテグレーションのYAML形式設定では、必要なログインクレデンシャルやデータの収集方法を設定できます。どのオプションを変更するかは、設定とプリファレンスにより異なります。

設定ファイルには、 intervaltimeoutinventory_source など、すべての統合に適用される共通の設定があります。これらの共通設定については、 Configuration Format のドキュメントを参照してください。

重要

従来の設定/定義ファイルをまだお使いの場合は、こちらの ドキュメント を参考にしてください。

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

Couchbase インスタンスの設定

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

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

設定

説明

デフォルト

適用対象

HOSTNAME

Couchbaseが稼働しているホスト名またはIP。

localhost

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

Alternative Certificate Authority bundle directory.

該当なし

M/I

タイムアウト

APIリクエストのタイムアウト(単位:秒)。

30

M/I

ENABLE_BUCKETS

trueの場合、バケットのリソースを収集します。

true

M

バケット統計の有効化

trueの場合、追加のバケット統計を収集します。

true

M

クラスタとノードの有効化

trueの場合、クラスタとノードのリソースを収集します。

true

M

メトリクス

trueに設定すると、メトリクスのみの収集が有効になります。

false

インベントリ

trueに設定すると、インベントリのみの収集が有効になります。

false

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

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

ラベル/カスタム属性

メトリクスは、ラベルを使ってさらに装飾することができます。
デフォルトのサンプル・コンフィグ・ファイルにはラベルの例が含まれていますが、これらは必須ではありませんので、お好きなものを削除、変更、または新たに追加することができます。

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.MemoryLowWaterMarkInBytes

バケットの自動消去のローウォーターマーク(単位:バイト)。

bucket.memoryUsedInBytes

バケットに使用されているRAMの量(バイト単位)です。

Bucket.metadataInRAMInBytes

このバケットのメタデータに使用されているRAMの量(単位:バイト)。

bucket.missesPerSecond

バケットの1秒あたりのミスの数。

bucket.nodeLocator

ノードロケーターの種類。

bucket.outOfMemoryErrorsPerSecond

このバケツで発生したハードアウトオブメモリーエラーの数。

bucket.OverheadInBytes

バケット上の一時的なデータ(パーシステンスキュー、レプリケーションキュー、チェックポイントなど)が使用する余分なメモリの量(単位:バイト)。

バケツ.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 = 健全)

ノード.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構成パラメータのデータを取得します。

ソースコードのチェック

このインテグレーションは、オープンソース・ソフトウェアです。つまり、 そのソースコードを閲覧して 改良を送ったり、独自のフォークを作成して構築することができます。

Copyright © 2022 New Relic株式会社。