mlepekha-nuxt-prometheus
v2.4.3
Published
Allows you to better understand what's going on with your application and how to optimize performance and other things in production
Downloads
6
Readme
📊 Prometheus integration for Nuxt 3
Allows you to better understand what's going on with your application and how to optimize performance and other things in production. Nuxt 2 users can use this version.
Limitations
Due to this issue in ofetch package @artmizu/nuxt-prometheus cannot detect network requests which take place through useFetch or $fetch, because they both use ofetch inside. So on the /metrics page, you don't see any request time related to ofetch. Future investigation will take place here.
Features
- Default NodeJS metrics exported through the prometheus middleware
- Custom metrics about pages render time and external request consumption time
- Health check middleware
Default routes that you can customise via the module options
/metrics
- prometheus metrics/health
- health check
Installation
Install package via a package manager:
# using nuxi, it automatically appends the module in your nuxt.config
npx nuxi@latest module add prometheus
# using npm
npm install @artmizu/nuxt-prometheus
# using yarn
yarn add @artmizu/nuxt-prometheus
# using pnpm
pnpm add @artmizu/nuxt-prometheus
Add it to a modules section of your nuxt config:
export default {
modules: ['@artmizu/nuxt-prometheus']
}
Grafana sample setup
Once the metrics have been collected by Prometheus, you will want to review them. I use Grafana for this purpose, and my metrics setup looks something like this:
Options
You can pass it through module options and the nuxt config property prometheus
.
verbose
- Type:
boolean
- Default:
true
- Description: Additional logs in the dev mode, about page rendering time and time of external API requests
healthCheck
- Type:
boolean
- Default:
true
- Description: To turn on and off the healthcheck route
healthCheckPath
- Type:
string
- Default:
/health
- Description: Healthcheck url path
prometheusPath
- Type:
string
- Default:
/metrics
- Description: Prometheus exporter url path
prefix
- Type:
string
- Default: no prefix
- Description: An optional prefix for metric names