overleaf/libraries/metrics
Antoine Clausse 7f48c67512 Add prefer-node-protocol ESLint rule (#21532)
* Add `unicorn/prefer-node-protocol`

* Fix `unicorn/prefer-node-protocol` ESLint errors

* Run `npm run format:fix`

* Add sandboxed-module sourceTransformers in mocha setups

Fix `no such file or directory, open 'node:fs'` in `sandboxed-module`

* Remove `node:` in the SandboxedModule requires

* Fix new linting errors with `node:`

GitOrigin-RevId: 68f6e31e2191fcff4cb8058dd0a6914c14f59926
2024-11-11 09:04:51 +00:00
..
test Add prefer-node-protocol ESLint rule (#21532) 2024-11-11 09:04:51 +00:00
.dockerignore
.gitignore
.npmignore
.nvmrc Update to node 18.20.4 2024-11-07 09:04:31 +00:00
buildscript.txt Update to node 18.20.4 2024-11-07 09:04:31 +00:00
CHANGELOG.md
event_loop.js
http.js
index.js Merge pull request #17268 from overleaf/dp-remove-old-mongo-metrics 2024-02-29 09:04:19 +00:00
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 Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
memory.js
mongodb.js Support v5 of mongodb when recording metrics 2024-08-21 08:04:55 +00:00
open_sockets.js Add prefer-node-protocol ESLint rule (#21532) 2024-11-11 09:04:51 +00:00
package.json Merge pull request #20331 from overleaf/jpa-build-scripts-sync 2024-09-10 08:05:01 +00:00
prom_wrapper.js
README.md Merge pull request #15241 from overleaf/em-gcp-opentelemetry 2023-10-19 08:02:52 +00:00
tsconfig.json Merge pull request #18167 from overleaf/em-simpler-typescript-backend 2024-05-07 08:04:00 +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