如何通过Dockerfile为FastAPI应用注入OpenTelemetry Agent？

问题核心 #

1. 缺少必要依赖包：容器环境默认未安装包含opentelemetry-instrument脚本的opentelemetry-distro工具包，以及FastAPI对应的 instrumentation 组件。
2. 启动命令格式错误：当前ENTRYPOINT写法重复了python3，且参数结构不符合工具调用规范。

修复方案 #

1. 完善Dockerfile的依赖安装 #

在构建镜像时明确安装OpenTelemetry相关工具包，示例Dockerfile如下：

# 基于Python官方镜像构建
FROM python:3.11-slim

WORKDIR /app

# 复制并安装应用基础依赖
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

# 安装OpenTelemetry工具及FastAPI instrumentation
RUN pip install --no-cache-dir opentelemetry-distro opentelemetry-instrumentation-fastapi

# 设置OpenTelemetry环境变量
ENV OTEL_RESOURCE_ATTRIBUTES=service.name=waves-datahandler
ENV OTEL_PYTHON_EXCLUDED_URLS="/metrics"
ENV OTEL_EXPORTER_OTLP_ENDPOINT="http://0.0.0.0:4317"

# 复制应用代码
COPY main.py .

# 正确的启动命令
ENTRYPOINT ["opentelemetry-instrument", "python3", "main.py"]

2. 修正启动命令逻辑 #

无需额外添加python3 -m前缀，opentelemetry-instrument本身是可执行脚本，直接用它包装你的应用启动命令即可，避免重复调用Python解释器。

3. 可选：整合依赖到requirements.txt #

如果希望统一管理依赖，可将OpenTelemetry相关包加入requirements.txt：

# requirements.txt内容示例
fastapi
uvicorn
opentelemetry-distro
opentelemetry-instrumentation-fastapi

之后Dockerfile中可删除单独安装这些包的RUN命令，直接通过pip install -r requirements.txt完成安装。

额外注意事项 #

• 若使用Docker Compose部署，OTLP端点地址需改为Collector服务的名称（比如http://otel-collector:4317），容器内的0.0.0.0仅指向自身，无法访问其他容器。
• 安装完成后，opentelemetry-instrument会被放入Python的bin目录（如/usr/local/bin），该目录默认在容器的PATH中，可直接调用。

内容的提问来源于stack exchange，提问作者santi cazorla