HashiCorp Consulオンホスト インテグレーションは、 Consul データセンター環境からインベントリとメトリックを収集してNew Relicに送信し、そこで環境の健全性を確認できます。 データセンターレベルとエージェント/ノードレベルの両方でデータを収集します。
ヒント
HashiCorp Cloud Platform Consul 統合もあることに注意してください。
互換性と要件
インストレーション前に、以下の要件を満たしていることを確認してください。
- 私たちの統合は HashiCorp Consul 1.0 以降と互換性があります。
- ACL を使用している場合、Consul 統合の認証情報にはポリシー
agent:read
、node:read
、およびservice:read
が必要です。
クイックスタート
Consul 環境を迅速に計測し、ガイド付きインストールでテレメトリ データを送信します。ガイド付きインストールでは、インフラストラクチャ エージェントと CLI を使用して HashiCorp 統合をセットアップし、環境内で実行されている他のアプリケーションとログ ソースを検出して、どのアプリケーションを計測する必要があるかを推奨します。
ガイド付きインストールは、ほとんどの設定と連動します。ただし、ご希望に添えない場合は、以下の他のインストールオプションがあります。
始める準備はできていますか?使用するデータセンターの地域に応じて、該当するボタンをクリックします。インストールが完了したら、本ドキュメントに戻って設定オプションを確認してください。
インストール
HashiCorp Consul統合をインストールするには、ご使用の環境の指示に従ってください。
''
統合を更新する
このインテグレーションは、自動更新しません。最善の結果を得るため、インテグレーションパッケージの更新とInfrastructureエージェントの更新を定期的に実施してください。
インストール後のタスク
インストールが完了したら、設定オプションを設定できます。インテグレーションを機能させるには、設定がいくつか必要ですが、オプションの設定もあります。
統合を構成する
ECSまたはKubernetesインテグレーションからこのインテグレーションを有効にした場合は、以下のドキュメントを参照してください。
標準オンホストインストールの場合、このインテグレーションにはYAML設定ファイル、apache-config.yml
が付属しています。この設定では、必要なログインクレデンシャルやデータの収集方法を設定できます。どのオプションを変更するかは、設定とプリファレンスにより異なります。コピーおよび編集できるサンプル設定ファイルapache-config.yml.sample
が付属しています。
Consul に関連する特定の設定は、構成ファイルのenv
セクションを使用して定義されます。これらの設定は、Consul インスタンスへの接続だけでなく、他のセキュリティ設定や機能も制御します。
重要
従来の構成/定義ファイルをまだ使用している場合は、このドキュメントを参照してください。
Consul 構成オプション
Consul の統合は、メトリクスとインベントリ情報の両方を収集します。この表は、各構成オプションの適用対象を示しています。
'' '' '' '' '' '' '' '' '' '' ''
設定 | 説明 | デフォルト | に適用されます |
---|---|---|---|
HOSTNAME | Consulが実行されているホスト名またはIP。 | ローカルホスト | M / I |
PORT | 領事が聞いている港。 | 8500 | M / I |
TOKEN | トークン認証が有効になっている場合はACLトークン。 | 該当なし | M / I |
ENABLE_SSL | SSLを使用して接続します。 | false | M / I |
CA_BUNDLE_FILE | 代替認証局バンドルファイル。 | 該当なし | M / I |
CA_BUNDLE_DIR | 代替認証局バンドルディレクトリ。 | 該当なし | M / I |
TRUST_SERVER_CERTIFICATE | trueに設定すると、サーバー証明書はSSLに対して検証されません。 | false | M / I |
FAN_OUT | trueの場合、Consulクラスター内の他のすべてのノードからメトリックを収集しようとします。 | true | M |
CHECK_LEADERSHIP | 領事サーバーのリーダーシップを確認してください。これは、クライアントモードの領事で無効にする必要があります。 | true | M |
TIMEOUT | 各領事クライアントの呼び出しのタイムアウト。 | 30代 | M / I |
METRICS | メトリックのみの収集を有効にするには、 | false | |
INVENTORY | インベントリのみの収集を有効にするには、 | false |
これらの設定の値は、いくつかの方法で定義できます。
- 設定ファイルに直接値を追加します。これが最も一般的な方法です。
{{}}
表記を使用して環境変数の値を置き換えます。これには、インフラストラクチャエージェントv1.14.0以降が必要です。詳細については、 こちらをご覧になるか、以下の例をご覧ください。- シークレット管理を使用します。これを使用して、構成ファイルにプレーンテキストで公開されるパスワードなどの機密情報を保護します。詳細については、シークレット管理を参照してください。
ラベル
さらに、メトリクスにラベルを付けることもできます。ラベルを使用すると、属性(キーや値のペア)をメトリクスに追加して、メトリクスのクエリを挙げ、フィルターをかけ、グループ化を行うことができます。
デフォルトのサンプル設定ファイルにはラベルの例が含まれていますが、必須ではないため、選択したラベルを削除、変更、お好きな設定を新規追加することができます。
labels: env: production role: load_balancer
構成例
データを見つけて使用する
この統合からのデータは、 one.newrelic.com > Infrastructure > Third-party services > Apacheにアクセスすると見つかります。
Apache データは、 ConsulDatacenterSample
およびConsulAgentSample
イベント タイプに関連付けられます。トラブルシューティングの目的でこのデータをクエリしたり、カスタム グラフやダッシュボードを作成したりできます。
データを検索して使用する方法の詳細については、統合データについてを参照してください。
メトリックデータ
HashiCorp Consul 統合は、次のメトリック データ属性を収集します。
Consul データセンター サンプル メトリックス
これらの属性は、 ConsulDatacenterSample
イベントタイプに関連付けられています。
メトリック | 説明 |
---|---|
| 登録されているノードのうち、サービスステータスが |
| 登録されているノードのうち、サービスステータスが |
| ノードの数。 |
| 登録されているノードのうち、サービスステータスが |
| 領事クラスターに登録されているノードの数。 |
| ゴシッププロトコル中にプローブしているときに、エージェントが別のエージェントを失敗したと疑う回数。 |
| 発生したラフトトランザクションの数。 |
| リーダーのいかだログに新しいエントリをコミットするのにかかる平均時間。 |
|
|
| リーダーのいかだログに新しいエントリをコミットするのにかかる最大時間。 |
| リーダーのいかだログに新しいエントリをコミットするのにかかる時間の中央値。 |
| リーダーがログエントリをディスクに書き込むのにかかる平均時間。 |
|
|
| リーダーがログエントリをディスクに書き込むのにかかる最大時間。 |
| リーダーがログエントリをディスクに書き込むのにかかる時間の中央値。 |
| リーダーがフォロワーとのリースを最後に確認できてからの平均経過時間。 |
|
|
| リーダーがフォロワーとのリースを最後に確認できてからの最大経過時間。 |
| リーダーがフォロワーとのリースを最後に確認できてから経過した時間の中央値。 |
| 開始されたリーダー選挙の数。 |
| 完了したリーダー選挙の数。 |
| エージェントがデッドとマークされてからすぐに回復する回数。 |
領事代理人のサンプル指標
これらの属性は、 ConsulAgentSample
イベントタイプに関連付けられています。
メトリック | 説明 |
---|---|
| ACLキャッシュがヒットします。 |
| ACLキャッシュがありません。 |
|
|
| KVストアの更新を完了するのにかかる平均時間。 |
| KVストアの更新を完了するのにかかる最大時間。 |
| KVストアの更新を完了するのにかかる時間の中央値。 |
| ピアセット内のピアの数。 |
| 許可された失効しきい値内で提供されたクエリ。 |
| トランザクション操作の適用にかかる平均時間。 |
| トランザクション操作の適用にかかる最大時間。 |
| トランザクション操作の適用にかかる時間の中央値。 |
|
|
| 失敗したRPC要求の測定。 |
| エージェントがConsulサーバーにロードしている量の測定。 |
| レートが制限されるRPCリクエストの測定。 |
| このノードから他のすべてのノードまでの最大遅延。 |
| このノードから他のすべてのノードまでの遅延の中央値。 |
| このノードから他のすべてのノードまでの最小遅延。 |
| このノードから他のすべてのノードへのP25遅延。 |
| このノードから他のすべてのノードへのP75遅延。 |
| このノードから他のすべてのノードへのP90遅延。 |
| このノードから他のすべてのノードへのP95遅延。 |
| このノードから他のすべてのノードへのP99レイテンシ。 |
| 割り当てられたヒープオブジェクトの累積数。 |
| 領事プロセスによって割り当てられた現在のバイト。 |
| 解放されたヒープオブジェクトの累積数。 |
| 完了したGCサイクルの数。 |
| 領事が開始してから、GCの累積ナノ秒は世界を停止します。 |
| 実行中のgoルーチンの数。 |
| ヒープに割り当てられたオブジェクトの数 |
| goランタイムによって予約された仮想アドレス空間の合計サイズ。 |
在庫データ
HashiCorp Consul統合は、ConsulAgentノードの構成パラメーターと現在の設定をキャプチャします。/v1/agent/self
RESTAPIエンドポイントの結果を収集します。その応答から{ Config
}セクションとDebugConfig
セクションを引き出します。
ヒント
Note: Config
とDebugConfig
内のネストされたセクションは収集されません。
データは、 config/consulソースの下にあるインベントリ ページで入手できます。 インベントリデータの詳細については、 「インベントリデータを理解する」を参照してください。
ソースコードを確認してください
この統合はオープン ソース ソフトウェアです。つまり、ソース コードを参照して改善を送信したり、独自のフォークを作成してビルドしたりできます。