HashiCorp領事館の監視統合

当社の HashiCorp Consul オンホスト統合は、 Consul データセンター環境からインベントリとメトリクスを収集して New Relic に送信し、そこで環境の健全性を確認できます。データセンターとエージェント/ノードレベルの両方でデータを収集します。

ヒント

Hashicorp Cloud Platform Consul 統合もあることに注意してください。

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

互換性と要件

私たちの統合は、HashiCorpConsul1.0以降と互換性があります。

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

ConsulがKubernetesまたはAmazonECSで実行されていない場合は、Consulを実行しているホストにインフラストラクチャエージェントをインストールする必要があります。さもないと：
- Kubernetesで実行している場合は、これらの要件を参照してください。
- ECSで実行している場合は、これらの要件を参照してください。
ACLを使用する場合、領事館統合の資格情報には、 agent:read 、 node:read 、およびservice:readのポリシーが必要です。

クイックスタート

領事館の環境をすばやく計測し、ガイド付きインストールでテレメトリデータを送信します。ガイド付きインストールでは、環境に合わせてカスタマイズされたCLIコマンドを作成し、NewRelicCLIとインフラストラクチャエージェントをダウンロードしてインストールします。

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

ガイド付きインストール

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

ガイド付きインストールでは、インフラストラクチャエージェントを使用してHashiCorpConsul統合をセットアップします。それだけでなく、環境で実行されている他のアプリケーションとログソースを検出し、どのアプリケーションをインストルメントする必要があるかを推奨します。

ガイド付きインストールは、ほとんどのセットアップで機能します。ただし、ニーズに合わない場合は、領事館環境の監視を開始するために、以下の他の方法を見つけることができます。

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

HashiCorp Consul統合をインストールするには、ご使用の環境の指示に従ってください。

インフラストラクチャエージェントをインストールし、 INTEGRATION_FILE_NAME変数をnri-consulに置き換えます。
ディレクトリを統合フォルダに変更します。
```
cd /etc/newrelic-infra/integrations.d
```
サンプル構成ファイルをコピーします。
```
sudo cp consul-config.yml.sample consul-config.yml
```
構成設定の説明に従って、 consul-config.ymlファイルを編集します。
インフラストラクチャエージェントを再起動します。

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

その他の注意事項：

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

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

構成

統合を構成する

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

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

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

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

重要

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

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

領事インスタンスの設定

領事館の統合により、メトリック（ M ）とインベントリ（ I ）の両方の情報が収集されます。表で、各コレクションで使用可能な設定の[適用先]列を使用します。

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

設定	説明	デフォルト	に適用されます
ホスト名	Consulが実行されているホスト名またはIP。	ローカルホスト	M / I
ポート	領事が聞いている港。	8500	M / I
トークン	トークン認証が有効になっている場合は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
扇形に広がります	trueの場合、Consulクラスター内の他のすべてのノードからメトリックを収集しようとします。	true	M
CHECK_LEADERSHIP	領事サーバーのリーダーシップを確認してください。これは、クライアントモードの領事で無効にする必要があります。	true	M
タイムアウト	各領事クライアントの呼び出しのタイムアウト。	30代	M / I
METRICS	メトリックのみの収集を有効にするには、 `true`に設定します。	false
在庫	インベントリのみの収集を有効にするには、 `true`に設定します。	false

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

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

ラベル/カスタム属性

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

labels:
   env: production
   role: load_balancer

構成例

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

integrations:
  - name: nri-consul
    env:
      HOSTNAME: localhost
      PORT: 8500
    interval: 15s
    labels:
      environment: production
    inventory_source: config/consul

この構成では、タイムアウトを使用して30秒ごとにメトリックを収集し、60秒ごとにインベントリを収集します。

