GDash 项目技术文档

1. 安装指南

环境要求

• Ruby 环境
• Sinatra 框架
• Graphite 服务

安装步骤

1. 克隆项目代码

   git clone https://github.com/ripienaar/gdash.git
   cd gdash
   

2. 安装依赖

   gem install bundler
   bundle install
   

3. 配置文件

   • 将 gdash.yaml-sample 重命名为 gdash.yaml。
   • 根据你的 Graphite 服务地址和其他配置项，修改 gdash.yaml 文件。

4. 启动应用

   ruby gdash.rb
   

2. 项目的使用说明

创建仪表盘

1. 创建目录结构

   • 在 templatedir 目录下创建新的仪表盘分类目录。
   • 在分类目录下创建具体的仪表盘目录。

2. 编写 dash.yaml 文件

   • 每个仪表盘目录下需要一个 dash.yaml 文件，定义仪表盘的名称和描述。

3. 编写图表描述文件

   • 在仪表盘目录下创建 .graph 文件，使用 DSL 描述图表。

自定义时间间隔

• 通过 URL 参数调整时间间隔，例如：

  http://gdash.example.com/dashboard/email/time/-8d/-7d
  

全屏显示

• 使用 URL 参数调整全屏显示的列数和图表大小，例如：

  http://gdash.example.com/dashboard/email/full/4/600/300
  

3. 项目API使用文档

SinatraApp 类

• 参数说明
  • graphite_url: Graphite 服务地址。
  • template_dir: 仪表盘模板目录。
  • title: 仪表盘标题。
  • prefix: URL 前缀。
  • columns: 图表列数。
  • refresh: 页面刷新间隔。
  • width: 图表宽度。
  • height: 图表高度。
  • whisper_dir: Whisper 文件存储路径（未来使用）。
  • interval_filters: 时间间隔快速过滤器。

图表 DSL

• 字段说明
  • title: 图表标题。
  • vtitle: 纵轴标题。
  • area: 图表区域样式。
  • description: 图表描述。
  • field: 图表数据字段。

4. 项目安装方式

手动安装

1. 克隆项目

   git clone https://github.com/ripienaar/gdash.git
   

2. 安装依赖

   bundle install
   

3. 配置文件

   • 修改 gdash.yaml 文件。

4. 启动应用

   ruby gdash.rb
   

使用 Passenger 部署

1. 配置 Passenger

   • 将项目目录添加到 Passenger 配置中。

2. 启动 Passenger

   passenger start
   

通过以上步骤，你可以成功安装并使用 GDash 项目，创建和管理 Graphite 仪表盘。