Config Sync の指標をカスタム モニタリング システムに送信する

このページでは、Config Sync からカスタムの OpenTelemetry エクスポータに指標を送信する方法について説明します。

Config Sync は、指標の作成と記録に OpenCensus を使用し、その指標をエクスポートするために OpenTelemetry を使用します。このページでは、これらの指標をカスタム エクスポータに送信するための構成について説明します。指標をエクスポートするその他の方法については、Cloud Monitoring を使用して Config Sync をモニタリングする、または Prometheus を使用して Config Sync をモニタリングするをご覧ください。

カスタムの OpenTelemetry エクスポータを構成する

Prometheus または Cloud Monitoring 以外のモニタリング システムに指標を送信する場合は、OpenTelemetry 構成を変更します。サポートされているモニタリング システムのリストについては、OpenTelemetry Collector エクスポータと OpenTelemetry Collector-Contrib エクスポータをご覧ください。

OpenTelemetry モニタリング リソースは、別の config-management-monitoring 名前空間で管理されます。Config Sync で使用するカスタムの OpenTelemetry エクスポータを構成するには、config-management-monitoring 名前空間に otel-collector-custom という名前の ConfigMap を作成する必要があります。ConfigMap に otel-collector-config.yaml キーを含めて、その値を OpenTelemetry Collector のカスタム構成ファイルの内容にする必要があります。構成オプションの詳細については、OpenTelemetry Collector の構成に関するドキュメントをご覧ください。

次の ConfigMap は、カスタムの Logging エクスポータを使用する ConfigMap の例です。

# otel-collector-custom-cm.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: otel-collector-custom
  namespace: config-management-monitoring
  labels:
    app: opentelemetry
    component: otel-collector
data:
  otel-collector-config.yaml: |
    receivers:
      opencensus:
    exporters:
      logging:
        logLevel: debug
    processors:
      batch:
    extensions:
      health_check:
    service:
      extensions: [health_check]
      pipelines:
        metrics:
          receivers: [opencensus]
          processors: [batch]
          exporters: [logging]

すべてのカスタム構成で、opencensus レシーバと metrics パイプラインを定義する必要があります。残りのフィールドは必要に応じて構成できますが、この例のように batch プロセッサとヘルスチェック拡張機能を含めることをおすすめします。

ConfigMap を作成したら、kubectl を使用してリソースを作成します。

kubectl apply -f otel-collector-custom-cm.yaml

OpenTelemetry Collector Deployment はこの ConfigMap を選択し、自動的に再起動してカスタム構成を適用します。

制限事項

Config Sync を新しいバージョンにアップグレードする際に、以前のバージョンに otel-collector-custom ConfigMap を作成した場合、カスタム設定に新しいバージョンの Config Sync との互換性がない場合があります。たとえば、指標名、ラベル、属性は Config Sync のバージョンによって異なる場合があります。

Config Sync 指標が変更されると、リリースノートで通知されます。これらの変更により、カスタム otel-collector 構成の更新が必要になる場合があります。

この制限のため、カスタム指標構成は一時的な回避策にのみ使用することをおすすめします。カスタム構成を使用する必要があることが判明した場合は、サポート チケットを送信して、機能またはバグの修正としての回避策をリクエストしてください。