- ログ
- インフラ メトリクス
アプリケーションレベルのメトリクスや APM/トレースも送信するには、対応する言語向けインテグレーションもアプリケーションに追加する必要があります。
OTel Helm チャートの設定ファイルの作成
API key 用の Secret の作成
kubectl create secret generic hyperdx-secret \
--from-literal=HYPERDX_API_KEY=<ingestion_api_key> \
kubectl create configmap -n=otel-demo otel-config-vars --from-literal=YOUR_OTEL_COLLECTOR_ENDPOINT=<OTEL_COLLECTOR_ENDPOINT>
# 例: kubectl create configmap -n=otel-demo otel-config-vars --from-literal=YOUR_OTEL_COLLECTOR_ENDPOINT=http://my-hyperdx-hdx-oss-v2-otel-collector:4318
デーモンセット設定の作成
curl -O https://raw.githubusercontent.com/ClickHouse/clickhouse-docs/refs/heads/main/docs/use-cases/observability/clickstack/example-datasets/_snippets/k8s_daemonset.yaml
- Managed ClickStack
- ClickStack Open Source
k8s_daemonset.yaml
k8s_daemonset.yaml
# daemonset.yaml
mode: daemonset
# kubeletstats の CPU/メモリ使用率メトリクスを使用するために必要
clusterRole:
create: true
rules:
- apiGroups:
- ''
resources:
- nodes/proxy
verbs:
- get
presets:
logsCollection:
enabled: true
hostMetrics:
enabled: true
# Kubernetes Processor が Kubernetes メタデータを追加するように設定します。
# すべてのパイプラインに k8sattributes processor を追加し、ClusterRole に必要なルールも追加します。
# 詳細: https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-attributes-processor
kubernetesAttributes:
enabled: true
# 有効にすると、processor は関連付けられたポッドのすべてのラベルを抽出し、resource 属性として追加します。
# ラベルの正確な名前がキーになります。
extractAllPodLabels: true
# 有効にすると、processor は関連付けられたポッドのすべての annotation を抽出し、resource 属性として追加します。
# annotation の正確な名前がキーになります。
extractAllPodAnnotations: true
# collector がキューブレット上の API サーバーからノード、ポッド、コンテナーのメトリクスを収集するように設定します。
# メトリクス パイプラインに kubeletstats receiver を追加し、ClusterRole に必要なルールも追加します。
# 詳細: https://opentelemetry.io/docs/kubernetes/collector/components/#kubeletstats-receiver
kubeletMetrics:
enabled: true
extraEnvs:
- name: YOUR_OTEL_COLLECTOR_ENDPOINT
valueFrom:
configMapKeyRef:
name: otel-config-vars
key: YOUR_OTEL_COLLECTOR_ENDPOINT
config:
receivers:
# 追加の kubelet メトリクスを設定します
kubeletstats:
collection_interval: 20s
auth_type: 'serviceAccount'
endpoint: '${env:K8S_NODE_NAME}:10250'
insecure_skip_verify: true
metrics:
k8s.pod.cpu_limit_utilization:
enabled: true
k8s.pod.cpu_request_utilization:
enabled: true
k8s.pod.memory_limit_utilization:
enabled: true
k8s.pod.memory_request_utilization:
enabled: true
k8s.pod.uptime:
enabled: true
k8s.node.uptime:
enabled: true
k8s.container.cpu_limit_utilization:
enabled: true
k8s.container.cpu_request_utilization:
enabled: true
k8s.container.memory_limit_utilization:
enabled: true
k8s.container.memory_request_utilization:
enabled: true
container.uptime:
enabled: true
exporters:
otlphttp:
endpoint: "${env:YOUR_OTEL_COLLECTOR_ENDPOINT}"
compression: gzip
service:
pipelines:
logs:
exporters:
- otlphttp
metrics:
exporters:
- otlphttp
k8s_daemonset.yaml
k8s_daemonset.yaml
# daemonset.yaml
mode: daemonset
# kubeletstats の CPU/メモリ使用率メトリクスを使用するために必要
clusterRole:
create: true
rules:
- apiGroups:
- ''
resources:
- nodes/proxy
verbs:
- get
presets:
logsCollection:
enabled: true
hostMetrics:
enabled: true
# Kubernetes Processor が Kubernetes メタデータを追加するよう設定します。
# すべてのパイプラインに k8sattributes processor を追加し、クラスター ロールに必要なルールも追加します。
# 詳細: https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-attributes-processor
kubernetesAttributes:
enabled: true
# 有効にすると、processor は関連付けられたポッドのすべてのラベルを抽出し、resource attributes として追加します。
# ラベルの名前そのものがキーになります。
extractAllPodLabels: true
# 有効にすると、processor は関連付けられたポッドのすべての annotations を抽出し、resource attributes として追加します。
# annotation の名前そのものがキーになります。
extractAllPodAnnotations: true
# collector がキューブレット上の API サーバーからノード、ポッド、コンテナーのメトリクスを収集するよう設定します。
# メトリクス パイプラインに kubeletstats receiver を追加し、クラスター ロールに必要なルールも追加します。
# 詳細: https://opentelemetry.io/docs/kubernetes/collector/components/#kubeletstats-receiver
kubeletMetrics:
enabled: true
extraEnvs:
- name: HYPERDX_API_KEY
valueFrom:
secretKeyRef:
name: hyperdx-secret
key: HYPERDX_API_KEY
optional: true
- name: YOUR_OTEL_COLLECTOR_ENDPOINT
valueFrom:
configMapKeyRef:
name: otel-config-vars
key: YOUR_OTEL_COLLECTOR_ENDPOINT
config:
receivers:
# 追加のキューブレット メトリクスを設定します
kubeletstats:
collection_interval: 20s
auth_type: 'serviceAccount'
endpoint: '${env:K8S_NODE_NAME}:10250'
insecure_skip_verify: true
metrics:
k8s.pod.cpu_limit_utilization:
enabled: true
k8s.pod.cpu_request_utilization:
enabled: true
k8s.pod.memory_limit_utilization:
enabled: true
k8s.pod.memory_request_utilization:
enabled: true
k8s.pod.uptime:
enabled: true
k8s.node.uptime:
enabled: true
k8s.container.cpu_limit_utilization:
enabled: true
k8s.container.cpu_request_utilization:
enabled: true
k8s.container.memory_limit_utilization:
enabled: true
k8s.container.memory_request_utilization:
enabled: true
container.uptime:
enabled: true
exporters:
otlphttp:
endpoint: "${env:YOUR_OTEL_COLLECTOR_ENDPOINT}"
headers:
authorization: "${env:HYPERDX_API_KEY}"
compression: gzip
service:
pipelines:
logs:
exporters:
- otlphttp
metrics:
exporters:
- otlphttp
デプロイメント構成の作成
curl -O https://raw.githubusercontent.com/ClickHouse/clickhouse-docs/refs/heads/main/docs/use-cases/observability/clickstack/example-datasets/_snippets/k8s_deployment.yaml
- Managed ClickStack
- ClickStack Open Source
k8s_deployment.yaml
k8s_deployment.yaml
# deployment.yaml
mode: deployment
image:
repository: otel/opentelemetry-collector-contrib
tag: 0.123.0
# collector は 1 つだけ必要です。これ以上あると重複データが生成されます
replicaCount: 1
presets:
kubernetesAttributes:
enabled: true
# 有効にすると、この processor は関連付けられたポッドのすべてのラベルを抽出し、resource 属性として追加します。
# ラベルの正確な名前がキーになります。
extractAllPodLabels: true
# 有効にすると、この processor は関連付けられたポッドのすべての annotations を抽出し、resource 属性として追加します。
# annotation の正確な名前がキーになります。
extractAllPodAnnotations: true
# collector が Kubernetes イベントを収集するように設定します。
# logs パイプラインに k8sobject receiver を追加し、デフォルトで Kubernetes イベントを収集します。
# 詳細: https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-objects-receiver
kubernetesEvents:
enabled: true
# Kubernetes Cluster Receiver がクラスター レベルのメトリクスを収集するように設定します。
# metrics パイプラインに k8s_cluster receiver を追加し、ClusterRole に必要なルールを追加します。
# 詳細: https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-cluster-receiver
clusterMetrics:
enabled: true
extraEnvs:
- name: YOUR_OTEL_COLLECTOR_ENDPOINT
valueFrom:
configMapKeyRef:
name: otel-config-vars
key: YOUR_OTEL_COLLECTOR_ENDPOINT
config:
exporters:
otlphttp:
endpoint: "${env:YOUR_OTEL_COLLECTOR_ENDPOINT}"
compression: gzip
service:
pipelines:
logs:
exporters:
- otlphttp
metrics:
exporters:
- otlphttp
k8s_deployment.yaml
k8s_deployment.yaml
# deployment.yaml
mode: deployment
image:
repository: otel/opentelemetry-collector-contrib
tag: 0.123.0
# collector は 1 つだけ必要です。これ以上あると重複データが生成されます
replicaCount: 1
presets:
kubernetesAttributes:
enabled: true
# 有効にすると、この processor は関連付けられたポッドのすべてのラベルを抽出し、resource 属性として追加します。
# ラベルの正確な名前がキーになります。
extractAllPodLabels: true
# 有効にすると、この processor は関連付けられたポッドのすべての annotations を抽出し、resource 属性として追加します。
# annotation の正確な名前がキーになります。
extractAllPodAnnotations: true
# collector が Kubernetes イベントを収集するように設定します。
# logs パイプラインに k8sobject receiver を追加し、デフォルトで Kubernetes イベントを収集します。
# 詳細: https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-objects-receiver
kubernetesEvents:
enabled: true
# Kubernetes Cluster Receiver がクラスター レベルのメトリクスを収集するように設定します。
# metrics パイプラインに k8s_cluster receiver を追加し、ClusterRole に必要なルールを追加します。
# 詳細: https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-cluster-receiver
clusterMetrics:
enabled: true
extraEnvs:
- name: HYPERDX_API_KEY
valueFrom:
secretKeyRef:
name: hyperdx-secret
key: HYPERDX_API_KEY
optional: true
- name: YOUR_OTEL_COLLECTOR_ENDPOINT
valueFrom:
configMapKeyRef:
name: otel-config-vars
key: YOUR_OTEL_COLLECTOR_ENDPOINT
config:
exporters:
otlphttp:
endpoint: "${env:YOUR_OTEL_COLLECTOR_ENDPOINT}"
compression: gzip
headers:
authorization: "${env:HYPERDX_API_KEY}"
service:
pipelines:
logs:
exporters:
- otlphttp
metrics:
exporters:
- otlphttp
OpenTelemetry collector のデプロイ
helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts # OTel Helm リポジトリを追加
copy
helm install my-opentelemetry-collector-deployment open-telemetry/opentelemetry-collector -f k8s_deployment.yaml
helm install my-opentelemetry-collector-daemonset open-telemetry/opentelemetry-collector -f k8s_daemonset.yaml
リソースタグをポッドに転送する (推奨)
OTEL_RESOURCE_ATTRIBUTES
環境変数を使用して Kubernetes メタデータをアプリケーションに渡します。
以下は、環境変数を使用して Kubernetes メタデータを
アプリケーションに渡すデプロイメントの例です:
# my_app_deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: app-deployment
spec:
replicas: 1
selector:
matchLabels:
app: app
template:
metadata:
labels:
app: app
# Kubernetes Attribute Processorと組み合わせることで、
# ポッドのログとメトリクスがサービス名に関連付けられます。
service.name: <MY_APP_NAME>
spec:
containers:
- name: app-container
image: my-image
env:
# ... その他の環境変数
# Downward APIからK8sメタデータを収集してアプリに転送する
- name: POD_NAME
valueFrom:
fieldRef:
fieldPath: metadata.name
- name: POD_UID
valueFrom:
fieldRef:
fieldPath: metadata.uid
- name: POD_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: NODE_NAME
valueFrom:
fieldRef:
fieldPath: spec.nodeName
- name: DEPLOYMENT_NAME
valueFrom:
fieldRef:
fieldPath: metadata.labels['deployment']
# OTEL_RESOURCE_ATTRIBUTESを介してK8sメタデータをアプリに転送する
- name: OTEL_RESOURCE_ATTRIBUTES
value: k8s.pod.name=$(POD_NAME),k8s.pod.uid=$(POD_UID),k8s.namespace.name=$(POD_NAMESPACE),k8s.node.name=$(NODE_NAME),k8s.deployment.name=$(DEPLOYMENT_NAME)