Autometrics-py 项目启动和配置教程

Autometrics-py 项目启动和配置教程

autometrics-py Easily add metrics to your code that actually help you spot and debug issues in production. Built on Prometheus and OpenTelemetry. 项目地址: https://gitcode.com/gh_mirrors/au/autometrics-py

1. 项目目录结构及介绍

Autometrics-py 是一个用于自动度量代码性能和健康状态的 Python 库。以下是项目的目录结构及其介绍：

autometrics-py/
├── .github/                # GitHub 配置文件，包括工作流程等
├── configs/                # 配置文件示例
├── examples/               # 使用示例代码
├── src/                    # 源代码目录
│   ├── __init__.py
│   ├── autometrics.py      # 核心功能实现
│   └── objectives.py       # Service-Level Objectives (SLOs) 相关实现
├── .gitignore              # Git 忽略文件
├── CHANGELOG.md            # 更新日志
├── LICENSE-APACHE          # Apache 许可证文件
├── LICENSE-MIT             # MIT 许可证文件
├── README.md               # 项目说明文件
├── Tiltfile                # Tilt 配置文件
├── docker-compose.yaml     # Docker Compose 配置文件
├── poetry.lock             # Poetry 依赖锁定文件
├── poetry.toml             # Poetry 项目配置文件
├── pyproject.toml          # Python 项目配置文件
└── pyrightconfig.json      # Pyright 配置文件

2. 项目的启动文件介绍

项目的启动主要是通过 src/autometrics.py 中的 autometrics 装饰器来实现的。以下是一个简单的启动文件示例：

from autometrics import autometrics

@autometrics
def my_function():
    # 这里编写你的业务逻辑
    pass

在你的项目中，你可以通过添加 @autometrics 装饰器到任何函数或类方法上来自动跟踪该函数的性能指标。

3. 项目的配置文件介绍

Autometrics-py 使用环境变量和配置文件来管理项目配置。以下是一些主要的配置项：

• tracker: 配置 Autometrics 使用哪种监控系统来产生度量数据。默认是 opentelemetry，但也可以设置为 prometheus。
• histogram_buckets: 配置用于延迟直方图的桶。默认值是 [0.01, 0.05, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 10]。

配置可以通过在项目的根目录下创建一个 .env 文件来进行设置，如下所示：

# .env
AUTOMETRICS_TRACKER=prometheus
PROMETHEUS_URL=http://localhost:9090/

或者，你可以在调用 init 函数时直接传递配置参数：

from autometrics import init

init(tracker='prometheus', service_name='my-service')

确保在启动你的应用之前正确配置这些设置，以便 Autometrics 可以正确地跟踪和报告度量数据。

autometrics-py Easily add metrics to your code that actually help you spot and debug issues in production. Built on Prometheus and OpenTelemetry. 项目地址: https://gitcode.com/gh_mirrors/au/autometrics-py