腾讯云可观测平台 通过 OpenTelemetry-Go 探针接入 Go 应用(推荐)

腾讯云 OpenTelemetry-Go 探针基于社区 opentelemetry-go-auto-instrumentation 项目二次开发。该方案基于编译期增强机制实现自动埋点,可以在不需要修改业务代码的情况下,将 Go 应用接入应用性能监控 APM。该方案对于 Go 系常用依赖库和框架,包括 Gin、GORM、gRPC 等,提供了自动埋点支持,其他支持自动埋点的依赖库和框架。

相关产品
腾讯云可观测平台 产品页,含版本规格、价格与购买入口。

注意:说明:

注意:OpenTelemetry 是工具、API 和 SDK 的集合,用于检测、生成、收集和导出遥测数据(指标、日志和跟踪),帮助用户分析软件的性能和行为。关于 OpenTelemetry 的更多信息请参见 OpenTelemetry 网站。

一、前提条件

请使用 Go 1.23及以上版本。

二、步骤1:获取接入点和 Token

1. 登录 腾讯云可观测平台 控制台。

2. 在左侧菜单栏中选择应用性能监控 > 应用列表,单击接入应用。

3. 在右侧弹出的接入应用抽屉框中,单击 Go 语言。

4. 在接入 Go 应用页面,选择你所要接入的地域以及业务系统。

5. 选择接入协议类型为 OpenTelemetry。

6. 选择你所想要的上报方式,获取你的接入点和 Token。

注意:说明:

三、步骤2:下载探针

请前往 探针(Agent)版本信息 下载腾讯云 OpenTelemetry-Go 探针,推荐下载最新版本,探针文件名为 otel。

四、步骤3:锁定 OpenTelemetry-Go SDK 的版本(可选)

当前的 OpenTelemetry-Go 探针方案依赖 OpenTelemetry-Go SDK v1.35.0,如果你在 Go 项目中引入了更高的 SDK 版本,请运行如下命令手动将 SDK 锁定至 v1.35.0:

go mod edit -require=go.opentelemetry.io/otel@v1.35.0go mod edit -require=go.opentelemetry.io/otel/sdk@v1.35.0go mod edit -require=go.opentelemetry.io/otel/trace@v1.35.0go mod edit -require=go.opentelemetry.io/otel/metric@v1.35.0

五、步骤4:编译应用

对工具赋予执行权限。

chmod +x otel

对 Go 编译命令添加 otel 前缀,完成应用编译。例如,go build … 命令将修改为./otel go build …。

./otel go build -o app

六、步骤5:添加环境变量

在 Go 应用的运行环境中添加如下环境变量,然后启动应用:

OTEL_EXPORTER_OTLP_ENDPOINT=<endpoint> \\OTEL_SERVICE_NAME=<serviceName> \\OTEL_EXPORTER_OTLP_PROTOCOL=grpc \\OTEL_TRACES_EXPORTER=otlp \\OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE=DELTA \\OTEL_RESOURCE_ATTRIBUTES=token=<token>,host.name=<hostName> \\./app

对应的字段说明如下,请根据实际情况进行替换。

·<serviceName> :应用名,多个使用相同 serviceName 接入的应用进程,在 APM 中会表现为相同应用下的多个实例。应用名最长63个字符,只能包含小写字母、数字及分隔符“ – ”,且必须以小写字母开头,数字或小写字母结尾。

·<token> :前置步骤中拿到业务系统 Token。

·<hostName>:该实例的主机名,是应用实例的唯一标识,通常情况下可以设置为应用实例的 IP 地址。对于 K8s 环境,可以通过 Downward API 动态获取 Pod IP,具体配置方式请参见 动态获取 Pod 名称和 Pod IP。

·<endpoint> :前置步骤中拿到的接入点。

注意:说明:

注意:上述列出的字段均为必填(Required)。

七、接入验证

完成以上接入步骤后,Go 应用将向 APM 服务端上报监控数据。在有正常流量的情况下,应用性能监控 > 应用列表 中将展示接入的应用,单击应用名称/ID 进入应用详情页。

再选择实例分析,即可看到接入的应用实例。由于可观测数据的处理存在一定延时,如果接入后在控制台没有查询到应用或实例,请等待30秒左右。

八、自定义埋点增强

当编译期增强方案的自动埋点范围不满足你的场景,或者需要增加业务层埋点时,你可以参见 通过 OpenTelemetry SDK 接入 Go 应用(推荐),基于 OpenTelemetry SDK 进行自定义埋点增强。自定义埋点增强是对编译期增强方案的补充,两者共享同样的链路上下文,不会导致冲突。

赞 (0)
上一篇 4天前
下一篇 4天前