OpenShift 4 - 可观测性之通过向被观测应用注入OpenTelemetry Agent 实现应用访问跟踪（附视频）

已于 2024-12-23 10:02:23 修改
阅读量493 收藏
点赞数
CC 4.0 BY-SA版权
文章标签： openshift
于 2023-07-12 15:25:05 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_43902588/article/details/131261052

《OpenShift / RHEL / DevSecOps 汇总目录》
说明：本文已经在支持 OpenShift 4.17 + Red Hat build of OpenTelemetry Opeartor 0.107.0-5 的环境中验证

文章目录

从应用获取跟踪数据的两种方法

OpenTelemetry 从被跟踪应用获取跟踪数据可以使用两种手段：手动手段和自动手段。它们的实现方法区别如下表：
在这里插入图片描述
本文重点介绍的 Auto Instrumentation 需要在 Operator 中创建一个 Instrumentation 对象，它为自动通过 Sidecar 注入的 Agent 提供配置。根据该配置，从被跟踪应用收集的数据将发送给指定的 Collector 收集器。
在这里插入图片描述

部署运行环境

安装配置 Distributed Tracing Platform Opeartor

为了跟踪应用访问，本文使用的是 Red Hat build of OpenTelemetry Opeartor，也可以用 Tempo Operator 实现相同功能。

  1. 使用缺省配置安装 OpenShift Distributed Tracing Platform Opeartor。
  2. 在 OpenShift Distributed Tracing Platform Opeartor 中基于以下 YAML 创建一个 Jaeger 运行实例。
$ oc new-project app-observ
 
$ oc apply -f - << EOF
kind: Jaeger
apiVersion: jaegertracing.io/v1
metadata:
  name: jaeger-all-in-one-inmemory
  namespace: app-observ
spec:
  strategy: allInOne
EOF
  1. 查看 Jaeger 相关服务和使用的端口。
$ oc get svc -n app-observ
NAME                                                    TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)                                                    AGE
service/jaeger-all-in-one-inmemory-agent                ClusterIP   None             <none>        5775/UDP,5778/TCP,6831/UDP,6832/UDP                        76m
service/jaeger-all-in-one-inmemory-collector            ClusterIP   172.30.75.167    <none>        9411/TCP,14250/TCP,14267/TCP,14268/TCP,4317/TCP,4318/TCP   76m
service/jaeger-all-in-one-inmemory-collector-headless   ClusterIP   None             <none>        9411/TCP,14250/TCP,14267/TCP,14268/TCP,4317/TCP,4318/TCP   76m
service/jaeger-all-in-one-inmemory-query                ClusterIP   172.30.134.109   <none>        443/TCP,16685/TCP                                          76m

另外还可以在 OpenShift 控制台的开发者视图中查看和 aeger-all-in-one-inmemory 部署相关的服务，其中 jaeger-all-in-on-inmemory-collector 服务显示了其使用的端口和对应的访问协议。
在这里插入图片描述

  1. 获得 Jaeger 控制台的访问地址，然后用浏览器访问。
$ oc get route jaeger-all-in-one-inmemory -n app-observ -o jsonpath='{.spec.host}'

在这里插入图片描述

安装配置 Red Hat build of OpenTelemetry Opeartor

  1. 使用缺省配置安装 Red Hat build of OpenTelemetry Opeartor。
  2. 在 Red Hat build of OpenTelemetry Opeartor 中使用以下 YAML 创建一个 OpenTelemetry Instrumentation 实例，它用来说明使用何种配置向运行应用的 Pod 自动注入 Sidecar 容器。
    注意：spec.exporter 定义了缺省的数据出口使用的服务地址，由于 dotnet 和 pytho 使用的 Agent 使用了不同的传输协议，因此在 OTEL_EXPORTER_OTLP_ENDPOINT 环境变量中设置了非缺省的 exporter 地址。
apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
metadata:
  name: instrumentation
  namespace: app-observ
spec:
  exporter:
    endpoint: 'http://jaeger-all-in-one-inmemory-collector:4317'
  sampler:
    type: always_on
  dotnet:
    env:
      - name: OTEL_EXPORTER_OTLP_ENDPOINT
        value: 'http://jaeger-all-in-one-inmemory-collector:4318'
  python:
    env:
      - name: OTEL_EXPORTER_OTLP_ENDPOINT
        value: 'http://jaeger-all-in-one-inmemory-collector:4318'

安装测试应用并进行观测跟踪

