Jakob Ackermann 63520c7076 Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup %!s(int64=2) %!d(string=hai) anos
..
test e01af0e9c6 Merge pull request #16519 from overleaf/bg-clsi-timeouts-add-metrics %!s(int64=2) %!d(string=hai) anos
.dockerignore 8945373715 Merge pull request #5724 from overleaf/jpa-lean-docker-build %!s(int64=5) %!d(string=hai) anos
.gitignore a797fb2be7 Merge pull request #14138 from overleaf/bg-em-jpa-mj-node-18 %!s(int64=3) %!d(string=hai) anos
.npmignore 0fdbb2dcc0 Add .npmignore to avoid publishing config files %!s(int64=6) %!d(string=hai) anos
.nvmrc f061a4add4 Merge pull request #15506 from overleaf/jpa-node-18-18-2 %!s(int64=3) %!d(string=hai) anos
CHANGELOG.md c94043e2fe Merge pull request #10144 from overleaf/ii-metrics-api-patch-opts-arg %!s(int64=4) %!d(string=hai) anos
LICENSE 63520c7076 Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup %!s(int64=2) %!d(string=hai) anos
README.md 5855ba7b49 Merge pull request #15241 from overleaf/em-gcp-opentelemetry %!s(int64=3) %!d(string=hai) anos
buildscript.txt 4763cfd59e Merge pull request #16058 from overleaf/jpa-faster-restart %!s(int64=2) %!d(string=hai) anos
event_loop.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages %!s(int64=4) %!d(string=hai) anos
http.js efcb06f0df Merge pull request #7905 from overleaf/em-request-logging %!s(int64=4) %!d(string=hai) anos
index.js 8136036c33 Merge pull request #16644 from overleaf/em-promisify-update-manager %!s(int64=2) %!d(string=hai) anos
initialize.js 5855ba7b49 Merge pull request #15241 from overleaf/em-gcp-opentelemetry %!s(int64=3) %!d(string=hai) anos
leaked_sockets.js 8a15040f04 Merge pull request #13295 from overleaf/em-socket-leak-detection-pools %!s(int64=3) %!d(string=hai) anos
memory.js e0d91eaa26 Merge pull request #7906 from overleaf/em-downgrade-logs %!s(int64=4) %!d(string=hai) anos
mongodb.js 74eeec2ba3 Merge pull request #11680 from overleaf/em-mongo-pool-monitoring %!s(int64=3) %!d(string=hai) anos
open_sockets.js 5638f06b3a Merge pull request #13055 from overleaf/jpa-monitor-sockets-everywhere %!s(int64=3) %!d(string=hai) anos
package.json 5c517a56c3 Merge pull request #16661 from overleaf/em-fix-tsconfig %!s(int64=2) %!d(string=hai) anos
prom_wrapper.js 5683cebf71 Merge pull request #11679 from overleaf/em-upgrade-prom-client %!s(int64=3) %!d(string=hai) anos
timeAsyncMethod.js e0d91eaa26 Merge pull request #7906 from overleaf/em-downgrade-logs %!s(int64=4) %!d(string=hai) anos
tsconfig.json b92d1a0251 Merge pull request #16524 from overleaf/em-fix-typescript-backend %!s(int64=2) %!d(string=hai) anos
uv_threadpool_size.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages %!s(int64=4) %!d(string=hai) anos

README.md

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