Alf Eaton aafb0d377c Merge pull request #15073 from overleaf/ae-circleci vor 2 Jahren
..
test 5638f06b3a Merge pull request #13055 from overleaf/jpa-monitor-sockets-everywhere vor 3 Jahren
.dockerignore 8945373715 Merge pull request #5724 from overleaf/jpa-lean-docker-build vor 4 Jahren
.gitignore a797fb2be7 Merge pull request #14138 from overleaf/bg-em-jpa-mj-node-18 vor 3 Jahren
.npmignore 0fdbb2dcc0 Add .npmignore to avoid publishing config files vor 5 Jahren
.nvmrc a2cf7b459c Merge pull request #14902 from overleaf/jpa-node-18-18-0 vor 2 Jahren
CHANGELOG.md c94043e2fe Merge pull request #10144 from overleaf/ii-metrics-api-patch-opts-arg vor 3 Jahren
LICENSE 60857982b6 Create LICENSE vor 12 Jahren
README.md e226dc1442 Remove @google-cloud/debug-agent from metrics (#14974) vor 2 Jahren
buildscript.txt efb36b7193 Merge pull request #14698 from overleaf/bg-sg-use-node-watch vor 2 Jahren
event_loop.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages vor 4 Jahren
http.js efcb06f0df Merge pull request #7905 from overleaf/em-request-logging vor 4 Jahren
index.js e226dc1442 Remove @google-cloud/debug-agent from metrics (#14974) vor 2 Jahren
leaked_sockets.js 8a15040f04 Merge pull request #13295 from overleaf/em-socket-leak-detection-pools vor 3 Jahren
memory.js e0d91eaa26 Merge pull request #7906 from overleaf/em-downgrade-logs vor 4 Jahren
mongodb.js 74eeec2ba3 Merge pull request #11680 from overleaf/em-mongo-pool-monitoring vor 3 Jahren
open_sockets.js 5638f06b3a Merge pull request #13055 from overleaf/jpa-monitor-sockets-everywhere vor 3 Jahren
package.json e226dc1442 Remove @google-cloud/debug-agent from metrics (#14974) vor 2 Jahren
prom_wrapper.js 5683cebf71 Merge pull request #11679 from overleaf/em-upgrade-prom-client vor 3 Jahren
timeAsyncMethod.js e0d91eaa26 Merge pull request #7906 from overleaf/em-downgrade-logs vor 4 Jahren
tracing.js 994fcd68e2 Merge pull request #14903 from overleaf/revert-14869-revert-14603-td-upgrade-semver vor 2 Jahren
uv_threadpool_size.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages vor 4 Jahren

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_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