API

api组件，提供统一的restAPI操作接口。比如：api组件接收查询请求，根据一致性哈希算法去相应的graph实例查询不同metric的数据，然后汇总拿到的数据，最后统一返回给用户。

服务部署

服务部署，包括配置修改、启动服务、检验服务、停止服务等。这之前，需要将安装包解压到服务的部署目录下。

  1. # 修改配置, 配置项含义见下文, 注意graph集群的配置
  2. mv cfg.example.json cfg.json
  3. vim cfg.json
  5. # 启动服务
  6. ./open-falcon start api
  8. # 停止服务
  9. ./open-falcon stop api
  11. # 查看日志
  12. ./open-falcon monitor api

配置说明

注意: 请确保 graphs的内容与transfer的配置完全一致

  1. {
  2.     "log_level": "debug",
  3.     "db": {  //数据库相关的连接配置信息
  4.         "faclon_portal": "root:@tcp(127.0.0.1:3306)/falcon_portal?charset=utf8&parseTime=True&loc=Local",
  5.         "graph": "root:@tcp(127.0.0.1:3306)/graph?charset=utf8&parseTime=True&loc=Local",
  6.         "uic": "root:@tcp(127.0.0.1:3306)/uic?charset=utf8&parseTime=True&loc=Local",
  7.         "dashboard": "root:@tcp(127.0.0.1:3306)/dashboard?charset=utf8&parseTime=True&loc=Local",
  8.         "alarms": "root:@tcp(127.0.0.1:3306)/alarms?charset=utf8&parseTime=True&loc=Local",
  9.         "db_bug": true
  10.     },
  11.     "graphs": {  // graph模块的部署列表信息
  12.         "cluster": {
  13.             "graph-00": "127.0.0.1:6070"
  14.         },
  15.         "max_conns": 100,
  16.         "max_idle": 100,
  17.         "conn_timeout": 1000,
  18.         "call_timeout": 5000,
  19.         "numberOfReplicas": 500
  20.     },
  21.     "metric_list_file": "./api/data/metric",
  22.     "web_port": ":8080",  // http监听端口
  23.     "access_control": true, // 如果设置为false，那么任何用户都可以具备管理员权限
  24.     "salt": "pleaseinputwhichyouareusingnow",  //数据库加密密码的时候的salt
  25.     "skip_auth": false, //如果设置为true，那么访问api就不需要经过认证
  26.     "default_token": "default-token-used-in-server-side",  //用于服务端各模块间的访问授权
  27.     "gen_doc": false,
  28.     "gen_doc_path": "doc/module.html"
  29. }

补充说明

  • 部署完成api组件后，请修改dashboard组件的配置、使其能够正确寻址到api组件。
  • 请确保api组件的graph列表 与 transfer的配置 一致。