overleaf/libraries/metrics
Eric Mc Sween 3235119302 Merge pull request #7228 from overleaf/em-node-16
Upgrade to Node 16

GitOrigin-RevId: 3db1ae57ffb02f8a2b9012ffbb3efecfc01d2b04
2022-04-05 12:20:52 +00:00
..
.circleci
test Merge pull request #6927 from overleaf/jpa-split-clsi-metrics 2022-03-02 09:02:52 +00:00
.dockerignore
.gitignore
.npmignore
.nvmrc Merge pull request #7228 from overleaf/em-node-16 2022-04-05 12:20:52 +00:00
buildscript.txt Merge pull request #7228 from overleaf/em-node-16 2022-04-05 12:20:52 +00:00
CHANGELOG.md
event_loop.js Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00
http.js Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00
index.js Merge pull request #6927 from overleaf/jpa-split-clsi-metrics 2022-03-02 09:02:52 +00:00
LICENSE
memory.js Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00
mongodb.js Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00
open_sockets.js Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00
package.json Merge pull request #6542 from overleaf/jpa-em-code-sharing-workspaces 2022-02-16 11:31:07 +00:00
prom_wrapper.js Merge pull request #6927 from overleaf/jpa-split-clsi-metrics 2022-03-02 09:02:52 +00:00
README.md
timeAsyncMethod.js Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00
uv_threadpool_size.js Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00

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