overleaf/libraries/metrics
Christopher Hoskin 5f69488f67 Merge pull request #12369 from overleaf/csh-issue-4497-bump-profiler
Bump @google-cloud/profiler from 4.1.3 to 5.0.4

GitOrigin-RevId: 2426be7f50f91c8a67430f1097a9d97412178873
2023-04-06 08:02:49 +00:00
..
.circleci
test
.dockerignore
.gitignore
.npmignore
.nvmrc
buildscript.txt
CHANGELOG.md
event_loop.js
http.js
index.js
LICENSE
memory.js
mongodb.js
open_sockets.js
package.json Merge pull request #12369 from overleaf/csh-issue-4497-bump-profiler 2023-04-06 08:02:49 +00:00
prom_wrapper.js
README.md
timeAsyncMethod.js
tracing.js
uv_threadpool_size.js

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