部署 Java 应用并注入 Auto-Instrumentation

  1. 在 OpenShift 的开发者视图中点击“添加” 菜单，在“添加” 页面中找到 “样本” 并点击进入。
  2. 在 “样本” 页面中按照 java 搜索到 Basic Spring Boot，然后点击进入。
    在这里插入图片描述
  3. 在页面中将名称设为 springboot-app，然后点击 “创建”。
    在这里插入图片描述
  4. 当应用已经部署完成后执行以下命令，向部署增加自动注入 OpenTelemetry Instrumentation 的注释。
$ oc patch deployment springboot-app -n app-observ -p '{"spec": {"template": {"metadata": {"annotations": {"instrumentation.opentelemetry.io/inject-java": "true"}}}}}'

也可以直接向 springboot-app 部署追加以下的 YAML。

  annotations:
    instrumentation.opentelemetry.io/inject-java: 'true'

在这里插入图片描述

  1. 执行以下命令确认 pod 中已经有 2 个容器了，其中一个为 opentelemetry-auto-instrumentation。
$ oc get pod -n app-observ -l app=springboot-app -o custom-columns=CONTAINER:.spec.containers[0].name,SIDECAR-CONTAINER:.spec.initContainers[0].name
CONTAINER        SIDECAR-CONTAINER
springboot-app   opentelemetry-auto-instrumentation
  1. 查看 springboot-app-xxxx 的 Pod 日志，确认其中为 javaagent 参数设置了 otel-auto-instrumentation/javaagent.jar。
    在这里插入图片描述
  2. 执行命令访问应用。
$ curl -k https://$(oc get route springboot-app -n app-observ -o jsonpath={.spec.host})
Hello World!
  1. 刷新 Jaeger 控制台，在 Service 选中 springboot-app，点击 Find Traces 后可以看到跟踪到的请求和用时。
    在这里插入图片描述

部署 Nodejs 应用并注入 Auto-Instrumentation

  1. 在 OpenShift 的开发者视图中点击“添加” 菜单，在“添加” 页面中找到 “样本” 并点击进入。
  2. 在 “样本” 页面中按照 node.js 搜索到 Basic Node.js，然后点击进入。
    在这里插入图片描述
  3. 在页面中将名称设为 nodejs-app，然后点击 “创建”。
    在这里插入图片描述
  4. 当应用已经部署完成后执行以下命令，向部署增加自动诸如 OpenTelemetry Instrumentation 的注释。
$ oc patch deployment nodejs-app -n app-observ -p '{"spec": {"template": {"metadata": {"annotations": {"instrumentation.opentelemetry.io/inject-nodejs": "true"}}}}}'
  1. 执行以下命令，确认 pod 中已经有 2 个容器了，其中一个为 opentelemetry-auto-instrumentation。
$ oc get pod -n app-observ -l app=nodejs-app -o custom-columns=CONTAINER:.spec.containers[0].name,SIDECAR-CONTAINER:.spec.initContainers[0].name
CONTAINER    SIDECAR-CONTAINER
nodejs-app   opentelemetry-auto-instrumentation
  1. 执行命令访问应用。
$ curl -k https://$(oc get route nodejs-app -n app-observ -o jsonpath={.spec.host})
Hello from Node.js Starter Application!

  1. 刷新 Jaeger 控制台，在 Service 选中 nodejs-app，点击 Find Traces 后可以看到跟踪到的请求和用时。
    在这里插入图片描述

    部署 Python 应用并注入 Auto-Instrumentation

  2. 在 OpenShift 的开发者视图中点击“添加” 菜单，在“添加” 页面中找到 “样本” 并点击进入。

  3. 在 “样本” 页面中按照 python 搜索到 Basic Python，然后点击进入。
    在这里插入图片描述

  4. 在页面中将名称设为 python-app，然后点击 “创建”。
    在这里插入图片描述

  5. 当应用已经部署完成后执行以下命令，向部署增加自动诸如 OpenTelemetry Instrumentation 的注释。

$ oc patch deployment python-app -n app-observ -p '{"spec": {"template": {"metadata": {"annotations": {"instrumentation.opentelemetry.io/inject-python": "true"}}}}}'
  1. 执行以下命令，确认 pod 中已经有 2 个容器了，其中一个为 opentelemetry-auto-instrumentation。
$ oc get pod -n app-observ -l app=python-app -o custom-columns=CONTAINER:.spec.containers[0].name,SIDECAR-CONTAINER:.spec.initContainers[0].name
CONTAINER    SIDECAR-CONTAINER
python-app   opentelemetry-auto-instrumentation
  1. 在应用对应的 Pod 查看环境，其中 python-app 容器用到的变量名 OTEL_EXPORTER_OTLP_ENDPOINT 的值是 http://jaeger-all-in-one-inmemory-collector:4318
    在这里插入图片描述
  2. 执行命令访问应用。
