Eric Mc Sween efcb06f0df Merge pull request #7905 from overleaf/em-request-logging 4 anni fa
..
.circleci 2f35db4087 Fix startup crash 6 anni fa
test efcb06f0df Merge pull request #7905 from overleaf/em-request-logging 4 anni fa
.dockerignore 8945373715 Merge pull request #5724 from overleaf/jpa-lean-docker-build 4 anni fa
.gitignore 23efa1d977 [misc] prepare for monorepo 5 anni fa
.npmignore 0fdbb2dcc0 Add .npmignore to avoid publishing config files 6 anni fa
.nvmrc 3235119302 Merge pull request #7228 from overleaf/em-node-16 4 anni fa
CHANGELOG.md c5778fdd05 Merge pull request #5488 from overleaf/em-refactor-logger 5 anni fa
LICENSE 60857982b6 Create LICENSE 12 anni fa
README.md d9d65ac31c Merge pull request #5246 from overleaf/bg-upgrade-logger-in-all-libraries 5 anni fa
buildscript.txt 3235119302 Merge pull request #7228 from overleaf/em-node-16 4 anni fa
event_loop.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages 4 anni fa
http.js efcb06f0df Merge pull request #7905 from overleaf/em-request-logging 4 anni fa
index.js 264b107e39 Merge pull request #6927 from overleaf/jpa-split-clsi-metrics 4 anni fa
memory.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages 4 anni fa
mongodb.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages 4 anni fa
open_sockets.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages 4 anni fa
package.json ae0c347f27 Merge pull request #6542 from overleaf/jpa-em-code-sharing-workspaces 4 anni fa
prom_wrapper.js 264b107e39 Merge pull request #6927 from overleaf/jpa-split-clsi-metrics 4 anni fa
timeAsyncMethod.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages 4 anni fa
uv_threadpool_size.js 4b308553be Merge pull request #6120 from overleaf/jpa-same-linting-packages 4 anni fa

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