@mixpeek/grafana
v1.0.0
Published
Grafana integration for Mixpeek — dashboard provisioning, annotations, and Prometheus metric export
Readme
@mixpeek/grafana
Grafana integration for Mixpeek — dashboard provisioning, annotations, and Prometheus metric export
Installation
npm install @mixpeek/grafanaQuick Start
import prometheusExporter from '@mixpeek/grafana';
const instance = prometheusExporter({
apiKey: process.env.MIXPEEK_API_KEY
});Modules
PrometheusExporter
Exports Mixpeek metrics in Prometheus format for Grafana consumption
import { createPrometheusExporter } from '@mixpeek/grafana';
const prometheusExporter = createPrometheusExporter({
apiKey: process.env.MIXPEEK_API_KEY
});DashboardProvisioner
Generates and provisions Grafana dashboards for Mixpeek monitoring
import { createDashboardProvisioner } from '@mixpeek/grafana';
const dashboardProvisioner = createDashboardProvisioner({
apiKey: process.env.MIXPEEK_API_KEY
});AnnotationProvider
Provides Grafana annotations for Mixpeek enrichment events
import { createAnnotationProvider } from '@mixpeek/grafana';
const annotationProvider = createAnnotationProvider({
apiKey: process.env.MIXPEEK_API_KEY
});Testing
npm test # Unit tests
npm run test:e2e # End-to-end tests
npm run test:live # Live API tests (requires MIXPEEK_API_KEY)
npm run test:coverage # Coverage reportLicense
MIT
