使用方法

证书配置

用户在使用BCM-Tool推送监控数据之前,要先创建一个证书文件(BCM-Tool安装目录中带有证书文件模板,用户可基于模板进行修改),证书文件存放目录没有限制,以下是证书文件的格式示例:

[USER]
BCM_USER_ID = xxxxxxxxcfe04e2494c23974xxxxxxxx
[AKSK]
BCM_ACCESS_KEY = xxxxxxxx846d4884b9dfaed6xxxxxxxx
BCM_SECRET_KEY = xxxxxxxxfd764b2996412a66xxxxxxxx

用户只需将自己的userId、accessKey、secretKey填写到证书文件对应的位置,如上面的“xxxxxxxxcfe04e2494c23974xxxxxxxx”(该值为示例,并非真实信息),然后在使用工具时指定该证书即可。

环境变量设置

BCM-Tool工具提供了-c/--credential-file-u/--url两个参数分别指定证书文件路径和BCM服务端的URL。例如:

bcm-tool metric-data-put --credential-file ./bcm-credential.template --url http://bcm.bj.baidubce.com

但由于在使用过程中这两个参数的值不会频繁改变,为了避免用户每一次执行命令都需要指定,BCM-Tool支持从环境变量获取证书路径和BCM服务的URL。

配置环境变量方式如下:

export BCM_CREDENTIAL_FILE=<credential_path>
export BCM_URL=http://bcm.bj.baidubce.com  或  export BCM_URL=http://bcm.gz.baidubce.com

其中,<credential_path>证书的绝对路径,bcm.bj.baidubce.com为BCM服务(北京region)的地址,bcm.gz.baidubce.com为BCM服务(广州region)的地址,关于region的选择后面会有介绍。

说明:

当用户既设置了环境变量又指定了--credential-file--url参数时,优先使用参数指定的内容。

Region选择

BCM-Tool支持将自定义监控数据推送到不同的Region,用户可通过配置URL指定推送到某个具体的Region。

Region(北京)URL:bcm.bj.baidubce.com
Region(广州)URL:bcm.gz.baidubce.com

BCM-Tool命令介绍

BCM-Tool采用子命令方式为用户提供了一系列监控和报警的功能,用户可以使用以下方式查看BCM-Tool支持的子命令:

bcm-tool help

BCM-Tool目前支持三个子命令:metric-data-putmetric-data-listmetric-meta-list,分别为推送监控数据,查询监控数据和查询监控元信息。

用户还可以详细查看各子命令的具体参数介绍和Examples,命令如下(以推送监控数据举例):

bcm-tool help metric-data-put 或者 bcm-tool metric-data-put --help

推送监控数据

推送数据子命令: Metric-data-put

  • 源数据推送。

    bcm-tool metric-data-put --scope <SCOPE> --metric-name <METRICNAME> --value <VALUE> --timestamp <TIMESTAMP>

    • --scope(-S)指定要推送的服务名字空间。
    • --metric-name(-m)指定要推送的监控项。
    • --value(-v)指定推送的监控值。
    • --timestamp(-t)指定监控信息的时间戳。
  • 聚合数据的推送。

    bcm-tool metric-data-put --scope <SCOPE> --metric-name <METRICNAME> --statistic-value average=<VALUE>,sum=<VALUE>,maximum=<VALUE>,minimum=<VALUE> --timestamp <TIMESTAMP>

    • --statistic(-s)用来指定聚合的监控值。

    注意:一次数据推送--value和--statistic两个参数只能指定一个。

  • 指定监控项的维度信息。

    bcm-tool metric-data-put --scope <SCOPE> --metric-name <METRICNAME> --value <VALUE> --timestamp <TIMESTAMP> --dimensions <NAME>=<VALUE>,<NAME>=<VALUE>

    • --dimensions(-d)用来指定监控项的信息维度。
  • 以文件的方式推送监控数据(用户按照正确的json格式生成监控数据文件)。

    bcm-tool metric-data-put --scope <SCOPE> --data-file ./data.template

    • --data-file(-f)用来指定文件。

此外,用户还可以使用BCM-Tool生成监控数据文件模板,用户只需修改文件中的值即可,大大方便了用户使用。

  • 生成监控数据文件模板。

    bcm-tool metric-data-put -T

查询监控数据

查询监控数据子命令:metric-data-list

如: bcm-tool metric-data-list --scope <SCOPE> --metric-name <METRICNAME> --statistics sum,average --start-time <STARTTIME> --end-time <ENDTIME> --period <PERIOD>

* --scope:指定查询的服务名字空间。
* --metric-name:指定了要查询的监控项名称。
* --statistics指定了按什么方式聚合查询到的原始数据。
* --start-time和--end-time则指定了查询的时间区间。
* --period用来指定聚合周期,单位为秒(默认值为60)。

查询监控数据时也可以指定维度信息,使用--dimensions(-d)参数指定。

查询监控元信息

查询监控元信息子命令:metric-meta-list

如: bcm-tool metric-meta-list -S <SCOPE>

指定SCOPE为查询当前SCOPE的监控元信息,执行该命令,BCM服务会返回SCOPE下的所有监控项信息,并且包含维度信息。

若用户想查看某个监控项的元信息,以及某个具体维度的元信息,命令如下:

bcm-tool metric-meta-list --scope <SCOPE> --metric-name <METRICNAME>

bcm-tool metric-meta-list --scope <SCOPE> --metric-name <METRICNAME> --dimensions <NAME>=<VALUE>,<NAME>=<VALUE>