integrations:
  - name: nri-consul
    env:
      METRICS: true
      HOSTNAME: localhost
      PORT: 8500
      TIMEOUT: 10s
    interval: 15s
    labels:
      environment: production

  - name: nri-consul
    env:
      INVENTORY: true
      HOSTNAME: localhost
      PORT: 8500
      TIMEOUT: 10s
    interval: 60s
    labels:
      environment: production
    inventory_source: config/consul

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

integrations:
  - name: nri-consul
    env:
      METRICS: "true"
      HOSTNAME: {{CONSUL_HOST}}
      PORT: 8500
    interval: 15s
    labels:
      env: production
      role: load_balancer

この構成では、ACLトークンを使用して接続し、接続されている他の領事ノードからメトリックを収集していません（FAN_OUT：false）：

integrations:
  - name: nri-consul
    env:
      METRICS: "true"
      HOSTNAME: localhost
      PORT: 8500
      TOKEN: my_token
      FAN_OUT: false
    interval: 15s
    labels:
      env: production
      role: load_balancer

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

integrations:
  - name: nri-consul
    env:
      METRICS: "true"
      HOSTNAME: 1st_consul_host
      PORT: 8500
    interval: 15s
    labels:
      env: production
      role: load_balancer
  - name: nri-consul
    env:
      INVENTORY: "true"
      HOSTNAME: 1st_consul_host
      PORT: 8500
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/consul

  - name: nri-consul
    env:
      METRICS: "true"
      HOSTNAME: 2nd_consul_host
      PORT: 8500
    interval: 15s
    labels:
      env: production
      role: load_balancer

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

このサービスからのデータは、統合ダッシュボードに報告されます。

メトリックは、これらのイベントタイプに関連付けられています。

ConsulDatacenterSample
ConsulAgentSample

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

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

メトリックデータ

HashiCorp Consul統合は、次のメトリックデータ属性を収集します。

データセンターのサンプルメトリクスを領事

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

メトリック	説明
`consul.catalog.nodes_critical`	登録されているノードのうち、サービスステータスが`critical`のノードの数。
`consul.catalog.nodes_passing`	登録されているノードのうち、サービスステータスが`passing`のノードの数。
`consul.catalog.nodes_up`	ノードの数。
`consul.catalog.nodes_warning`	登録されているノードのうち、サービスステータスが`warning`のノードの数。
`consul.catalog.total_nodes`	領事クラスターに登録されているノードの数。
`consul.memberlist.msg.suspect`	ゴシッププロトコル中にプローブしているときに、エージェントが別のエージェントを失敗したと疑う回数。
`consul.raft.apply`	発生したラフトトランザクションの数。
`consul.raft.commitTime.avg`	リーダーのいかだログに新しいエントリをコミットするのにかかる平均時間。
`consul.raft.commitTime.count`	`raft.commitTime`のサンプル数。
`consul.raft.commitTime.max`	リーダーのいかだログに新しいエントリをコミットするのにかかる最大時間。
`consul.raft.commitTime.median`	リーダーのいかだログに新しいエントリをコミットするのにかかる時間の中央値。
`consul.raft.leader.dispatchLog.avg`	リーダーがログエントリをディスクに書き込むのにかかる平均時間。
`consul.raft.leader.dispatchLog.count`	`raft.leader.dispatchLog`のサンプル数。
`consul.raft.leader.dispatchLog.max`	リーダーがログエントリをディスクに書き込むのにかかる最大時間。
`consul.raft.leader.dispatchLog.median`	リーダーがログエントリをディスクに書き込むのにかかる時間の中央値。
`consul.raft.leader.lastContact.avg`	リーダーがフォロワーとのリースを最後に確認できてからの平均経過時間。
`consul.raft.leader.lastContact.count`	`raft.leader.lastContact`のサンプル数。
`consul.raft.leader.lastContact.max`	リーダーがフォロワーとのリースを最後に確認できてからの最大経過時間。
`consul.raft.leader.lastContact.median`	リーダーがフォロワーとのリースを最後に確認できてから経過した時間の中央値。
`consul.raft.state.candidate`	開始されたリーダー選挙の数。
`consul.raft.state.leader`	完了したリーダー選挙の数。
`consul.serf.member.flap`	エージェントがデッドとマークされてからすぐに回復する回数。

