github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-12-23 06:41:49 +00:00
Code Issues Projects Releases Packages Wiki Activity
overleaf/libraries/metrics
History
Jakob Ackermann 23efa1d977 [misc] prepare for monorepo 
- add git ignore entries
- sync/create package-lock.json
- delete .nvmrc
2021-07-27 16:33:33 +01:00
..
.circleci
test
.eslintrc
.gitignore [misc] prepare for monorepo 2021-07-27 16:33:33 +01:00
.npmignore
.prettierrc
event_loop.js
http.js
index.js
LICENSE
memory.js
mongodb.js
open_sockets.js
package-lock.json [misc] version bump to 3.5.1 2021-02-16 14:21:36 +00:00
package.json [misc] version bump to 3.5.1 2021-02-16 14:21:36 +00:00
prom_wrapper.js
README.md Add basic README 2021-03-16 12:03:53 +00:00
timeAsyncMethod.js
uv_threadpool_size.js

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('logger-sharelatex')
...
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