overleaf/libraries/metrics
Andrew Rumble 73b17dd694 Merge pull request #21627 from overleaf/ar-node-20
[all] node 20 upgrade v2

GitOrigin-RevId: aed13a800894717a796062e3dd4050e045040258
2024-11-15 09:04:32 +00:00
..
test Add prefer-node-protocol ESLint rule (#21532) 2024-11-11 09:04:51 +00:00
.dockerignore
.gitignore
.npmignore
.nvmrc Merge pull request #21627 from overleaf/ar-node-20 2024-11-15 09:04:32 +00:00
buildscript.txt Merge pull request #21627 from overleaf/ar-node-20 2024-11-15 09:04:32 +00:00
CHANGELOG.md
event_loop.js
http.js
index.js
initialize.js Add prefer-node-protocol ESLint rule (#21532) 2024-11-11 09:04:51 +00:00
leaked_sockets.js Add prefer-node-protocol ESLint rule (#21532) 2024-11-11 09:04:51 +00:00
LICENSE
memory.js
mongodb.js
open_sockets.js Add prefer-node-protocol ESLint rule (#21532) 2024-11-11 09:04:51 +00:00
package.json
prom_wrapper.js
README.md
tsconfig.json
uv_threadpool_size.js

overleaf/metrics-module

Wrappers the prom-client npm module to provide Prometheus metrics at /metrics.

Use:

// Metrics must be initialized before importing anything else
require('@overleaf/metrics/initialize')

const express = require('express')
const metrics = require('@overleaf/metrics')
const app = express()
metrics.injectMetricsRoute(app)

Request logging can be enabled:

const logger = require('@overleaf/logger')
...
app.use(metrics.http.monitor(logger))

The metrics module can be configured through the following environment variables:

  • DEBUG_METRICS - enables display of debugging messages to the console.
  • GCP_OPENTELEMETRY - enables OpenTelemetry tracing for GCP
  • JAEGER_OPENTELEMETRY - enables OpenTelemetry tracing for Jaeger (in the dev environment)
  • METRICS_APP_NAME - the app label for metrics and spans
  • METRICS_COMPRESSION_LEVEL - sets the compression level for /metrics
  • STACKDRIVER_LOGGING - toggles the request logging format
  • UV_THREADPOOL_SIZE - sets the libuv thread pool size