Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@platformatic/http-metrics

Package Overview
Dependencies
Maintainers
7
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@platformatic/http-metrics

The `http-metrics` package provides a simple way to collect prometheus metrics for your Node.js HTTP server. It can be used with any Node.js HTTP server framework, such as Express, Koa, or Fastify.

  • 0.2.1
  • latest
  • npm
  • Socket score

Version published
Maintainers
7
Created
Source

@platformatic/http-metrics

The http-metrics package provides a simple way to collect prometheus metrics for your Node.js HTTP server. It can be used with any Node.js HTTP server framework, such as Express, Koa, or Fastify.

Installation

npm install @platformatic/http-metrics

Usage

const { createServer } = require('node:http')
const { Registry } = require('prom-client')
const httpMetrics = require('./index')

const registry = new Registry()
httpMetrics(registry)

const server = createServer(async (req, res) => {
  if (req.url === '/metrics') {
    const metrics = await registry.metrics()

    res.setHeader('Content-Type', registry.contentType)
    res.end(metrics)
    return
  }
  res.end('Hello World\n')
})

server.listen(0, () => {
  const { port } = server.address()
  console.log(`Server listening on http://127.0.0.1:${port}`)
})

API

httpMetrics(registry, [options])
  • registry <Registry> The prom-client registry to use for collecting metrics.
  • options <object> Options for configuring the metrics collection.
    • customLabels <array> A list of custom labels names to add to the metrics.
    • getCustomLabels(req, res, server) <function> A function that returns an object of custom labels to add to the metrics. The function receives the request object as a first argument and a response object as a second argument.
    • ignoreMethods <array> A list of HTTP methods to ignore when collecting metrics. Default: ['OPTIONS', 'HEAD', 'CONNECT', 'TRACE'].
    • ignoreUrls <array> A list of URLs strings and regexps to ignore when collecting metrics. Default: [].
    • ignore(req, res, server) <function> A function that returns a boolean indicating whether to ignore the request when collecting metrics. The function receives the request object as a first argument and a response object as a second argument.
    • ports <array> By default the http metrics are collected for all defined http servers. If you want to collect metrics only for specific http servers, you can provide an array of ports to collect metrics for.
    • histogram <object> prom-client histogram options. Use it if you want to customize the histogram.
    • summary <object> prom-client summary options. Use it if you want to customize the summary.

Returns:

  • histogram <Histogram> The histogram metric for measuring request duration.
  • summary <Summary> The summary metric for measuring request duration.
  • startTimer({ request, [server] }) <function> A function that starts a timer for measuring request duration. The function can be used to add custom measurements that are not collected by diagnostic channel.
  • __endTimer({ request, response, [server] }) <function> A function that ends a timer for custom request duration measurement.

License

Apache-2.0

FAQs

Package last updated on 10 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc