github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-12-26 04:31:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #48 from overleaf/csh-add-README

Browse source 
Add basic README
This commit is contained in:
Christopher Hoskin 2021-03-16 12:31:17 +00:00 committed by GitHub
commit 88f1210c8d
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
libraries/metrics/README.md Normal file
View file

@ -0,0 +1,30 @@
overleaf/metrics-module
=======================
Wrappers the [prom-client](https://github.com/siimon/prom-client) npm module to provide [Prometheus](https://prometheus.io/) 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](https://www.npmjs.com/package/compression#level) for `/metrics`
* `STACKDRIVER_LOGGING` - toggles the request logging format
* `UV_THREADPOOL_SIZE` - sets the libuv [thread pool](http://docs.libuv.org/en/v1.x/threadpool.html) size