下载

npm i @blued-core-oversea/node-prometheus-sdk

API 列表&说明

• recordHTTP(data: HTTPPrometheus)
  • 描述：接口相关数据上报【指标数据单位：毫秒「ms」】
  • Metrics类型（1）：CounterVec
    • Name：prometheus_push_gateway_requests_total
    • Args：【"project", "host", "code", "method", "url"】
  • Metrics类型（2）：HistogramVec
    • Name：prometheus_push_gateway_request_duration_seconds
    • Args：【"project", "host", "code", "method", "url"】
• recordPCountErr(data: PCountErrPrometheus)
  • 描述：自定义错误相关信息上报
  • Metrics类型：CounterVec
    • Name：prometheus_push_gateway_error_total
    • Args：【"project", "host", "code"】
• recordPCount(data: PCountPrometheus)
  • 描述：自定义 counter 指标上报
  • Metrics类型：CounterVec
    • Name：prometheus_push_gateway_user_defined_count
    • Args：【"project", "host", "code"】
• recordPCountWithIncVal(data: PCountWithIncValPrometheus)
  • 注意：H5 暂时不支持该 API
  • 描述：自定义 counter 指标上报(带有自定义递增的数量)
  • Metrics类型：CounterVec
    • Name：prometheus_push_gateway_user_defined_count_with_inc_val
    • Args：【"project", "host", "code"】
• recordPLatencyHTTP(data: PLatencyPrometheus)
  • 描述：第三方接口调用延迟上报【指标数据单位：毫秒「ms」】
  • Metrics类型：HistogramVec
    • Name：prometheus_push_gateway_http_operation_duration
    • Args：【"project", "host", "code"】
• recordPGauge(data: PGaugePrometheus)
  • 描述：自定义 gauge 指标上报
  • Metrics类型：GaugeVec
    • Name：prometheus_push_gateway_user_defined_gauge
    • Args：【"project", "host", "code"】
• recordPLatency(data: PLatencyPrometheus)
  • 描述：自定义延迟上报【指标数据单位：毫秒「ms」】
  • Metrics类型：HistogramVec
    • Name：prometheus_push_gateway_operation_duration
    • Args：【"project", "host", "code"】

使用方式

import { PrometheusSDK } from '@blued-core-oversea/node-prometheus-sdk-web'

const promeSDK = new PrometheusSDK('live_http', {
  host: '127.0.0.1:30001',
})

const main = () => {
  // http 接口相关统计
  promeSDK.recordHTTP({
    status: 200,
    method: 'POST',
    url: '/live/index',
    val: 150,
  })

  // 自定义错误相关信息统计
  promeSDK.recordPCountErr({
    code: 'redis_query_err',
  })

  // 自定义延迟统计
  promeSDK.recordPLatency({
    code: 'redis_query',
    val: 300,
  })

  // 第三方接口调用统计
  promeSDK.recordPLatencyHTTP({
    code: '/user/10',
    val: 240,
  })

  // 自定义 counter 指标上报
  promeSDK.recordPGauge({
    code: 'test_gauge',
    val: 120,
  })

  // 自定义 gauge 指标上报
  promeSDK.recordPCount({
    code: 'test_counter',
  })

  console.log('------------main func over')
}

main()
console.log('------------over')