Bahubali Shetti

使用 OpenTelemetry 自动监控 Python 应用程序

了解如何使用 OpenTelemetry 自动监控 Python 应用程序。通过在 Docker 文件中使用标准命令，可以快速监控应用程序，而无需在多个地方编写代码，从而实现快速更改、扩展和更轻松的管理。

阅读时间：7分钟
OpenTelemetryAPMPython监控
Automatic instrumentation with OpenTelemetry for Python applications

DevOps 和 SRE 团队正在改变软件开发流程。DevOps 工程师专注于高效的软件应用程序和服务交付，而 SRE 团队则负责确保可靠性、可扩展性和性能。这些团队必须依靠全栈可观测性解决方案来管理和监控系统，并确保在问题影响业务之前解决问题。

跨现代分布式应用程序的整个堆栈的可观测性需要数据收集、处理和关联，通常以仪表盘的形式出现。摄取所有系统数据需要在堆栈、框架和提供商中安装代理，对于必须处理版本更改、兼容性问题以及无法随着系统更改而扩展的专有代码的团队来说，这是一个可能具有挑战性和耗时的过程。

感谢 OpenTelemetry (OTel)，DevOps 和 SRE 团队现在有了一种标准方法来收集和发送数据，这种方法不依赖于专有代码，并且拥有庞大的支持社区，从而减少了供应商锁定。

在 之前的博文中，我们还回顾了如何使用 OpenTelemetry 演示 并将其连接到 Elastic®，以及 Elastic 在 OpenTelemetry 可视化 和 Kubernetes 中的一些功能。

在本博文中，我们将展示如何将 OpenTelemetry 的自动监控 与我们 名为 Elastiflix 的应用程序 的 Python 服务一起使用，这有助于以简单的方式突出显示自动监控。

其优势在于，**无需使用 otel-collector**！此设置使您能够根据最适合您业务的时间表，缓慢且轻松地将应用程序迁移到使用 Elastic 的 OTel。

应用程序、先决条件和配置

我们用于本博文的应用程序称为 Elastiflix，这是一个流媒体应用程序。它由几个用 .NET、NodeJS、Go 和 Python 编写的微服务组成。

在监控我们的示例应用程序之前，我们首先需要了解 Elastic 如何接收遥测数据。

Elastic 可观测性的所有 APM 功能都可用于 OTel 数据。其中一些包括

  • 服务地图
  • 服务详细信息（延迟、吞吐量、失败的事务）
  • 服务之间的依赖关系，分布式追踪
  • 事务（跟踪）
  • 机器学习 (ML) 关联
  • 日志关联

除了 Elastic 的 APM 和统一的遥测数据视图之外，您还可以使用 Elastic 的强大机器学习功能来减少分析，并使用警报来帮助减少 MTTR。

先决条件

查看示例源代码

完整的源代码（包括本博文中使用的 Dockerfile）可以在 GitHub 上找到。该存储库还包含 没有监控的相同应用程序。这使您可以比较每个文件并查看差异。

以下步骤将向您展示如何监控此应用程序并在命令行或 Docker 中运行它。如果您有兴趣了解更多完整的 OTel 示例，请查看 docker-compose 文件 此处，它将启动整个项目。

分步指南

步骤 0. 登录您的 Elastic Cloud 账户

本博文假设您拥有一个 Elastic Cloud 账户 — 如果没有，请按照 说明开始使用 Elastic Cloud。

步骤 1. 为 Python 服务配置自动监控

我们将使用来自 Elastiflix 演示应用程序 的 Python 服务的自动监控。

我们将使用 Elastiflix 中的以下服务

Elastiflix/python-favorite-otel-auto

根据 OpenTelemetry Python 自动监控文档，您只需使用 pip install 安装相应的 Python 包即可。

>pip install opentelemetry-distro \
	opentelemetry-exporter-otlp

>opentelemetry-bootstrap -a install

如果您在命令行上运行 Python 服务，则可以使用以下命令

opentelemetry-instrument python main.py

对于我们的应用程序，我们将其作为 Dockerfile 的一部分进行操作。

Dockerfile

FROM python:3.9-slim as base

# get packages
COPY requirements.txt .
RUN pip install -r requirements.txt
WORKDIR /favoriteservice

#install opentelemetry packages
RUN pip install opentelemetry-distro \
	opentelemetry-exporter-otlp

RUN opentelemetry-bootstrap -a install

# Add the application
COPY . .

EXPOSE 5000
ENTRYPOINT [ "opentelemetry-instrument", "python", "main.py"]

步骤 2. 使用环境变量运行 Docker 镜像

如 OTEL Python 文档 中所述，我们将使用环境变量并将配置值传递进来，以使其能够连接到 Elastic 可观测性的 APM 服务器。

由于 Elastic 本机接受 OTLP，我们只需提供 OTEL Exporter 需要发送数据的端点和身份验证，以及其他一些环境变量。

获取 Elastic Cloud 变量
您可以从 Kibana® 中路径 /app/home#/tutorial/apm 下复制端点和令牌。

您需要复制以下环境变量

OTEL_EXPORTER_OTLP_ENDPOINT
OTEL_EXPORTER_OTLP_HEADERS

构建镜像

docker build -t  python-otel-auto-image .

运行镜像

docker run \
       -e OTEL_EXPORTER_OTLP_ENDPOINT="<REPLACE WITH OTEL_EXPORTER_OTLP_ENDPOINT>" \
       -e OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer%20<REPLACE WITH TOKEN>" \
       -e OTEL_RESOURCE_ATTRIBUTES="service.version=1.0,deployment.environment=production" \
       -e OTEL_SERVICE_NAME="python-favorite-otel-auto" \
       -p 5001:5001 \
       python-otel-auto-image

**重要提示：**请注意，“OTEL_EXPORTER_OTLP_HEADERS”变量在 Bearer 之后有空格，已转义为“%20” — 这是 Python 的要求。

你现在可以发出一些请求来生成跟踪数据。请注意，这些请求预计会返回错误，因为此服务依赖于与 Redis 的连接，而你目前没有运行 Redis。如前所述，你可以在这里找到使用 docker-compose 的更完整的示例。

curl localhost:5000/favorites

# or alternatively issue a request every second

while true; do curl "localhost:5000/favorites"; sleep 1; done;

步骤 3：在 Elastic APM 中探索跟踪、指标和日志

在 Elastic APM 中浏览“服务”部分，你会看到显示的 Python 服务。

点击 python-favorite-otel-auto 服务，你可以看到它正在使用 OpenTelemetry 摄取遥测数据。

在这篇博文中，我们讨论了以下内容：

  • 如何使用 OpenTelemetry 自动检测 Python
  • 使用 Dockerfile 中的标准命令，可以高效地进行自动检测，而无需在多个地方添加代码。

由于 Elastic 可以支持多种数据摄取方法，无论是使用开源 OpenTelemetry 的自动检测还是使用其原生 APM 代理的手动检测，你都可以先专注于几个应用程序来规划迁移到 OTel，然后稍后以最符合你的业务需求的方式在你的应用程序中使用 OpenTelemetry。

开发者资源

通用配置和用例资源

还没有 Elastic Cloud 账户？注册 Elastic Cloud 并尝试我上面讨论的自动检测功能。我很乐意了解你使用 Elastic 提高应用程序堆栈可见性的体验反馈。

本文中描述的任何功能或功能的发布和时间安排完全由 Elastic 自行决定。任何当前不可用的功能或功能可能无法按时或根本无法交付。

分享此文章

XFacebookLinkedInReddit