Cloudviz 项目技术文档

1. 安装指南

1.1 环境准备

在开始安装之前，请确保您已经熟悉以下内容：

• Amazon CloudWatch
• Google Visualization API

1.2 依赖安装

您需要安装以下依赖库：

1. boto：一个用于访问 Amazon Web Services 的 Python 接口。
2. gviz_api：用于创建 Google Visualization API 数据源的 Python 库。
3. pytz：提供世界时区定义的 Python 库。

可以通过以下命令安装这些依赖：

pip install boto gviz_api pytz

1.3 配置 AWS 凭证

在 settings.py 文件中设置您的 AWS 访问密钥和秘密访问密钥：

AWS_ACCESS_KEY_ID = 'your_access_key_id'
AWS_SECRET_ACCESS_KEY = 'your_secret_access_key'

1.4 部署 cloudviz.py

将 cloudviz.py 文件部署到您的 HTTP 服务器上，确保其可以通过 Web 访问。

2. 项目的使用说明

2.1 基本使用

cloudviz 项目通过将 Amazon CloudWatch 数据源暴露给 Google Chart Tools，帮助用户快速生成图表。用户可以通过传递 JSON 格式的查询参数来生成图表。

2.2 查询参数说明

cloudviz 期望以下查询参数通过 qs 参数传递，参数为 JSON 编码的字符串：

• namespace (字符串)：CloudWatch 命名空间（例如："AWS/ELB"）。
• metric (字符串)：CloudWatch 指标（例如："Latency"）。
• unit (字符串)：CloudWatch 单位（例如："Seconds"）。
• statistics (字符串列表)：CloudWatch 统计信息（例如：["Average", "Maximum"]）。
• dimensions (字典)：CloudWatch 维度（例如：{"LoadBalancerName": "example-lb"}）。
• end_time (日期)：查询区间的结束时间（例如：new Date）。
• start_time (日期)：查询区间的开始时间（例如：start_time.setDate(end_time.getDate-3)）。
• range (整数)：查询区间的时间范围，单位为小时（例如：24）。
• period (整数)：CloudWatch 周期（例如：120）。
• region (字符串)：AWS 区域（例如："us-west-1"，默认值为 "us-east-1"）。
• calc_rate (布尔值)：当设置为 True 且 statistics 包含 "Sum" 时，cloudviz 会将 Sum 值转换为每秒的 Rate 值。
• cloudwatch_queries (字典列表)：封装每个 CloudWatch 查询，允许多个查询在单个图表中绘制。

2.3 示例

以下是一个示例，展示如何通过 JavaScript 构建 URL 并传递给 cloudviz：

var qa = {  
            "namespace": "AWS/EC2",       
            "metric": "CPUUtilization",   
            "unit": "Percent",            
            "statistics": ["Average","Maximum"],      
            "period": 600,                
            "cloudwatch_queries":         
            [   
                {
                    "prefix": "Instance 1 CPU ",   
                    "dimensions": { "InstanceId": "i-bd14d3d5"} 
                },
                {
                    "prefix": "Instance 2 CPU ",
                    "dimensions": { "InstanceId": "i-c514d3ad"}
                }
            ]
         };

var qs = JSON.stringify(qa);
var url = 'http://' + window.location.host + '/cloudviz?qs=' + qs;

3. 项目API使用文档

3.1 API 参数

• qs：JSON 编码的字符串，包含所有查询参数。

3.2 返回值

cloudviz 返回的数据可以通过 Google Visualization API 进行解析和展示。

4. 项目安装方式

4.1 手动安装

1. 下载项目代码。
2. 安装所需的依赖库。
3. 配置 AWS 凭证。
4. 将 cloudviz.py 部署到 HTTP 服务器。

4.2 自动化安装

可以通过脚本自动化安装依赖和配置：

pip install -r requirements.txt
cp settings.py.example settings.py
# 编辑 settings.py 文件，填写 AWS 凭证

通过以上步骤，您可以顺利安装并使用 cloudviz 项目。