overleaf/libraries/metrics
David b59326e96f Merge pull request #16873 from overleaf/dp-mongo-command-monitoring
Use mongo command monitoring to add timing metrics

GitOrigin-RevId: e7e5dd5cca1ba3802c02198ccf81058d4da3f1e7
2024-02-23 09:02:55 +00:00
..
test
.dockerignore
.gitignore
.npmignore
.nvmrc Merge pull request #17170 from overleaf/jpa-node-18-19-1 2024-02-20 09:04:55 +00:00
buildscript.txt Merge pull request #17170 from overleaf/jpa-node-18-19-1 2024-02-20 09:04:55 +00:00
CHANGELOG.md
event_loop.js
http.js
index.js Merge pull request #16644 from overleaf/em-promisify-update-manager 2024-01-30 16:49:23 +00:00
initialize.js
leaked_sockets.js
LICENSE Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
memory.js
mongodb.js Merge pull request #16873 from overleaf/dp-mongo-command-monitoring 2024-02-23 09:02:55 +00:00
open_sockets.js
package.json
prom_wrapper.js
README.md
timeAsyncMethod.js
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