$ curl -k https://$(oc get route python-app -n app-observ -o jsonpath={.spec.host})
Hello World!
  1. 刷新 Jaeger 控制台，在 Service 选中 python-app，点击 Find Traces 后可以看到跟踪到的请求和用时。
    在这里插入图片描述

部署 .Net 应用并注入 Auto-Instrumentation

  1. 在 OpenShift 的开发者视图中点击“添加” 菜单，在“添加” 页面中找到 “样本” 并点击进入。
  2. 在 “样本” 页面中按照 .NET 搜索到 .NET，然后点击进入。
    在这里插入图片描述
  3. 在页面中将名称设为 dotnet-app，然后点击 “创建”。
    在这里插入图片描述
  4. 当应用已经部署完成后执行以下命令，向部署增加自动诸如 OpenTelemetry Instrumentation 的注释。
$ oc patch deployment dotnet-app -p '{"spec": {"template": {"metadata": {"annotations": {"instrumentation.opentelemetry.io/inject-dotnet": "true"}}}}}'
  1. 执行以下命令，确认 pod 中已经有 2 个容器了，其中一个为 opentelemetry-auto-instrumentation。
$ oc get pod -n app-observ -l app=dotnet-app -o custom-columns=CONTAINER:.spec.containers[0].name,SIDECAR-CONTAINER:.spec.initContainers[0].name
CONTAINER    SIDECAR-CONTAINER
dotnet-app   opentelemetry-auto-instrumentation
  1. 在应用对应的 Pod 查看环境，其中 dotnet-app 容器用到的变量名 OTEL_EXPORTER_OTLP_ENDPOINT 的值是 http://jaeger-all-in-one-inmemory-collector:4318
    在这里插入图片描述
  2. 执行命令访问应用。
$ curl -k https://$(oc get route notnet-app -n app-observ -o jsonpath={.spec.host})
  1. 刷新 Jaeger 控制台，在 Service 选中 dotnet-app，点击 Find Traces 后可以看到跟踪到的请求和用时。
    在这里插入图片描述

部署 Quarkus 的 SuperHero 应用

  1. 执行命令，部署 SuperHero 相关资源。
$ oc apply -f https://raw.githubusercontent.com/liuxiaoyu-git/OpenShift-HOL/master/superhero.yaml

在这里插入图片描述

  1. 获取 ui-super-heroes 的访问地址，然后用浏览器访问该应用。
$ oc get route ui-super-heroes -n app-observ -ojsonpath={.spec.host}
  1. 在 Jaeger 中可查看 up-super-heroes 服务以及请求跟踪。
    在这里插入图片描述

视频

演示视频

参考

https://medium.com/opentelemetry/using-opentelemetry-auto-instrumentation-agents-in-kubernetes-869ec0f42377
https://medium.com/@akashjoffical08/implement-distributed-tracing-with-jaeger-opentelemetry-on-kubernetes-3e35cb77b536
https://medium.com/@magstherdev/opentelemetry-up-and-running-b4c58eaf8c05
https://opentelemetry.io/docs/kubernetes/operator/automatic/
https://opentelemetry.io/docs/demo/architecture/
https://www.aneasystone.com/archives/2022/11/opentelemetry-observability.html
https://www.aspecto.io/blog/what-is-opentelemetry-the-infinitive-guide/
https://developers.redhat.com/articles/2023/03/22/how-enable-opentelemetry-traces-react-applications
https://github.com/jpkrohling/opentelemetry-collector-deployment-patterns
https://github.com/open-telemetry/opentelemetry-operator/blob/main/README.md
https://github.com/rbaumgar/otelcol-demo-app/blob/main/ServicePerformanceMonitoring.md
https://www.redhat.com/en/blog/announcing-red-hat-build-opentelemetry-and-distributed-tracing-3.2-release

