overleaf/libraries/metrics
Brian Gough fa2567aa61 Merge pull request #4980 from overleaf/bg-upgrade-metrics-dependencies
upgrade metrics dependencies

GitOrigin-RevId: 3fda4017ac4d5e1ab1e196051d557c10253924b7
2021-09-07 16:26:06 +00:00
..
.circleci
test Merge pull request #4689 from overleaf/jpa-libraries-ci 2021-08-13 12:56:39 +00:00
.eslintrc
.gitignore [misc] prepare for monorepo 2021-07-27 16:33:33 +01:00
.npmignore
.prettierrc
buildscript.txt Merge pull request #4689 from overleaf/jpa-libraries-ci 2021-08-13 12:56:39 +00:00
event_loop.js
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
memory.js
mongodb.js
open_sockets.js
package-lock.json Merge pull request #4980 from overleaf/bg-upgrade-metrics-dependencies 2021-09-07 16:26:06 +00:00
package.json Merge pull request #4980 from overleaf/bg-upgrade-metrics-dependencies 2021-09-07 16:26:06 +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
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('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