Supported OS Linux Windows Mac OS

インテグレーションバージョン2.2.3

概要

このチェックは、Datadog Agent を通じて Boundary を監視するものです。Boundary の最小サポートバージョンは、0.8.0 です。

セットアップ

ホストで実行されている Agent 用にこのチェックをインストールおよび構成する場合は、以下の手順に従ってください。コンテナ環境の場合は、オートディスカバリーのインテグレーションテンプレートのガイドを参照してこの手順を行ってください。

インストール

Boundary チェックは Datadog Agent パッケージに含まれています。 サーバーに追加でインストールする必要はありません。

構成

リスナー

メトリクスを収集できるようにするには、config.hcl ファイルに ops 目的のリスナーを設定する必要があります。以下はリスナーのスタンザの例です。

controller {
  name = "boundary-controller"
  database {
    url = "postgresql://<username>:<password>@10.0.0.1:5432/<database_name>"
  }
}

listener "tcp" {
  purpose = "api"
  tls_disable = true
}

listener "tcp" {
  purpose = "ops"
  tls_disable = true
}

コントローラーがシャットダウンしているとき、boundary.controller.health サービスチェックWARNING として送信されます。このシャットダウン猶予期間を有効にするには、controller ブロックを更新して、待ち時間を定義します。

controller {
  name = "boundary-controller"
  database {
    url = "env://BOUNDARY_PG_URL"
  }
  graceful_shutdown_wait_duration = "10s"
}

Datadog Agent

  1. boundary のパフォーマンスデータの収集を開始するには、Agent のコンフィギュレーションディレクトリのルートにある conf.d/ フォルダーの boundary.d/conf.yaml ファイルを編集します。使用可能なすべてのコンフィギュレーションオプションの詳細については、boundary.d/conf.yaml のサンプルを参照してください。

  2. Agent を再起動します

検証

Agent の status サブコマンドを実行し、Checks セクションで boundary を探します。

収集データ

メトリクス

boundary.cluster.client.grpc.request_duration_seconds.bucket
(count)
Histogram of latencies for gRPC requests between the cluster and any of its clients.
Shown as second
boundary.cluster.client.grpc.request_duration_seconds.count
(count)
Histogram of latencies for gRPC requests between the cluster and any of its clients.
Shown as second
boundary.cluster.client.grpc.request_duration_seconds.sum
(count)
Histogram of latencies for gRPC requests between the cluster and any of its clients.
Shown as second
boundary.controller.api.http.request_duration_seconds.bucket
(count)
Histogram of latencies for HTTP requests.
Shown as second
boundary.controller.api.http.request_duration_seconds.count
(count)
Histogram of latencies for HTTP requests.
Shown as second
boundary.controller.api.http.request_duration_seconds.sum
(count)
Histogram of latencies for HTTP requests.
Shown as second
boundary.controller.api.http.request_size_bytes.bucket
(count)
Histogram of request sizes for HTTP requests.
Shown as byte
boundary.controller.api.http.request_size_bytes.count
(count)
Histogram of request sizes for HTTP requests.
Shown as byte
boundary.controller.api.http.request_size_bytes.sum
(count)
Histogram of request sizes for HTTP requests.
Shown as byte
boundary.controller.api.http.response_size_bytes.bucket
(count)
Histogram of response sizes for HTTP responses.
Shown as byte
boundary.controller.api.http.response_size_bytes.count
(count)
Histogram of response sizes for HTTP responses.
Shown as byte
boundary.controller.api.http.response_size_bytes.sum
(count)
Histogram of response sizes for HTTP responses.
Shown as byte
boundary.controller.cluster.grpc.request_duration_seconds.bucket
(count)
Histogram of latencies for gRPC requests.
Shown as second
boundary.controller.cluster.grpc.request_duration_seconds.count
(count)
Histogram of latencies for gRPC requests.
Shown as second
boundary.controller.cluster.grpc.request_duration_seconds.sum
(count)
Histogram of latencies for gRPC requests.
Shown as second
boundary.worker.proxy.http.write_header_duration_seconds.bucket
(count)
Histogram of time elapsed after the TLS connection is established to when the first http header is written back from the server.
Shown as second
boundary.worker.proxy.http.write_header_duration_seconds.count
(count)
Histogram of time elapsed after the TLS connection is established to when the first http header is written back from the server.
Shown as second
boundary.worker.proxy.http.write_header_duration_seconds.sum
(count)
Histogram of time elapsed after the TLS connection is established to when the first http header is written back from the server.
Shown as second
boundary.worker.proxy.websocket.active_connections
(gauge)
Count of open websocket proxy connections (to Boundary workers).
Shown as connection
boundary.worker.proxy.websocket.received_bytes.count
(count)
Count of received bytes for Worker proxy websocket connections.
Shown as byte
boundary.worker.proxy.websocket.sent_bytes.count
(count)
Count of sent bytes for Worker proxy websocket connections.
Shown as byte

イベント

Boundary インテグレーションには、イベントは含まれません。

サービスチェック

boundary.openmetrics.health
Returns CRITICAL if the Agent is unable to connect to the OpenMetrics endpoint, otherwise returns OK.
Statuses: ok, critical

boundary.controller.health
Returns CRITICAL if the Agent is unable to connect to the controller’s health endpoint, WARNING if the controller received a shutdown signal, otherwise returns OK.
Statuses: ok, warning, critical

ログ収集

  1. Datadog Agent で、ログの収集はデフォルトで無効になっています。以下のように、datadog.yaml ファイルでこれを有効にします。

    logs_enabled: true
    
  2. To start collecting your Boundary logs, add this configuration block to your boundary.d/conf.yaml file:

    logs:
       - type: file
         source: boundary
         path: /var/log/boundary/events.ndjson
    

    Change the path parameter value based on your environment. See the sample boundary.d/conf.yaml file for all available configuration options.

トラブルシューティング

ご不明な点は、Datadog のサポートチームまでお問い合わせください。

PREVIEWING: esther/docs-9478-fix-split-after-example