Django App Metrics 技术文档

1. 安装指南

在开始使用 Django App Metrics 前，确保已经安装了以下依赖：

• Celery 和 django-celery（如不使用 Celery，可在 settings 中设置 CELERY_ALWAYS_EAGER = True）
• Django 1.2 或更高版本

安装 Django App Metrics：

pip install django-app-metrics

在 Django 项目的 settings.py 文件中，添加 app_metrics 到 INSTALLED_APPS：

INSTALLED_APPS = [
    # 其他应用...
    'app_metrics',
]

2. 项目的使用说明

Django App Metrics 允许您捕获和报告应用程序中的各种事件。首先定义各种命名指标，并在它们发生时记录它们。这些指标可以是立即有用的，例如“新用户注册”、“下载”等，也可以是将来某个时刻才证明有用的数据。

使用以下方式创建和管理指标：

from app_metrics.utils import create_metric, metric, timing, Timer, gauge

# 创建一个新的指标
my_metric = create_metric(name='新用户指标', slug='new_user_signup')

# 创建一个指标集，将指标与电子邮件报告的频率和接收者关联
my_metric_set = create_metric_set(name='我的指标集',
                                  metrics=[my_metric],
                                  email_recipients=[user1, user2])

# 指标增加1
metric('new_user_signup')

# 指标增加其他数字
metric('new_user_signup', 4)

# 聚合指标数据为每日、每周、每月和每年的总数
# 这相当智能，可以随时运行
manage.py metrics_aggregate

# 给用户发送电子邮件报告
manage.py metrics_send_mail

3. 项目API使用文档

以下是一些主要的 API 调用方法：

• create_metric(name, slug, description=None, group=None)：创建一个新指标。
• metric(slug, value=1, backends=None)：记录一个指标值。
• timing(slug, duration, backends=None)：记录一个事件的持续时间。
• Timer(slug, backends=None)：创建一个计时器对象，用于手动控制计时的开始和结束。
• gauge(slug, value, backends=None)：记录一个当前状态的值，如燃料表。

4. 项目安装方式

请遵循以下步骤安装 Django App Metrics：

1. 使用 pip 安装 django-app-metrics 包。
2. 将 app_metrics 添加到 Django 项目的 INSTALLED_APPS 中。
3. 根据需要配置相应的后端设置，如数据库、Mixpanel、Statsd、Redis 或 Librato。
4. 运行 manage.py migrate 来创建相关数据库表。

确保在项目的配置文件中正确设置了所有的相关配置项，例如后端类型、电子邮件接收者等。

现在，您可以开始使用 Django App Metrics 来跟踪和报告应用程序中的事件了。