Tim Down 994fcd68e2 Merge pull request #14903 from overleaf/revert-14869-revert-14603-td-upgrade-semver 3 years ago
..
.circleci 2f35db4087 Fix startup crash 6 years ago
test 5638f06b3a Merge pull request #13055 from overleaf/jpa-monitor-sockets-everywhere 3 years ago
.dockerignore 8945373715 Merge pull request #5724 from overleaf/jpa-lean-docker-build 4 years ago
.gitignore a797fb2be7 Merge pull request #14138 from overleaf/bg-em-jpa-mj-node-18 3 years ago
.npmignore 0fdbb2dcc0 Add .npmignore to avoid publishing config files 6 years ago
.nvmrc 5e9498c528 Merge pull request #14280 from overleaf/jpa-latest-node-18 3 years ago
CHANGELOG.md c94043e2fe Merge pull request #10144 from overleaf/ii-metrics-api-patch-opts-arg 4 years ago
LICENSE 60857982b6 Create LICENSE 12 years ago
README.md d9d65ac31c Merge pull request #5246 from overleaf/bg-upgrade-logger-in-all-libraries 5 years ago
buildscript.txt 5e9498c528 Merge pull request #14280 from overleaf/jpa-latest-node-18 3 years ago
event_loop.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages 4 years ago
http.js efcb06f0df Merge pull request #7905 from overleaf/em-request-logging 4 years ago
index.js 540a5466f3 Merge branch 'bg-socket-leak-detection' 3 years ago
leaked_sockets.js 8a15040f04 Merge pull request #13295 from overleaf/em-socket-leak-detection-pools 3 years ago
memory.js e0d91eaa26 Merge pull request #7906 from overleaf/em-downgrade-logs 4 years ago
mongodb.js 74eeec2ba3 Merge pull request #11680 from overleaf/em-mongo-pool-monitoring 3 years ago
open_sockets.js 5638f06b3a Merge pull request #13055 from overleaf/jpa-monitor-sockets-everywhere 3 years ago
package.json 994fcd68e2 Merge pull request #14903 from overleaf/revert-14869-revert-14603-td-upgrade-semver 3 years ago
prom_wrapper.js 5683cebf71 Merge pull request #11679 from overleaf/em-upgrade-prom-client 3 years ago
timeAsyncMethod.js e0d91eaa26 Merge pull request #7906 from overleaf/em-downgrade-logs 4 years ago
tracing.js 994fcd68e2 Merge pull request #14903 from overleaf/revert-14869-revert-14603-td-upgrade-semver 3 years ago
uv_threadpool_size.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages 4 years ago

README.md

overleaf/metrics-module

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

Use:

const metrics = require('@overleaf/metrics')
metrics.initialize('myapp')

const express = require('express')
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.
  • ENABLE_TRACE_AGENT - enables @google-cloud/trace-agent on Google Cloud
  • ENABLE_DEBUG_AGENT - enables @google-cloud/debug-agent on Google Cloud
  • ENABLE_PROFILE_AGENT - enables @google-cloud/profiler on Google Cloud
  • 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