mirror of
https://github.com/overleaf/overleaf.git
synced 2024-11-29 20:13:46 -05:00
50b346b4ed
[misc] do not load the tracing module unless enabled GitOrigin-RevId: 8a3b9da3e9451e3060b852dd44e078c99cf43cfa |
||
---|---|---|
.. | ||
.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 | ||
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 CloudENABLE_DEBUG_AGENT
- enables @google-cloud/debug-agent on Google CloudENABLE_PROFILE_AGENT
- enables @google-cloud/profiler on Google CloudMETRICS_COMPRESSION_LEVEL
- sets the compression level for/metrics
STACKDRIVER_LOGGING
- toggles the request logging formatUV_THREADPOOL_SIZE
- sets the libuv thread pool size