overleaf/libraries/metrics
Eric Mc Sween adfe7abaaf Merge pull request #13255 from overleaf/em-socket-leak-detection
Reintroduce socket leak detection in all services

GitOrigin-RevId: 0a9a1ced0b886dbb267cb46beb5da7d0133d39aa
2023-05-31 08:05:24 +00:00
..
.circleci
test Merge pull request #13055 from overleaf/jpa-monitor-sockets-everywhere 2023-05-23 08:05:03 +00:00
.dockerignore
.gitignore
.npmignore
.nvmrc Merge pull request #12723 from overleaf/jpa-revert-node-18-upgrade 2023-04-21 08:03:22 +00:00
buildscript.txt Merge pull request #12723 from overleaf/jpa-revert-node-18-upgrade 2023-04-21 08:03:22 +00:00
CHANGELOG.md Merge pull request #10144 from overleaf/ii-metrics-api-patch-opts-arg 2022-10-28 08:04:43 +00:00
event_loop.js
http.js
index.js Merge branch 'bg-socket-leak-detection' 2023-05-24 08:04:01 +00:00
leaked_sockets.js Merge pull request #13255 from overleaf/em-socket-leak-detection 2023-05-31 08:05:24 +00:00
LICENSE
memory.js Merge pull request #7906 from overleaf/em-downgrade-logs 2022-05-17 08:05:26 +00:00
mongodb.js Merge pull request #11680 from overleaf/em-mongo-pool-monitoring 2023-02-09 14:34:35 +00:00
open_sockets.js Merge pull request #13055 from overleaf/jpa-monitor-sockets-everywhere 2023-05-23 08:05:03 +00:00
package.json Merge pull request #12369 from overleaf/csh-issue-4497-bump-profiler 2023-04-06 08:02:49 +00:00
prom_wrapper.js Merge pull request #11679 from overleaf/em-upgrade-prom-client 2023-02-09 14:34:28 +00:00
README.md
timeAsyncMethod.js Merge pull request #7906 from overleaf/em-downgrade-logs 2022-05-17 08:05:26 +00:00
tracing.js Merge pull request #10279 from overleaf/jpa-tracing-optimizations 2022-11-04 09:05:00 +00:00
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