prometheus
@artmizu/nuxt-prometheus

幫助您更好地瞭解應用程式的執行狀況,以及如何在生產環境中最佳化效能和其他方面

GitHub Workflow Status

Cover

📊 Nuxt 3 的 Prometheus 整合

幫助您更好地瞭解應用程式的執行狀況,以及如何在生產環境中最佳化效能和其他方面。Nuxt 2 使用者可以使用此版本

功能

  • 透過 prometheus 中介軟體匯出的預設 NodeJS 指標
  • 關於頁面渲染時間和外部請求消耗時間的自定義指標
  • 健康檢查中介軟體

可以透過模組選項自定義的預設路由

  • /metrics - prometheus 指標
  • /health - 健康檢查

安裝

透過包管理器安裝包

# 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

將其新增到 nuxt 配置的模組部分

export default {
  modules: ['@artmizu/nuxt-prometheus']
}

Grafana 示例設定

一旦 Prometheus 收集了指標,您就會想檢視它們。我為此使用 Grafana,我的指標設定大致如下:Cover

選項

您可以透過模組選項和 nuxt 配置屬性 prometheus 進行傳遞。

verbose

  • 型別:boolean
  • 預設值: true
  • 描述:開發模式中的附加日誌,關於頁面渲染時間和外部 API 請求時間

healthCheck

  • 型別:boolean
  • 預設值: true
  • 描述:開啟和關閉健康檢查路由

healthCheckPath

  • 型別:string
  • 預設值:/health
  • 描述:健康檢查 URL 路徑

prometheusPath

  • 型別:string
  • 預設值:/metrics
  • 描述:Prometheus 匯出器 URL 路徑

prefix

  • 型別:string
  • 預設值:無字首
  • 描述:指標名稱的可選字首