安装 tencent-opentelemetry-operator

最近更新时间:2024-05-14 14:47:13

我的收藏
对于部署在容器服务 TKE 上的应用,腾讯云可观测团队提供了 Operator 方案:tencent-opentelemetry-operator, 此方案在社区 opentelemetry-operator 基础上构建,可以实现探针自动注入,方便应用快速接入 APM。目前 tencent-opentelemetry-operator 支持的编程语言包括 Java、Python、Node.js 和 .Net。
说明:
tencent-opentelemetry-operator 支持 Kubernetes 版本1.19及以上的 TKE 标准集群和 TKE Serverless 集群,暂不支持边缘集群和注册集群。

配置项说明

tencent-opentelemetry-operator 通过 Helm 部署安装,所有的配置项都集中于 values.yaml。请注意 YAML 文件中的参数存在层级关系,请参考如下 YAML 片段:
env:
TKE_CLUSTER_ID: "cls-ky8nmlra"
TKE_REGION: "ap-guangzhou"
APM_ENDPOINT: "http://pl.ap-guangzhou.apm.tencentcs.com:4317"
APM_TOKEN: "apmdemotoken"

必填字段

参数
描述
env.TKE_CLUSTER_ID
TKE 集群 ID。
env.TKE_REGION
TKE 集群所在地域,例如 ap-guangzhou,详情请参考 CVM 地域和可用区 的取值。
env.ENDPOINT
APM 内网接入点,每个集群必须指定唯一的 APM 内网接入点。
env.APM_TOKEN
默认的 APM 业务系统 token,可以在工作负载级别指定其他业务系统。

选填字段

参数
描述
env.JAVA_INSTR_VERSION
Java 探针版本,可以填latest(默认)或具体的版本号,非必要情况下不推荐填写此字段。
env.PYTHON_INSTR_VERSION
Python 探针版本,可以填latest(默认)或具体的版本号,非必要情况下不推荐填写此字段。
env.NODEJS_INSTR_VERSION
Node.js 探针版本,可以填latest(默认)或具体的版本号,非必要情况下不推荐填写此字段。
env.DOTNET_INSTR_VERSION
.Net 探针版本,可以填latest(默认)或具体的版本,非必要情况下不推荐填写此字段。
env.INTL_SITE
仅在国际站需要填成 true
说明:
如果需要指定具体的探针版本号,请前往 探针(Agent)版本信息 获取版本号。

安装方式

通过 APM 控制台一键安装(推荐)

由于配置项的填写比较复杂,推荐您使用 APM 控制台的一键安装 tencent-opentelemetry-operator 功能,以简化安装步骤。
1. 登录 腾讯云可观测平台 控制台。
2. 在左侧菜单栏中选择应用性能监控 > 应用监控,单击应用列表 > 接入应用
3. 点击需要接入的语言,选择 TKE 环境自动接入的上报方式。
4. 点击一键安装 Operator
5. 在弹出对话框中,选择对应的上报地域、默认业务系统、TKE 所在地域、TKE 集群,点击确认后即可在对应的 TKE 集群完成安装。
说明:
通过 APM 控制台一键安装的 tencent-opentelemetry-operator,会被安装到 kube-system 命名空间,如果需要修改相关配置项,可以在控制台对同一个 TKE 集群进行更新操作。

通过 TKE 应用市场安装

1. 登录 容器服务 控制台。
2. 在左侧菜单栏中选择应用市场,搜索 tencent-opentelemetry-operator。
3. 点击创建应用,选择需要安装的 TKE 集群,填入必要参数,即可完成安装。
说明:
通过 TKE 应用市场安装 tencent-opentelemetry-operator,可以安装在任何命名空间。在同一个 TKE 集群中,只能安装最多一个 tencent-opentelemetry-operator。

接入应用

安装完 tencent-opentelemetry-operator 后,会自动创建 opentelemetry-operator-system 命名空间,并创建相关 Kubernetes 资源。在需要接入 APM 的工作负载中添加相关 annotation,就可以实现探针自动注入,并向 APM 上报监控数据。