Metadata-Version: 1.1
Name: metric-client
Version: 1.0.1
Summary: metric client for python
Home-page: https://github.com/zskymn/metric-client-py
Author: zskymn
Author-email: zsymn@163.com
License: MIT
Description: # metric-client
        
        python版的指标收集客户端
        
        ## 安装
        
        ```sh
        pip install metric-client
        ```
        
        ## 使用
        
        ```python
        from metric_client import MetricClient
        
        # send_api: 接收推送数据的API
        # token：负责appcode的身份验证，不能为空
        token = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2ZXJzaW9uIjoxLCJhcHBjb2RlIjoib3BzX21ldHJpY2d3IiwidG9fdXNlciI6Inh4eHguemhhbyIsImlhdCI6MTU0NTczNTczMH0.Aj8srWIjyFwxhcMrZlCxyNlP44uLG0iiR31ynyYd4Bw'
        send_api = 'http://localhost:6066/v1/metric/send'
        metric = MetricClient(send_api, token)
        metric.set('set_metric_name', 344, ts=1554704683)
        metric.counter('counter_metric_name', 100)
        metric.max('max_metric_name', 100)
        metric.min('min_metric_name', 100)
        metric.avg('avg_metric_name', 100)
        metric.timing('timing_metric_name', 100, ts=1554704683)
        metric.summary('summary_metric_name', 100)
        metric.summary('summary_low_metric_name', 20, percentiles=[1, 5, 10])
        # percentiles 表示输出的指标中包含的百分位数列表，默认是 [50, 90, 95, 99]
        ```
        
        ## 指标类型
        
        ### set
        
        set 类型的指标，在一个指标周期（比如1分钟）中只会取最后一个值，是最普通的的指标类型。
        
        该指标不需要在一个周期内做任何聚合操作，总是记录最后一个值。
        
        ### counter
        
        counter 类型的指标，可用于记录qps等场景。
        
        在一个指标周期（比如1分钟）可以发生变化，可以增加，也可以减小，该指标最后输出一个汇总值（即周期内所有值的求和）。
        
        ### max
        
        max 类型的指标，可用于记录一分钟内的最大值。该指标需要在一个周期内做聚合操作，最后输出一个最大值。
        
        ### min
        
        min 类型的指标，可用于记录一分钟内的最小值。该指标需要在一个周期内做聚合操作，最后输出一个最小值。
        
        ### timing
        
        timing 类型的指标，可用于记录代码执行时间。
        
        每次update指定一个value和count（默认为1），该指标需要在一个周期内做聚合操作，最后输出一组汇总值（最大值，最小值，总和，总数量，平均值）。
        
        
        ### summary
        
        summary 是一种更加复杂的统计类型指标，该指标需要在一个周期内做聚合操作，会输出一组汇总值，如平均值，总和，总数量，百分位数（P90，P99等）。
        
        该指标的的输入支持两种类型：元数据（raw）和t-digest序列化字符串（tdigest）
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
