overleaf/libraries/metrics
Brian Gough e01af0e9c6 Merge pull request #16519 from overleaf/bg-clsi-timeouts-add-metrics
add metrics for clsi cache operations

GitOrigin-RevId: c5ec221afd235434c8b81bafa2f482f11422ac4e
2024-01-18 09:04:19 +00:00
..
test Merge pull request #16519 from overleaf/bg-clsi-timeouts-add-metrics 2024-01-18 09:04:19 +00:00
.dockerignore
.gitignore
.npmignore
.nvmrc
buildscript.txt Merge pull request #16058 from overleaf/jpa-faster-restart 2023-12-08 09:04:01 +00:00
CHANGELOG.md
event_loop.js
http.js
index.js Merge pull request #16519 from overleaf/bg-clsi-timeouts-add-metrics 2024-01-18 09:04:19 +00:00
initialize.js
leaked_sockets.js
LICENSE
memory.js
mongodb.js
open_sockets.js
package.json Merge pull request #16519 from overleaf/bg-clsi-timeouts-add-metrics 2024-01-18 09:04:19 +00:00
prom_wrapper.js
README.md
timeAsyncMethod.js
tsconfig.json Merge pull request #16524 from overleaf/em-fix-typescript-backend 2024-01-17 09:03:42 +00:00
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