overleaf/libraries/metrics
Eric Mc Sween d227dfba0c Merge pull request #16393 from overleaf/em-typescript-libraries
Add type checking to libraries

GitOrigin-RevId: bed79f5123081773d6ac6e27698246726184c5e6
2024-01-12 09:03:25 +00:00
..
test Merge pull request #15241 from overleaf/em-gcp-opentelemetry 2023-10-19 08:02:52 +00:00
.dockerignore Merge pull request #5724 from overleaf/jpa-lean-docker-build 2021-11-09 09:04:02 +00:00
.gitignore Merge pull request #14138 from overleaf/bg-em-jpa-mj-node-18 2023-08-03 08:03:56 +00:00
.npmignore Add .npmignore to avoid publishing config files 2020-09-17 10:44:24 -04:00
.nvmrc Merge pull request #15506 from overleaf/jpa-node-18-18-2 2023-11-01 09:02:48 +00:00
buildscript.txt Merge pull request #16058 from overleaf/jpa-faster-restart 2023-12-08 09:04:01 +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 Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00
http.js Merge pull request #7905 from overleaf/em-request-logging 2022-05-17 08:05:19 +00:00
index.js Merge pull request #15241 from overleaf/em-gcp-opentelemetry 2023-10-19 08:02:52 +00:00
initialize.js Merge pull request #15241 from overleaf/em-gcp-opentelemetry 2023-10-19 08:02:52 +00:00
leaked_sockets.js Merge pull request #13295 from overleaf/em-socket-leak-detection-pools 2023-07-17 10:24:02 +00:00
LICENSE Create LICENSE 2014-09-08 09:19:39 +01:00
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 #16393 from overleaf/em-typescript-libraries 2024-01-12 09:03:25 +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 Merge pull request #15241 from overleaf/em-gcp-opentelemetry 2023-10-19 08:02:52 +00:00
timeAsyncMethod.js Merge pull request #7906 from overleaf/em-downgrade-logs 2022-05-17 08:05:26 +00:00
tsconfig.json Merge pull request #16393 from overleaf/em-typescript-libraries 2024-01-12 09:03:25 +00:00
uv_threadpool_size.js Merge pull request #6120 from overleaf/jpa-same-linting-packages 2021-12-17 09:03:06 +00:00

overleaf/metrics-module

Wrappers the prom-client npm module to provide Prometheus metrics at /metrics.

Use:

// Metrics must be initialized before importing anything else
require('@overleaf/metrics/initialize')

const express = require('express')
const metrics = require('@overleaf/metrics')
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.
  • GCP_OPENTELEMETRY - enables OpenTelemetry tracing for GCP
  • JAEGER_OPENTELEMETRY - enables OpenTelemetry tracing for Jaeger (in the dev environment)
  • METRICS_APP_NAME - the app label for metrics and spans
  • 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