Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Julien-R44/adonisjs-prometheus
📊 Prometheus Provider for AdonisJS with some builtins metrics for monitoring your application.
https://github.com/Julien-R44/adonisjs-prometheus
adonisjs adonisjs5 prometheus prometheus-exporter
Last synced: about 1 month ago
JSON representation
📊 Prometheus Provider for AdonisJS with some builtins metrics for monitoring your application.
- Host: GitHub
- URL: https://github.com/Julien-R44/adonisjs-prometheus
- Owner: Julien-R44
- License: mit
- Created: 2021-12-18T21:44:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T23:09:28.000Z (7 months ago)
- Last Synced: 2024-10-29T23:30:22.421Z (about 2 months ago)
- Topics: adonisjs, adonisjs5, prometheus, prometheus-exporter
- Language: TypeScript
- Homepage:
- Size: 503 KB
- Stars: 43
- Watchers: 4
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-adonisjs - Adonis Prometheus - Prometheus Provider for Adonis 5 with some builtins metrics for monitoring your application. (Packages)
README
Adonis5-Prometheus
Simple Prometheus Wrapper for Adonis
## Installation
```
npm i adonis5-prometheus
node ace configure adonis5-prometheus
```
## Usage
A configuration file has been added in `config/prometheus.ts`.
By default the system metrics are collected ( `systemMetrics.enabled: true` ), so now you can call the endpoint `{{host}}/metrics` to get the measured metrics.
Here is an example scrape_config to add to prometheus.yml:
```yaml
scrape_configs:
- job_name: my-adonis-app
static_configs:
- targets: [my-adonis-app.com]
scrape_interval: 5s
```
## Built-in Metrics
Metrics collected by Adonis5-prometheus middleware
| Type | Name | Description |
| --- | --- | --- |
| Histogram | `adonis_http_request_durations` | Total time each HTTP requests takes. |
| Gauge | `adonis_uptime_metrics` | Uptime performance of the application (1 = up, 0 = down) |
| Counter | `adonis_throughput_metrics` | No. of request handled. |
To enable them, simply register the `CollectPerformanceMetrics` as the first item in the start/kernel.ts:
```typescript
Server.middleware.register([
// Make it first in the list for reliable metrics.
() => import('@ioc:Adonis/Prometheus/Middlewares/CollectPerformanceMetrics'),
() => import('@ioc:Adonis/Core/BodyParser'),
...
])
```
Verify if the metrics are enabled in the `config/prometheus.ts` file. You can also configure the metrics there.
## Custom Metrics
```typescript
// Register your custom metrics in the separate file you want.
export const OrderMetric = new Prometheus.Counter({
name: 'sent_orders',
help: 'Total Orders Sent',
})
// OrderController.ts
import { OrderMetric } from 'App/Metrics'
export default class OrderController {
public async store({ request }: HttpContextContract) {
const order = await request.validate({ schema: OrderSchema })
// ...
OrderMetric.inc()
// ...
}
}
```
When hitting `{{host}}/metrics` you will now get the following:
```
# HELP send_orders Total Orders Sent
# TYPE send_orders counter
sent_orders 2
```
## Grafana Dashboard
A basic ready to use dashboard is available in the `grafana` folder.
**Grafana 8 is required** to be able to import the dashboard correctly, otherwise you'll have to tinker a bit to make it work.
It includes :
- Process CPU usage
- Event loop lag
- Node.JS version
- Requests by second
- Request volume rate by URL
- Average response time
- Response error rate by URL
To be fully functional, you need to enable `systemMetrics`, `httpMetric` and `throughputMetric` in the `config/prometheus.ts` file.
## Documentation
This library is a wrapper for prom-client. The prom-client object can be imported with `import Prometheus from '@ioc:Adonis/Prometheus'`. Check out the [documentation](https://github.com/siimon/prom-client) for more information.