github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05: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 Fix startup crash 2020-09-17 10:30:25 -04:00
test [misc] fix collection of open sockets 2020-11-06 15:16:14 +00:00
.eslintrc Install prettier and eslint 2020-09-11 15:59:33 -04:00
.gitignore [misc] prepare for monorepo 2021-07-27 16:33:33 +01:00
.npmignore Add .npmignore to avoid publishing config files 2020-09-17 10:44:24 -04:00
.prettierrc Install prettier and eslint 2020-09-11 15:59:33 -04:00
event_loop.js Install prettier and eslint 2020-09-11 15:59:33 -04:00
http.js Add support for the swagger-tools router 2021-01-08 14:53:29 -05:00
index.js [misc] register the metrics sweeping interval handle for later cleanup 2021-01-12 14:20:31 +00:00
LICENSE Create LICENSE 2014-09-08 09:19:39 +01:00
memory.js Install prettier and eslint 2020-09-11 15:59:33 -04:00
mongodb.js Install prettier and eslint 2020-09-11 15:59:33 -04:00
open_sockets.js [misc] fix collection of open sockets 2020-11-06 15:16:14 +00:00
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 [misc] do not register a noop sweeping interval 2021-01-12 14:20:51 +00:00
README.md Add basic README 2021-03-16 12:03:53 +00:00
timeAsyncMethod.js Install prettier and eslint 2020-09-11 15:59:33 -04:00
uv_threadpool_size.js Install prettier and eslint 2020-09-11 15:59:33 -04:00

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