dawnsky.liu
关注
NFV技术助力AI算力网络与通信的跨领域融合
AI天才研究院
07-05 449
本文系统阐述网络功能虚拟化(NFV)作为AI算力网络与通信基础设施跨领域融合的关键使能技术。通过解构NFV的核心架构与AI算力网络的本质需求，建立两者融合的理论框架与技术路径。分析表明，NFV通过资源抽象、动态编排和服务可编程三大支柱，有效解决AI算力供给与通信网络需求之间的资源适配、动态调度和服务定制问题。文中提出基于NFV的AI-通信融合范式，包括层次化架构设计、智能资源调度算法、安全隔离机制和端到端服务质量保障策略，并通过实际案例验证该融合架构的技术可行性与商业价值。
《云原生》核心内容梳理和分阶段学习计划
博客主要分享技术教程、工具教程、bug解决、前沿技术动态、编程经验、心得感悟等。 内容同步、干货获取、推广宣发请看侧栏推广信息
04-29 212
云原生核心内容梳理和分阶段学习计划
opentelemetry-java-instrumentation：适用于Java的OpenTelemetry自动仪器和工具库
02-17
•• •• 适用于Java的OpenTelemetry Instrumentation 关于 该项目提供了Java代理JAR，该Java代理JAR可以附加到任何Java 8+应用程序，并动态注入字节码以捕获来自许多流行的库和框架的遥测。 您可以采用多种格式导出遥测数据。 您还可以通过命令行参数或环境变量来配置代理和导出器。 最终结果是无需更改代码即可从Java应用程序收集遥测数据的能力。 入门 下载。 该软件包包括检测代理以及所有受支持的库和所有可用数据导出器的检测。 该软件包提供了一种全自动的，即开即用的体验。 使用JVM的-javaagent标志启用检测代理。 java -javaagent:path/to/opentelemetry-javaagent-all.jar \ -jar myapp.jar 默认情况下，OpenTelemetry Java代理使用程序，该
opentelemetry之分布式链路追踪 -- 10.openresty agent环境构建
piaobeizu2011的专栏
05-20 2630
本文从源代码级别做了相应的编译工作，所以，如果有小伙伴想对官方的 nginx instrumentation 进行二次开发或者根据需求自己编译so文件，都可以参考本文的实践过程。
入门OpenTelemetry——部署OpenTelemetry
qq_33816243的博客
05-14 1419
OpenTelemetry Collector 按部署方式分为 Agent 和Gateway 模式。
OpenTelemetry In Java之自动检测Agent配置
MCC_MCC_MCC的博客
05-24 1925
SDK 的自动配置模块用于代理的基本配置，阅读以查找配置导出或采样等设置。
拥抱 OpenTelemetry：阿里云 Java Agent 演进实践
阿里巴巴中间件
11-07 1319
背景Cloud Native在 2018 年的 2 月，ARMS Java Agent 的第一个版本正式发布，为用户提供无侵入的的可观测数据采集服务。6 年后的今天，随着软件技术的迅猛发展、业务场景的逐渐丰富、用户规模的快速增长，我们逐渐发现过去的功能以及架构的设计逐渐难以合理、优雅的满足今天的需求，重构越来越多的被提及，但总是缺少一个合理的契机。适时，OTel 项目异军突起，其社区经过短短四年的...
初探 OpenTelemetry
weixin_38846160的博客
05-21 4427
OpenTelemetry 由 OpenTracing 和 OpenCensus 项目合并而成，是一组规范、工具、API 和 SDK 的集合。使用它来检测、生成、收集和导出遥测数据（Metrics、Logs 和 Traces），以帮助运维开发人员分析软件的性能和行为。为众多开发人员带来MetricsTracesLogs的统一标准，三者都有相同的元数据结构，可以轻松实现互相关联。OpenTelemetry 是一个CNCF孵化项目。OpenTelemetry 与厂商、平台无关，不提供与可观测性相关的后端服务。
平台应用管理
最新发布
07-01
3.监控与日志：集成监控工具（如Prometheus, Grafana）和日志系统（如ELKStack）实现全栈可观测性。4.资源与成本管理：监控资源使用情况，优化成本，例如通过自动扩缩容（HPA）和资源配额。5.安全与合规：实施平台级...
基于 Golang 构建高可扩展的云原生 PaaS（附 PPT 下载）
m0_59358648的博客
07-27 699
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yWCNXPNb-1627371308598)(https://intranetproxy.alipay.com/skylark/lark/0/2021/png/21956387/1627348489978-e9f7d088-8bf8-49b3-a046-6ff927eef3ff.png#clientId=ub48dfedc-5213-4&from=ui&id=uca70a2e3&margin=%5Bobj
【云原生进阶之容器】第二章——Kubernetes概述
junbaozi的专栏
12-23 717
kubernetes，是一个全新的基于容器技术的分布式架构领先方案，是谷歌严格保密十几年的秘密武器--Borg系统的一个开源版本，于2014年9月发布第一个版本，2015年7月发布第一个正式版本，简称k8s。其提供了面向应用的容器集群部署和管理系统。Kubernetes 的目标旨在消除编排物理 / 虚拟计算，网络和存储基础设施的负担，并使应用程序运营商和开发人员完全将重点放在以容器为中心的原语上进行自助运营。
OpenTelemetry部署
qq_62368250的博客
11-05 1617
没有OpenTelemetry之前这三种监控都是单独部署在应用程序上。
OpenTelemetry 系列 （四）｜ 如何使用 Java Agent 来实现无侵入的调用链
Q54665642ljf的博客
12-25 3039
Java Agent一般可以被称为探针，是一种可以在 Java 应启动前和运行中修改应用的字节码的技术。通过在启动项中添加来制定使用特定的 Agent。是一个隶属于 OpenTelemetry 系列的项目，这个项目就是一个基于Java Agent来实现无侵入式接入的官方 Agent 项目。复制代码将下载下来，然后使用上述指令就能够运行，在启动成功后就能够直接接入成功，而不用对应用本身的代码进行任何的修改。在这个篇章中我们简单的介绍了的使用，实际上这个项目支持了不少自定义的扩展能力。
OpenTelemetry agent 对 Spring Boot 应用的影响：一次 SPI 失效的调查
crossoverJie专栏
05-14 1568
背景前段时间公司领导让我排查一个关于在 JDK21 环境中使用 Spring Boot 配合一个 JDK18 新增的一个 SPI(java.net.spi.InetAddressResolverProvider) 不生效的问题。但这个不生效的前置条件有点多：JDK 的版本得在 18+SpringBoot3.x还在额外再配合使用 -javaagent:opentelemetry-javaagent....
OpenTelemetry系列 （四）｜ 如何使用Java Agent来实现无侵入的调用链
BASK2311的博客
02-07 1022
Java Agent一般可以被称为探针，是一种可以在Java应启动前和运行中修改应用的字节码的技术。通过在启动项中添加来制定使用特定的Agent。是一个隶属于OpenTelemetry系列的项目，这个项目就是一个基于Java Agent来实现无侵入式接入的官方Agent项目。复制代码将下载下来，然后使用上述指令就能够运行，在启动成功后就能够直接接入成功，而不用对应用本身的代码进行任何的修改。在这个篇章中我们简单的介绍了的使用，实际上这个项目支持了不少自定义的扩展能力。在下一个篇章中，会着重介绍如何在。
OpenTelemetry系列 - 第2篇 Java端接入OpenTelemetry
罗小爬的技术宝书
12-02 7573
目录一、架构说明二、方式1 - 自动化2.1 opentelemetry-javaagent.jar（Java8+ ）2.2 使用opentelemetry-javaagent.jar完成自动注入2.3 配置opentelemetry-javaagent.jar2.4 使用注解（@WithSpan, @SpanAttribute）2.5.1 代码集成@WithSpan, @SpanAttribute2.5.2 禁用已标注@WithSpan的方法的自动注入：2.5.3 不修改代码的情况下启用@WithSpan
实操 OpenTelemetry：通过 Demo 掌握微服务监控的艺术
crossoverJie专栏
05-27 1969
前言在上一篇文章 OpenTelemetry 实践指南：历史、架构与基本概念中回顾了可观测性的历史以及介绍了一些 OpenTelemetry 的基础概念，同时也介绍了 OpenTelemetry 社区常用的开源项目。基础背景知识了解后，这篇就来介绍一下使用 OpenTelemetry 如何实战部署应用，同时在一个可视化页面查看 trace、metric 等信息。项目介绍我们参考官方文档构建几个 s...
OpenTelemetry 实战：从零实现分布式链路追踪
crossoverJie专栏
08-21 1965
背景之前写过一篇 从 Dapper 到 OpenTelemetry：分布式追踪的演进之旅的文章，主要是从概念上讲解了 Trace 在 OpenTelemetry 的中的场景和使用。也写过一篇 实操 OpenTelemetry：通过 Demo 掌握微服务监控的艺术：如何从一个 demo 开始集成 OpenTelemetry。但还是有不少小伙伴反馈说无法快速上手（可能也是这个 demo 的项目比较多）...
OpenTelemetry-结束分布式追踪的江湖之乱
qq_35427785的博客
02-07 5346
部分内容摘自：《OpenTelemetry中文文档-OT.md》 一、江湖乱象 分布式追踪，随着分布式系统的流行而兴起。在分布式系统中，往往存在一个单一的用户请求中，可能会需要大量微服务的处理后，才能完成这个请求，在微服务中的任何一个服务的失败或性能低下，都会对于用户请求的响应造成极大影响。随着业务的不断扩张，这个调用链的也就会越来越复杂。为了解决微服务架构中请求链路过长导致的问题定位和监控难问题，链路追踪产品也就应运而生。 目前的主流开源产品有Zipkin、Jaeger、PinPoint等。市场上产
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值