Observability：用 OpenTelemetry 自动检测 Python 应用程序

作者：来自 Elastic Bahubali Shetti

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

更多阅读，请参阅 “OpenTelemetry Python Elastic 分发简介”。

DevOps 和 SRE 团队正在改变软件开发过程。虽然 DevOps 工程师专注于高效的软件应用程序和服务交付，但 SRE 团队是确保可靠性、可扩展性和性能的关键。这些团队必须依赖全栈可观察性解决方案，该解决方案使他们能够管理和监控系统，并确保在问题影响业务之前得到解决。

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

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

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

在本博客中，我们将展示如何使用我们应用程序的 Python 服务 Elastiflix 对 OpenTelemetry 进行自动检测，这有助于以简单的方式突出显示自动检测。

这样做的好处是不需要 otel-collector！此设置使你能够根据最适合你业务的时间表，使用 Elastic 将应用程序缓慢而轻松地迁移到 OTel。

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

我们在本博客中使用的应用程序称为 Elastiflix，这是一款电影流应用程序。它由用 .NET、NodeJS、Go 和 Python 编写的几个微服务组成。

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

Elastic Observability 的所有 APM 功能均可通过 OTel 数据使用。其中包括：

除了 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 Automatic Instrumentation for 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 Observability 的 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 连接。如前所述，你可以在此处找到使用 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 提取遥测数据。

在本博客中，我们讨论了以下内容：

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

还没有 Elastic Cloud 帐户？注册 Elastic Cloud 并试用我上面讨论的自动检测功能。我很想听听你对使用 Elastic 深入了解应用程序堆栈的体验的反馈。

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

原文：https://www.elastic.co/observability-labs/blog/auto-instrumentation-python-applications-opentelemetry

作者：Elastic 中国社区官方博客