学习使用Opentelemetry python SDK

news2024/10/6 12:33:28

前言

📢博客主页：程序源⠀-CSDN博客
📢欢迎点赞👍收藏⭐留言📝如有错误敬请指正！

一、什么是 OpenTelemetry

OpenTelemetry 由 OpenTracing 和 OpenCensus 项目合并而成，是一组规范、工具、API 和 SDK 的集合。使用它来检测、生成、收集和导出遥测数据（Metrics、Logs 和 Traces），以帮助运维开发人员分析软件的性能和行为。为众多开发人员带来 Metrics、Traces、Logs 的统一标准，三者都有相同的元数据结构，可以轻松实现互相关联。

OpenTelemetry 是一个CNCF 孵化项目。OpenTelemetry 与厂商、平台无关，不提供与可观测性相关的后端服务。可根据用户需求将可观测类数据导出到存储、查询、可视化等不同后端，如 Prometheus、Jaeger 、云厂商服务中。

二、OpenTelemetry 诞生背景、主要特点和功能等相关介绍

参考如下文章：
http://t.csdnimg.cn/cKO5L

http://t.csdnimg.cn/SJK3k

三、使用Opentelemetry python SDK（以Windows为例）

3.1 环境准备

确保电脑上已经安装了Python

3.2 创建工程激活虚拟环境

在一个新目录中打开命令行

执行如下操作：

mkdir otel-getting-started
cd otel-getting-started
python3 -m venv venv
.\venv\Scripts\activate

3.3 安装框架和依赖

pip install flask

pip install opentelemetry-distre

opentelemetry-bootstrap-a install

3.4 创建并启动HTTP服务器

目录下新建app.py文件（使用软件为PyCharm），编写代码如下：

from random import randint
from flask import Flask, request
import logging

app = Flask(__name__)
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)


@app.route("/rolldice")
def roll_dice():
    player = request.args.get('player', default=None, type=str)
    result = str(roll())
    if player:
        logger.warning("%s is rolling the dice: %s", player, result)
    else:
        logger.warning("Anonymous player is rolling the dice: %s", result)
    return result


def roll():
    return randint(1, 6)

在终端中打开目录，启动服务。

设置环境变量

$env:OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED="true"

设置 FLASK_APP 环境变量

$env:FLASK_APP="app.py"

3.5 执行结果

执行如下代码

opentelemetry-instrument `
    --traces_exporter console `
    --metrics_exporter console `
    --logs_exporter console `
    --service_name dice-server `
    flask run -p 8080

访问对应的地址：http://127.0.0.1:8080/rolldice
显示如下：

最后会在控制台中看见span会打印出来

四、配置和运行本地 OpenTelemetry Collector

首先确保电脑上有安装Docker，我的Windows使用的是Docker Desktop

目录结构如下：

在venv目录下新建docker-compose.yal、Dockerfile、otel-collector-config.yaml以及requirements.txt文件

配置并运行本地收集器

otel-collector-config.yaml文件

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318
exporters:
  logging:
    logLevel: debug
processors:
  batch:
service:
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [logging]
      processors: [batch]
    metrics:
      receivers: [otlp]
      exporters: [logging]
      processors: [batch]
    logs:
      receivers: [otlp]
      exporters: [logging]
      processors: [batch]

requirements.txt文件

Flask==2.2.3
opentelemetry-api==1.16.0
opentelemetry-sdk==1.16.0
opentelemetry-exporter-otlp==1.16.0
opentelemetry-instrumentation-flask==0.37b0
opentelemetry-semantic-conventions==0.37b0
Werkzeug==2.2.3
Jinja2==3.1.2
click==8.1.3
itsdangerous==2.1.2
importlib-metadata==4.8.3
Deprecated==1.2.13
typing-extensions==4.12.1

Dockerfile文件

# 使用 Python 官方镜像作为基础镜像
FROM python:3.9-slim

# 设置工作目录
WORKDIR /app

# 将 requirements.txt 复制到工作目录
COPY requirements.txt .

# 安装 Python 依赖
RUN pip install --no-cache-dir -r requirements.txt

# 将当前目录的内容复制到工作目录
COPY . .

# 设置环境变量以启用自动化日志记录
ENV OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true

# 暴露应用运行的端口
EXPOSE 8080

# 启动 Flask 应用
CMD ["opentelemetry-instrument", "--logs_exporter", "otlp", "flask", "run", "-p", "8080"]