領事代理人のサンプル指標

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

メトリック	説明
`agent.aclCacheHit`	ACLキャッシュがヒットします。
`agent.aclCacheMiss`	ACLキャッシュがありません。
`agent.kvStores`	`kvs.apply`のサンプル数。
`agent.kvStoresAvgInMilliseconds`	KVストアの更新を完了するのにかかる平均時間。
`agent.kvStoresMaxInMilliseconds`	KVストアの更新を完了するのにかかる最大時間。
`agent.kvStoresMedianInMilliseconds`	KVストアの更新を完了するのにかかる時間の中央値。
`agent.peers`	ピアセット内のピアの数。
`agent.staleQueries`	許可された失効しきい値内で提供されたクエリ。
`agent.txnAvgInMilliseconds`	トランザクション操作の適用にかかる平均時間。
`agent.txnMaxInMilliseconds`	トランザクション操作の適用にかかる最大時間。
`agent.txnMedianInMilliseconds`	トランザクション操作の適用にかかる時間の中央値。
`agent.txns`	`txn.apply`のサンプル数。
`client.rpcFailed`	失敗したRPC要求の測定。
`client.rpcLoad`	エージェントがConsulサーバーにロードしている量の測定。
`client.rpcRateLimited`	レートが制限されるRPCリクエストの測定。
`net.agent.maxLatencyInMilliseconds`	このノードから他のすべてのノードまでの最大遅延。
`net.agent.medianLatencyInMilliseconds`	このノードから他のすべてのノードまでの遅延の中央値。
`net.agent.minLatencyInMilliseconds`	このノードから他のすべてのノードまでの最小遅延。
`net.agent.p25LatencyInMilliseconds`	このノードから他のすべてのノードへのP25遅延。
`net.agent.p75LatencyInMilliseconds`	このノードから他のすべてのノードへのP75遅延。
`net.agent.p90LatencyInMilliseconds`	このノードから他のすべてのノードへのP90遅延。
`net.agent.p95LatencyInMilliseconds`	このノードから他のすべてのノードへのP95遅延。
`net.agent.p99LatencyInMilliseconds`	このノードから他のすべてのノードへのP99レイテンシ。
`runtime.allocations`	割り当てられたヒープオブジェクトの累積数。
`runtime.allocationsInBytes`	領事プロセスによって割り当てられた現在のバイト。
`runtime.frees`	解放されたヒープオブジェクトの累積数。
`runtime.gcCycles`	完了したGCサイクルの数。
`runtime.gcPauseInMilliseconds`	領事が開始してから、GCの累積ナノ秒は世界を停止します。
`runtime.goroutines`	実行中のgoルーチンの数。
`runtime.heapObjects`	ヒープに割り当てられたオブジェクトの数
`runtime.virtualAddressSpaceInBytes`	goランタイムによって予約された仮想アドレス空間の合計サイズ。

在庫データ

HashiCorp Consul統合は、ConsulAgentノードの構成パラメーターと現在の設定をキャプチャします。/v1/agent/self RESTAPIエンドポイントの結果を収集します。その応答から{ Config }セクションとDebugConfigセクションを引き出します。

ヒント

注： ConfigおよびDebugConfig内のネストされたセクションは収集されません。

データは、 config/consulソースの下の[ インベントリ]ページで入手できます。インベントリデータの詳細については、統合データについてを参照してください。

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

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

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

ヒント

互換性と要件

クイックスタート

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

ECS

Kubernetes

Linux

ウィンドウズ

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

構成

統合を構成する

重要

領事インスタンスの設定

ラベル/カスタム属性

構成例

基本構成

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

環境変数の置換

指標-トークンのみでファンアウトなし