智能日志管理平台

  • Metrics

    最近更新时间:2018-09-26 11:58:07

    获取用户设定信息

    GET /v1/api/metrics/machine
    

    返回值

    • 如果用户填写过 metrics 信息的设定,则返回:

      {
        "opened": true,
        "interval": "3",
        "repo_name":"logkit_pro_internal"
      }
      
    • 如果用户没有填写过, 则返回:

    {
        "opened": false
    }
    

    获取某个 agent 对应机器的 metric 信息

    GET /v1/api/metrics/<agent_id>?beginTime=<begin_time>&endTime=<end_time>
    

    返回值

    • 如果该 agent 开通了 metrics 收集, 则返回:

      {
        "opened": true,
        "data": {
            "cpu_usage": {                                  // cpu 利用率
                "buckets": [
                    {
                        "cpu_usage_system":{
                            "value":null                    // 可能为 null
                        },
                        "cpu_usage_user":{
                            "value":null
                        },
                        "key":1517413680000                 // 时间戳(毫秒级)
                    },
                    {
                        "cpu_usage_system":{                // 系统 cpu 资源占用
                            "value":11.126897295316061      // 百分比
                        },
                        "cpu_usage_user":{                  // 用户 cpu 资源占用
                            "value":20.454540321562025      // 百分比
                        },
                        "key":1517824920000
                    },
                    ...
                ]
            }
            "diskio":{                                      // 磁盘 I/O
                "buckets":[
                    {
                        "key":1517808260000                 // 可能不存在这个字段(只会在第一个值时出现)
                    },
                    {
                        "diskio_reads_rate":{
                            "value":null                    // 可能为 null
                        },
                        "diskio_writes_rate":{
                            "value":null
                        },
                        "key":1517808360000
                    },
                    {
                        "diskio_reads_rate":{               // 磁盘读取频率
                            "value":3800.909496286884       // 单位 op/sec
                        },
                        "diskio_writes_rate":{              // 磁盘写入频率
                            "value":2468.5610533740837      // 单位 op/sec
                        },
                        "key":1517809740000                 // 时间戳
                    },
                ]
            },
            "mem_used_percent":{                            // 内存占用
                "buckets":[
                    {
                        "key":1517413680000,
                        "mem_used_percent":{
                            "value":null                    // 可能为 null
                        }
                    },
                    {
                        "key":1517818020000,                // 时间戳
                        "mem_used_percent":{                // 内存占用
                            "value":78.59851748055786       // 百分比
                        }
                    },
                    ...
                ]
            },
            "net_bytes_rate":{                              // 网络流量
                "buckets":[
                    {
                        "key":1517413680000                 // 字段可能不存在
                    },
                    {
                        "bytes_recv_rate":{
                            "value":null                    // 字段可能为 null
                        },
                        "bytes_sent_rate":{
                            "value":null
                        },
                        "key":1517806980000
                    },
                    {
                        "bytes_recv_rate":{                 // 接收速率
                            "value":5683943.616149664       // bytes/sec
                        },
                        "bytes_sent_rate":{                 // 发送速率
                            "value":2472513.4745543003
                        },
                        "key":1517808360000                 // 时间戳
                    },
                ]
            },
            "net_packets_rate":{                            // 收发包速率
                "buckets":[
                    {
                        "key":1517413680000                 // 字段可能不存在
                    },
                    {
                        "key":1517415060000,
                        "packets_recv_rate":{               // 字段可能为 null
                            "value":null
                        },
                        "packets_sent_rate":{               // 字段可能为 null
                            "value":null
                        }
                    },
                    {
                        "key":1517809740000,                // 时间戳
                        "packets_recv_rate":{               // 接收包速率
                            "value":8283.852036660304       // 单位 个/sec
                        },
                        "packets_sent_rate":{               // 发送包速率
                            "value":6568.934223250486
                        }
                    },
                ]
            },
            "system_load":{                                 // 负载
                "buckets":[
                    {
                        "key":1517413680000
                        "system_load1":{
                            "value":null                    // 字段可能为空
                        },
                        "system_load15":{
                            "value":null
                        },
                        "system_load5":{
                            "value":null
                        }
                    },
                    {
                        "key":1517820780000,                // 时间戳
                        "system_load1":{                    // 一分钟平均负载
                            "value":2.496029057745206
                        },
                        "system_load15":{                   // 十五分钟平均负载
                            "value":2.340774799951918
                        },
                        "system_load5":{                    // 五分钟平均负载
                            "value":2.3685714188268627
                        }
                    },
                    ...
                ]
            },
            "tcp_established_num":{                         // TCP 连接数
                "buckets":[
                    {
                        "key":1517413680000,
                        "tcp_established_num":{
                            "value":null                    // 字段可能为 null
                        }
                    },
                    {
                        "key":1517815260000,
                        "tcp_established_num":{
                            "value":67.02427184466019
                        }
                    },
                    ...
                ]
            }
        }
      
    • 如果没有开通,则返回:

    {
        "opened": false,
        "data": {
            "post_url": "<开通请求的 url>",
            "message": "<提示语>",
            <可能会有其他的字段>
        }
    }
    

    参数说明

    • beginTimeendTime 请提供时间戳,精度秒级(10 位数字)
    • 返回的数据中的时间戳将覆盖从 beginTimeendTime 的所有时间点, 没有数据的使用 null 来填充
    • 对于 "速率" 类的指标可能会出现字段不存在的情况,但是只会在第一个时间点的时候出现
    • 无论提供的时间段有多长, 返回的数据量都在 300 左右
    • 开通请求的 url 不包括 url 前缀, 即以该 API(/v1/metrics)为例, post_url 字段的内容为 /metrics
    • message 是对于用户的提示语, 比如: "开通后所有的agent都将开始收集其所在系统上的metric信息,并发往pandora平台"
    • 以上两个字段是一定会有的,剩下的字段根据场景可能会没有
    • 剩下的字段每个都是一个 object, 每个 object 都有两个字段, chinese 表示中文的字段名称, default 表示默认值.
    以上内容是否对您有帮助?
  • Icon free helper
    Close