Skip to content
Snippets Groups Projects
Select Git revision
  • 23c0406bedfc6930735e8f5ea75dfe34faf1f290
  • master default protected
  • gh-pages
  • dependabot/npm_and_yarn/eslint-plugin-jsdoc-51.0.3
  • dependabot/npm_and_yarn/nock-14.0.5
  • dependabot/npm_and_yarn/react-19.1.0
  • dependabot/npm_and_yarn/react-dom-19.1.0
  • server-2025-02-01-6100669a
  • server-2024-11-01-87cba042
  • server-2024-10-01-6875b7c8
  • dependabot/npm_and_yarn/path-to-regexp-8.2.0
  • server-2024-09-01-3d52575c
  • daily-tests-gha2
  • daily-tests-gha
  • server-2023-12-01-92d8fb8e
  • server-2023-11-01-a80c93fd
  • server-2023-10-01-31096085
  • coc-v2
  • server-2023-09-01-8edc3810
  • server-2023-08-01-75858a03
  • server-2023-07-01-02183d8d
  • server-2025-07-01
  • 5.0.2
  • 5.0.1
  • 5.0.0
  • server-2025-06-01
  • server-2025-05-01
  • server-2025-04-03
  • server-2025-03-02
  • server-2025-03-01
  • server-2025-02-02
  • server-2025-01-01
  • server-2024-12-01
  • server-2024-11-02
  • 4.1.0
  • server-2024-09-25
  • server-2024-09-02
  • server-2024-08-01
  • server-2024-07-01
  • 4.0.0
  • server-2024-06-01
41 results

prometheus-metrics.js

Blame
  • prometheus-metrics.js 2.69 KiB
    import decamelize from 'decamelize'
    import prometheus from 'prom-client'
    
    export default class PrometheusMetrics {
      constructor({ register } = {}) {
        this.register = register || new prometheus.Registry()
        this.counters = {
          numRequests: new prometheus.Counter({
            name: 'service_requests_total',
            help: 'Total service requests',
            labelNames: ['category', 'family', 'service'],
            registers: [this.register],
          }),
          responseTime: new prometheus.Histogram({
            name: 'service_response_millis',
            help: 'Service response time in milliseconds',
            // 250 ms increments up to 2 seconds, then 500 ms increments up to 8
            // seconds, then 1 second increments up to 15 seconds.
            buckets: [
              250, 500, 750, 1000, 1250, 1500, 1750, 2000, 2250, 2500, 2750, 3000,
              3250, 3500, 3750, 4000, 4500, 5000, 5500, 6000, 6500, 7000, 7500,
              8000, 9000, 10000, 11000, 12000, 13000, 14000, 15000,
            ],
            registers: [this.register],
          }),
          serviceResponseSize: new prometheus.Histogram({
            name: 'service_response_bytes',
            help: 'Service response size in bytes',
            labelNames: ['category', 'family', 'service'],
            // buckets: 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB
            buckets: prometheus.exponentialBuckets(64 * 1024, 2, 8),
            registers: [this.register],
          }),
        }
        this.interval = prometheus.collectDefaultMetrics({
          register: this.register,
        })
      }
    
      async registerMetricsEndpoint(server) {
        const { register } = this
    
        server.route(/^\/metrics$/, async (data, match, end, ask) => {
          ask.res.setHeader('Content-Type', register.contentType)
          ask.res.end(await register.metrics())
        })
      }
    
      stop() {
        this.register.clear()
        if (this.interval) {
          clearInterval(this.interval)
          this.interval = undefined
        }
      }
    
      async metrics() {
        return await this.register.getMetricsAsJSON()
      }
    
      /**
       * @param {object} attrs Refer to individual attrs
       * @param {string} attrs.category e.g: 'build'
       * @param {string} attrs.serviceFamily e.g: 'npm'
       * @param {string} attrs.name e.g: 'NpmVersion'
       * @returns {object} `{ inc() {} }`.
       */
      createNumRequestCounter({ category, serviceFamily, name }) {
        const service = decamelize(name)
        return this.counters.numRequests.labels(category, serviceFamily, service)
      }
    
      noteResponseTime(responseTime) {
        return this.counters.responseTime.observe(responseTime)
      }
    
      createServiceResponseSizeHistogram({ category, serviceFamily, name }) {
        const service = decamelize(name)
        return this.counters.serviceResponseSize.labels(
          category,
          serviceFamily,
          service
        )
      }
    }