在 k8s 上部署 OpenTelemetry Collector - 使用 Manifest

概要

otel 提供了 operator, helm chart, manifest 等三種在 k8s 上部署 otelcol 的方法，此篇文章會介紹如何使用 manifest 進行部署。

架構

架構圖

graph LR;
    subgraph node1
        subgraph app1 [app code]
            direction TB;
            code[main function]
            sdk[otel sdk]
            code -.- sdk
        end
        subgraph app1_1 [app code]
            direction TB;
            code1_1[main function]
            sdk1_1[otel sdk]
            code1_1 -.- sdk1_1
        end
        agent1[otel agent]
        app1 & app1_1--> agent1
    end
    subgraph node2
        subgraph app2 [app code]
            direction TB;
            code2[main function]
            sdk2[otel sdk]
            code2 -.- sdk2
        end
        agent2[otel agent]
        app2 --> agent2
    end
    subgraph node3
        collector[otel collector]
        agent1 & agent2 --> collector
    end
    collector -.-> backend[backend server]

說明

collector 通常會採用上圖的部署方式，若是規模較小或初次安裝測試，可以不安裝 otel agent，直接將遙測資料寄送至 collector。

補充

otel-agent 就是 collector，只是改為使用 daemonset 的方式，部署於每個節點，讓 app 就近寄送資料，再將資料轉發至主要 collector。

collector 不一定要安裝在獨立節點，示意圖為方便理解才獨立出來。

部署方法

取得 manifest

• 透過指令抓取

>>> curl -O https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/main/examples/k8s/otel-config.yaml

• 或是 點我

部署

• 使用指令部署

>>> kubectl apply -f otel-config.yaml

• 檢查是否部署成功

>>> kubectl get all

設定

雖然部署成功了，但目前的 collector 還沒被設定，因此是沒有任何功能的。

設定檔可以透過修改 yaml 中 ConfigMap.otel-collector-conf 來套用，撰寫方式請參考介紹文章。

補充

關於 otel agent

初次安裝測試時，可以將 otel-agent 的 ConfigMap 與 DaemonSet 移除，直接將資料寄送至 collector 以簡化測試流程。

關於 Service

在部署時，可以視自己情況調整 Service 設定，預設為使用 ClusterIP。

參考

• manifest

• 安裝文件

• 範例 (manifest 的 github 位址)

• docker hub