2 Commits

Author SHA1 Message Date
bad977bef0 feat: Add custom metric builder, export/import, and Grafana dashboards (v0.3.0)
All checks were successful
Create Release Package / build-release (push) Successful in 59s
- Custom Metrics Builder with admin UI for gauge metrics
- Support for static values and WordPress option-based values
- JSON-based export/import with skip/overwrite/rename modes
- Three Grafana dashboard templates (overview, runtime, WooCommerce)
- New tabs: Custom Metrics and Dashboards
- Reset runtime metrics button

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 15:27:16 +01:00
da6d5081f7 fix: Localhost license bypass, rewrite rules flush, WooCommerce orders (v0.2.2)
All checks were successful
Create Release Package / build-release (push) Successful in 56s
- Add localhost license bypass for development environments
- Flush rewrite rules when license status changes to fix 404 on /metrics
- Fix wc_orders_count() missing required status parameter

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 14:57:43 +01:00
17 changed files with 6310 additions and 624 deletions

View File

@@ -5,6 +5,50 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.3.0] - 2026-02-02
### Added
- Custom Metrics Builder:
- Admin UI to define custom gauge metrics
- Support for static values and WordPress option-based values
- Label support with up to 5 labels and 50 value combinations
- Metric validation following Prometheus naming conventions
- Metric Export/Import:
- JSON-based configuration export for backup
- Import with three modes: skip existing, overwrite, or rename duplicates
- Version tracking in export format
- Grafana Dashboard Templates:
- WordPress Overview dashboard (users, posts, comments, cron, transients)
- WordPress Runtime dashboard (HTTP requests, database queries)
- WordPress WooCommerce dashboard (orders, revenue, products, customers)
- Easy download and import instructions
- New "Custom Metrics" tab in admin settings
- New "Dashboards" tab in admin settings
- Reset runtime metrics button to clear accumulated data
### Changed
- Settings page now has 5 tabs: License, Metrics, Custom Metrics, Dashboards, Help
- Updated translations with all new strings
## [0.2.2] - 2026-02-02
### Fixed
- Fixed `wc_orders_count()` call missing required status parameter in WooCommerce orders metrics
## [0.2.1] - 2026-02-02
### Added
- Localhost license bypass for development environments (localhost, 127.0.0.1, ::1, \*.localhost, \*.local)
- Automatic rewrite rules flush when license status changes
### Fixed
- Fixed 404 error on `/metrics` endpoint when license becomes valid after plugin activation
## [0.2.0] - 2026-02-02 ## [0.2.0] - 2026-02-02
### Added ### Added

View File

@@ -18,6 +18,9 @@ This plugin provides a Prometheus `/metrics` endpoint and an extensible way to a
- Cron job metrics (scheduled events, overdue, next run) - Cron job metrics (scheduled events, overdue, next run)
- Transient cache metrics (total, expiring, expired) - Transient cache metrics (total, expiring, expired)
- WooCommerce integration (products, orders, revenue, customers) - WooCommerce integration (products, orders, revenue, customers)
- Custom metric builder with admin UI (gauges with static or option-based values)
- Metric export/import for backup and site migration
- Grafana dashboard templates for easy visualization
- Dedicated plugin settings under 'Settings/Metrics' menu - Dedicated plugin settings under 'Settings/Metrics' menu
- Extensible by other plugins using `wp_prometheus_collect_metrics` action hook - Extensible by other plugins using `wp_prometheus_collect_metrics` action hook
- License management integration - License management integration
@@ -30,11 +33,7 @@ This project is proudly **"vibe-coded"** using Claude.AI - the entire codebase w
**Note for AI Assistants:** Clean this section after the specific features are done or new releases are made. Effective changes are tracked in `CHANGELOG.md`. Do not add completed versions here - document them in the Session History section at the end of this file. **Note for AI Assistants:** Clean this section after the specific features are done or new releases are made. Effective changes are tracked in `CHANGELOG.md`. Do not add completed versions here - document them in the Session History section at the end of this file.
### Version 0.3.0 (Planned) *No planned features at this time.*
- Custom metric builder in admin
- Metric export/import
- Grafana dashboard templates
## Technical Stack ## Technical Stack
@@ -214,6 +213,10 @@ wp-prometheus/
│ └── release.yml # CI/CD pipeline │ └── release.yml # CI/CD pipeline
├── assets/ ├── assets/
│ ├── css/ # Admin/Frontend styles │ ├── css/ # Admin/Frontend styles
│ ├── dashboards/ # Grafana dashboard templates
│ │ ├── wordpress-overview.json
│ │ ├── wordpress-runtime.json
│ │ └── wordpress-woocommerce.json
│ └── js/ │ └── js/
│ └── admin.js # Admin JavaScript │ └── admin.js # Admin JavaScript
├── languages/ # Translation files ├── languages/ # Translation files
@@ -222,6 +225,7 @@ wp-prometheus/
├── releases/ # Release packages ├── releases/ # Release packages
├── src/ ├── src/
│ ├── Admin/ │ ├── Admin/
│ │ ├── DashboardProvider.php # Grafana dashboard provider
│ │ └── Settings.php # Settings page │ │ └── Settings.php # Settings page
│ ├── Endpoint/ │ ├── Endpoint/
│ │ └── MetricsEndpoint.php # /metrics endpoint │ │ └── MetricsEndpoint.php # /metrics endpoint
@@ -229,6 +233,7 @@ wp-prometheus/
│ │ └── Manager.php # License management │ │ └── Manager.php # License management
│ ├── Metrics/ │ ├── Metrics/
│ │ ├── Collector.php # Prometheus metrics collector │ │ ├── Collector.php # Prometheus metrics collector
│ │ ├── CustomMetricBuilder.php # Custom metric CRUD
│ │ └── RuntimeCollector.php # Runtime metrics collector │ │ └── RuntimeCollector.php # Runtime metrics collector
│ ├── Installer.php # Activation/Deactivation │ ├── Installer.php # Activation/Deactivation
│ ├── Plugin.php # Main plugin class │ ├── Plugin.php # Main plugin class
@@ -285,6 +290,37 @@ add_action( 'wp_prometheus_collect_metrics', function( $collector ) {
## Session History ## Session History
### 2026-02-02 - Custom Metrics & Dashboards (v0.3.0)
- Added Custom Metric Builder with full admin UI:
- `CustomMetricBuilder.php` - CRUD operations, validation, export/import
- Support for static values and WordPress option-based values
- Label support (max 5 labels, 50 value combinations)
- Prometheus naming convention validation (`[a-zA-Z_:][a-zA-Z0-9_:]*`)
- Added Grafana Dashboard Templates:
- `DashboardProvider.php` - Dashboard file provider with path traversal protection
- `wordpress-overview.json` - General WordPress metrics
- `wordpress-runtime.json` - HTTP/DB performance metrics
- `wordpress-woocommerce.json` - WooCommerce store metrics
- Added export/import functionality:
- JSON-based configuration export
- Three import modes: skip, overwrite, rename duplicates
- Version tracking in export format
- Updated Settings page with new tabs:
- "Custom Metrics" tab with metric form and table
- "Dashboards" tab with download buttons
- "Reset Runtime Metrics" button in Metrics tab
- Updated `Collector.php` to integrate custom metrics
- Updated translation files with all new strings
- **Key Learning**: Dynamic form handling in WordPress admin
- Use `wp_create_nonce()` with unique nonce names per AJAX action
- Localize script with `wp_localize_script()` for nonces and AJAX URL
- Always verify `current_user_can('manage_options')` in AJAX handlers
- **Key Learning**: Grafana dashboard JSON format
- Use `${DS_PROMETHEUS}` for data source variable
- Schema version 39 for current Grafana compatibility
- Panels use `gridPos` for layout positioning
### 2026-02-02 - Extended Metrics (v0.2.0) ### 2026-02-02 - Extended Metrics (v0.2.0)
- Added WooCommerce integration metrics (only when WooCommerce is active): - Added WooCommerce integration metrics (only when WooCommerce is active):

View File

@@ -45,3 +45,163 @@
.wp-prometheus-tab-content .form-table { .wp-prometheus-tab-content .form-table {
margin-top: 10px; margin-top: 10px;
} }
/* Custom metrics form */
.wp-prometheus-metric-form {
background: #fff;
border: 1px solid #ccd0d4;
border-radius: 4px;
padding: 20px;
margin: 20px 0;
}
.wp-prometheus-metric-form h3 {
margin-top: 0;
padding-bottom: 10px;
border-bottom: 1px solid #eee;
}
.wp-prometheus-metric-form .required {
color: #d63638;
}
/* Label rows */
.metric-label-row {
display: flex;
align-items: center;
gap: 10px;
margin-bottom: 8px;
}
.metric-label-row input {
flex: 1;
max-width: 300px;
}
.metric-label-row .remove-label {
padding: 0 8px;
min-width: auto;
}
/* Value rows */
.metric-value-row {
display: flex;
align-items: center;
gap: 8px;
margin-bottom: 8px;
flex-wrap: wrap;
}
.metric-value-row input {
width: 120px;
}
.metric-value-row .remove-value-row {
padding: 0 8px;
min-width: auto;
}
/* Custom metrics table */
.wp-prometheus-custom-metrics .wp-list-table code {
background: #f0f0f1;
padding: 2px 6px;
border-radius: 3px;
}
.wp-prometheus-custom-metrics .wp-list-table td {
vertical-align: middle;
}
.wp-prometheus-custom-metrics .wp-list-table .dashicons {
font-size: 18px;
width: 18px;
height: 18px;
}
/* Dashboard grid */
.wp-prometheus-dashboard-grid {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(280px, 1fr));
gap: 20px;
margin: 20px 0;
}
.wp-prometheus-dashboard-card {
background: #fff;
border: 1px solid #ccd0d4;
border-radius: 4px;
padding: 20px;
text-align: center;
transition: box-shadow 0.2s ease;
}
.wp-prometheus-dashboard-card:hover {
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
}
.wp-prometheus-dashboard-card .dashboard-icon {
margin-bottom: 15px;
}
.wp-prometheus-dashboard-card .dashboard-icon .dashicons {
font-size: 48px;
width: 48px;
height: 48px;
color: #2271b1;
}
.wp-prometheus-dashboard-card h3 {
margin: 0 0 10px 0;
font-size: 16px;
}
.wp-prometheus-dashboard-card p {
color: #646970;
margin: 0 0 15px 0;
font-size: 13px;
}
/* Import options panel */
#import-options {
border-radius: 4px;
}
#import-options label {
display: block;
margin-bottom: 8px;
}
/* Spinner alignment */
.spinner {
float: none;
vertical-align: middle;
}
/* Button groups */
.wp-prometheus-tab-content .button + .button {
margin-left: 5px;
}
/* Notice messages in forms */
.wp-prometheus-metric-form .notice,
.wp-prometheus-custom-metrics .notice {
margin: 10px 0;
padding: 10px 15px;
}
/* Responsive adjustments */
@media screen and (max-width: 782px) {
.wp-prometheus-dashboard-grid {
grid-template-columns: 1fr;
}
.metric-value-row {
flex-direction: column;
align-items: flex-start;
}
.metric-value-row input {
width: 100%;
max-width: none;
}
}

View File

@@ -0,0 +1,851 @@
{
"annotations": {
"list": []
},
"editable": true,
"fiscalYearStartMonth": 0,
"graphTooltip": 0,
"id": null,
"links": [],
"panels": [
{
"collapsed": false,
"gridPos": {
"h": 1,
"w": 24,
"x": 0,
"y": 0
},
"id": 1,
"panels": [],
"title": "System Info",
"type": "row"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 6,
"x": 0,
"y": 1
},
"id": 2,
"options": {
"colorMode": "value",
"graphMode": "none",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "/^version$/",
"values": false
},
"textMode": "value"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_info",
"format": "table",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "WordPress Version",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 6,
"x": 6,
"y": 1
},
"id": 3,
"options": {
"colorMode": "value",
"graphMode": "none",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "/^php_version$/",
"values": false
},
"textMode": "value"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_info",
"format": "table",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "PHP Version",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "blue",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 6,
"x": 12,
"y": 1
},
"id": 4,
"options": {
"colorMode": "value",
"graphMode": "none",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(wordpress_users_total)",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Total Users",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "blue",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 6,
"x": 18,
"y": 1
},
"id": 5,
"options": {
"colorMode": "value",
"graphMode": "none",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_plugins_total{status=\"active\"}",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Active Plugins",
"type": "stat"
},
{
"collapsed": false,
"gridPos": {
"h": 1,
"w": 24,
"x": 0,
"y": 5
},
"id": 6,
"panels": [],
"title": "Content",
"type": "row"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
}
},
"mappings": []
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 8,
"x": 0,
"y": 6
},
"id": 7,
"options": {
"legend": {
"displayMode": "list",
"placement": "right",
"showLegend": true
},
"pieType": "pie",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"tooltip": {
"mode": "single",
"sort": "none"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_users_total",
"instant": true,
"legendFormat": "{{role}}",
"refId": "A"
}
],
"title": "Users by Role",
"type": "piechart"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
}
},
"mappings": []
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 8,
"x": 8,
"y": 6
},
"id": 8,
"options": {
"legend": {
"displayMode": "list",
"placement": "right",
"showLegend": true
},
"pieType": "pie",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"tooltip": {
"mode": "single",
"sort": "none"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_posts_total{post_type=\"post\"}",
"instant": true,
"legendFormat": "{{status}}",
"refId": "A"
}
],
"title": "Posts by Status",
"type": "piechart"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
}
},
"mappings": []
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 8,
"x": 16,
"y": 6
},
"id": 9,
"options": {
"legend": {
"displayMode": "list",
"placement": "right",
"showLegend": true
},
"pieType": "pie",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"tooltip": {
"mode": "single",
"sort": "none"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_comments_total{status!=\"total_comments\"}",
"instant": true,
"legendFormat": "{{status}}",
"refId": "A"
}
],
"title": "Comments by Status",
"type": "piechart"
},
{
"collapsed": false,
"gridPos": {
"h": 1,
"w": 24,
"x": 0,
"y": 14
},
"id": 10,
"panels": [],
"title": "System Health",
"type": "row"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
},
{
"color": "yellow",
"value": 5
},
{
"color": "red",
"value": 10
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 6,
"x": 0,
"y": 15
},
"id": 11,
"options": {
"colorMode": "value",
"graphMode": "area",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_cron_overdue_total",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Overdue Cron Events",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "blue",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 6,
"x": 6,
"y": 15
},
"id": 12,
"options": {
"colorMode": "value",
"graphMode": "none",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(wordpress_cron_events_total)",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Total Cron Events",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "blue",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 6,
"x": 12,
"y": 15
},
"id": 13,
"options": {
"colorMode": "value",
"graphMode": "none",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_transients_total{type=\"total\"}",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Total Transients",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
},
{
"color": "yellow",
"value": 50
},
{
"color": "red",
"value": 100
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 6,
"x": 18,
"y": 15
},
"id": 14,
"options": {
"colorMode": "value",
"graphMode": "area",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_transients_total{type=\"expired\"}",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Expired Transients",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "bars",
"fillOpacity": 80,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"insertNulls": false,
"lineInterpolation": "linear",
"lineWidth": 1,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "auto",
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 24,
"x": 0,
"y": 19
},
"id": 15,
"options": {
"legend": {
"calcs": [],
"displayMode": "list",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "single",
"sort": "none"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "topk(10, wordpress_cron_events_total)",
"instant": false,
"legendFormat": "{{hook}}",
"range": true,
"refId": "A"
}
],
"title": "Top 10 Cron Hooks",
"type": "timeseries"
}
],
"refresh": "30s",
"schemaVersion": 39,
"tags": ["wordpress", "prometheus"],
"templating": {
"list": [
{
"current": {
"selected": false,
"text": "Prometheus",
"value": "Prometheus"
},
"hide": 0,
"includeAll": false,
"label": "Data Source",
"multi": false,
"name": "DS_PROMETHEUS",
"options": [],
"query": "prometheus",
"queryValue": "",
"refresh": 1,
"regex": "",
"skipUrlSync": false,
"type": "datasource"
}
]
},
"time": {
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timezone": "browser",
"title": "WordPress Overview",
"uid": "wp-prometheus-overview",
"version": 1,
"weekStart": ""
}

View File

@@ -0,0 +1,987 @@
{
"annotations": {
"list": []
},
"editable": true,
"fiscalYearStartMonth": 0,
"graphTooltip": 0,
"id": null,
"links": [],
"panels": [
{
"collapsed": false,
"gridPos": {
"h": 1,
"w": 24,
"x": 0,
"y": 0
},
"id": 1,
"panels": [],
"title": "HTTP Requests",
"type": "row"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "line",
"fillOpacity": 10,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"insertNulls": false,
"lineInterpolation": "smooth",
"lineWidth": 2,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "never",
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
},
"unit": "reqps"
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 1
},
"id": 2,
"options": {
"legend": {
"calcs": ["mean", "max"],
"displayMode": "table",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "multi",
"sort": "desc"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(rate(wordpress_http_requests_total[5m])) by (endpoint)",
"legendFormat": "{{endpoint}}",
"range": true,
"refId": "A"
}
],
"title": "Requests per Second by Endpoint",
"type": "timeseries"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "line",
"fillOpacity": 10,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"insertNulls": false,
"lineInterpolation": "smooth",
"lineWidth": 2,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "never",
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
},
"unit": "reqps"
},
"overrides": [
{
"matcher": {
"id": "byRegexp",
"options": "/2..$/"
},
"properties": [
{
"id": "color",
"value": {
"fixedColor": "green",
"mode": "fixed"
}
}
]
},
{
"matcher": {
"id": "byRegexp",
"options": "/4..$/"
},
"properties": [
{
"id": "color",
"value": {
"fixedColor": "orange",
"mode": "fixed"
}
}
]
},
{
"matcher": {
"id": "byRegexp",
"options": "/5..$/"
},
"properties": [
{
"id": "color",
"value": {
"fixedColor": "red",
"mode": "fixed"
}
}
]
}
]
},
"gridPos": {
"h": 8,
"w": 12,
"x": 12,
"y": 1
},
"id": 3,
"options": {
"legend": {
"calcs": ["mean", "max"],
"displayMode": "table",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "multi",
"sort": "desc"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(rate(wordpress_http_requests_total[5m])) by (status)",
"legendFormat": "{{status}}",
"range": true,
"refId": "A"
}
],
"title": "Requests per Second by Status",
"type": "timeseries"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
}
},
"mappings": []
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 8,
"x": 0,
"y": 9
},
"id": 4,
"options": {
"legend": {
"displayMode": "list",
"placement": "right",
"showLegend": true
},
"pieType": "donut",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"tooltip": {
"mode": "single",
"sort": "none"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(wordpress_http_requests_total) by (method)",
"instant": true,
"legendFormat": "{{method}}",
"refId": "A"
}
],
"title": "Requests by Method",
"type": "piechart"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
}
},
"mappings": []
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 8,
"x": 8,
"y": 9
},
"id": 5,
"options": {
"legend": {
"displayMode": "list",
"placement": "right",
"showLegend": true
},
"pieType": "donut",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"tooltip": {
"mode": "single",
"sort": "none"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(wordpress_http_requests_total) by (endpoint)",
"instant": true,
"legendFormat": "{{endpoint}}",
"refId": "A"
}
],
"title": "Requests by Endpoint",
"type": "piechart"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "blue",
"value": null
}
]
},
"unit": "short"
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 8,
"x": 16,
"y": 9
},
"id": 6,
"options": {
"colorMode": "value",
"graphMode": "area",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(wordpress_http_requests_total)",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Total Requests (All Time)",
"type": "stat"
},
{
"collapsed": false,
"gridPos": {
"h": 1,
"w": 24,
"x": 0,
"y": 17
},
"id": 7,
"panels": [],
"title": "Request Duration",
"type": "row"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "line",
"fillOpacity": 10,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"insertNulls": false,
"lineInterpolation": "smooth",
"lineWidth": 2,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "never",
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
},
"unit": "s"
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 18
},
"id": 8,
"options": {
"legend": {
"calcs": ["mean", "max"],
"displayMode": "table",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "multi",
"sort": "desc"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_http_request_duration_seconds_sum / wordpress_http_request_duration_seconds_count",
"legendFormat": "{{method}} {{endpoint}}",
"range": true,
"refId": "A"
}
],
"title": "Average Request Duration",
"type": "timeseries"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"fillOpacity": 80,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"lineWidth": 1,
"scaleDistribution": {
"type": "linear"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 12,
"x": 12,
"y": 18
},
"id": 9,
"options": {
"barRadius": 0,
"barWidth": 0.97,
"fullHighlight": false,
"groupWidth": 0.7,
"legend": {
"calcs": [],
"displayMode": "list",
"placement": "bottom",
"showLegend": true
},
"orientation": "horizontal",
"showValue": "auto",
"stacking": "none",
"tooltip": {
"mode": "single",
"sort": "none"
},
"xTickLabelRotation": 0,
"xTickLabelSpacing": 0
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(wordpress_http_request_duration_seconds_bucket) by (le)",
"format": "table",
"instant": true,
"legendFormat": "{{le}}",
"refId": "A"
}
],
"title": "Request Duration Distribution (Buckets)",
"type": "barchart"
},
{
"collapsed": false,
"gridPos": {
"h": 1,
"w": 24,
"x": 0,
"y": 26
},
"id": 10,
"panels": [],
"title": "Database Queries",
"type": "row"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "line",
"fillOpacity": 10,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"insertNulls": false,
"lineInterpolation": "smooth",
"lineWidth": 2,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "never",
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
},
"unit": "short"
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 27
},
"id": 11,
"options": {
"legend": {
"calcs": ["mean", "max"],
"displayMode": "table",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "multi",
"sort": "desc"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "rate(wordpress_db_queries_total[5m])",
"legendFormat": "{{endpoint}}",
"range": true,
"refId": "A"
}
],
"title": "Database Queries per Second",
"type": "timeseries"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "line",
"fillOpacity": 10,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"insertNulls": false,
"lineInterpolation": "smooth",
"lineWidth": 2,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "never",
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
},
"unit": "s"
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 12,
"x": 12,
"y": 27
},
"id": 12,
"options": {
"legend": {
"calcs": ["mean", "max"],
"displayMode": "table",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "multi",
"sort": "desc"
}
},
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "wordpress_db_query_duration_seconds_sum / wordpress_db_query_duration_seconds_count",
"legendFormat": "{{endpoint}}",
"range": true,
"refId": "A"
}
],
"title": "Average Query Duration",
"type": "timeseries"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "blue",
"value": null
}
]
},
"unit": "short"
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 12,
"x": 0,
"y": 35
},
"id": 13,
"options": {
"colorMode": "value",
"graphMode": "area",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(wordpress_db_queries_total)",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Total Database Queries (All Time)",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
},
{
"color": "yellow",
"value": 0.1
},
{
"color": "red",
"value": 0.5
}
]
},
"unit": "s"
},
"overrides": []
},
"gridPos": {
"h": 4,
"w": 12,
"x": 12,
"y": 35
},
"id": 14,
"options": {
"colorMode": "value",
"graphMode": "area",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": ["lastNotNull"],
"fields": "",
"values": false
},
"textMode": "auto"
},
"pluginVersion": "10.0.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum(wordpress_db_query_duration_seconds_sum) / sum(wordpress_db_query_duration_seconds_count)",
"instant": true,
"legendFormat": "__auto",
"refId": "A"
}
],
"title": "Average Query Duration (Overall)",
"type": "stat"
}
],
"refresh": "30s",
"schemaVersion": 39,
"tags": ["wordpress", "prometheus", "performance"],
"templating": {
"list": [
{
"current": {
"selected": false,
"text": "Prometheus",
"value": "Prometheus"
},
"hide": 0,
"includeAll": false,
"label": "Data Source",
"multi": false,
"name": "DS_PROMETHEUS",
"options": [],
"query": "prometheus",
"queryValue": "",
"refresh": 1,
"regex": "",
"skipUrlSync": false,
"type": "datasource"
}
]
},
"time": {
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timezone": "browser",
"title": "WordPress Runtime Performance",
"uid": "wp-prometheus-runtime",
"version": 1,
"weekStart": ""
}

File diff suppressed because it is too large Load Diff

View File

@@ -7,7 +7,26 @@
(function($) { (function($) {
'use strict'; 'use strict';
var importFileContent = null;
$(document).ready(function() { $(document).ready(function() {
// License tab handlers.
initLicenseHandlers();
// Custom metrics tab handlers.
initCustomMetricsHandlers();
// Dashboards tab handlers.
initDashboardsHandlers();
// Runtime metrics reset handler.
initResetRuntimeHandler();
});
/**
* Initialize license tab handlers.
*/
function initLicenseHandlers() {
// Validate license button. // Validate license button.
$('#wp-prometheus-validate-license').on('click', function(e) { $('#wp-prometheus-validate-license').on('click', function(e) {
e.preventDefault(); e.preventDefault();
@@ -23,11 +42,171 @@
// Regenerate token button. // Regenerate token button.
$('#wp-prometheus-regenerate-token').on('click', function(e) { $('#wp-prometheus-regenerate-token').on('click', function(e) {
e.preventDefault(); e.preventDefault();
if (confirm('Are you sure you want to regenerate the auth token? You will need to update your Prometheus configuration.')) { if (confirm(wpPrometheus.confirmRegenerateToken)) {
var newToken = generateToken(32); var newToken = generateToken(32);
$('#wp_prometheus_auth_token').val(newToken); $('#wp_prometheus_auth_token').val(newToken);
} }
}); });
}
/**
* Initialize custom metrics tab handlers.
*/
function initCustomMetricsHandlers() {
var $formContainer = $('#wp-prometheus-metric-form-container');
var $form = $('#wp-prometheus-metric-form');
var $showFormBtn = $('#show-metric-form');
// Show metric form.
$showFormBtn.on('click', function() {
resetMetricForm();
$formContainer.slideDown();
$(this).hide();
});
// Cancel metric form.
$('#cancel-metric-form').on('click', function() {
$formContainer.slideUp();
$showFormBtn.show();
// Remove edit parameter from URL.
if (window.location.search.indexOf('edit=') > -1) {
window.history.pushState({}, '', window.location.pathname + '?page=wp-prometheus&tab=custom');
}
});
// Value type toggle.
$('input[name="value_type"]').on('change', function() {
var valueType = $(this).val();
if (valueType === 'option') {
$('#option-config-row').show();
$('#static-values-row').hide();
} else {
$('#option-config-row').hide();
$('#static-values-row').show();
}
});
// Add label.
$('#add-label').on('click', function() {
var $container = $('#metric-labels-container');
var labelCount = $container.find('.metric-label-row').length;
if (labelCount >= 5) {
alert('Maximum 5 labels allowed per metric.');
return;
}
var $row = $('<div class="metric-label-row">' +
'<input type="text" name="labels[]" class="regular-text" placeholder="label_name" pattern="[a-zA-Z_][a-zA-Z0-9_]*">' +
'<button type="button" class="button remove-label">&times;</button>' +
'</div>');
$container.append($row);
updateValueRows();
});
// Remove label.
$(document).on('click', '.remove-label', function() {
$(this).closest('.metric-label-row').remove();
updateValueRows();
});
// Add value row.
$('#add-value-row').on('click', function() {
var $container = $('#metric-values-container');
var rowCount = $container.find('.metric-value-row').length;
var labelCount = getLabelCount();
var $row = $('<div class="metric-value-row"></div>');
// Add label value inputs.
var labels = getLabels();
for (var i = 0; i < labelCount; i++) {
$row.append('<input type="text" name="label_values[' + rowCount + '][]" class="small-text" placeholder="' + (labels[i] || 'value') + '">');
}
// Add metric value input.
$row.append('<input type="number" name="label_values[' + rowCount + '][]" class="small-text" step="any" placeholder="Value">');
$row.append('<button type="button" class="button remove-value-row">&times;</button>');
$container.append($row);
});
// Remove value row.
$(document).on('click', '.remove-value-row', function() {
$(this).closest('.metric-value-row').remove();
});
// Submit metric form.
$form.on('submit', function(e) {
e.preventDefault();
saveCustomMetric();
});
// Delete metric.
$(document).on('click', '.delete-metric', function() {
var id = $(this).data('id');
if (confirm(wpPrometheus.confirmDelete)) {
deleteCustomMetric(id);
}
});
// Export metrics.
$('#export-metrics').on('click', function() {
exportMetrics();
});
// Import metrics - trigger file input.
$('#import-metrics-btn').on('click', function() {
$('#import-metrics-file').click();
});
// Import file selected.
$('#import-metrics-file').on('change', function(e) {
var file = e.target.files[0];
if (file) {
var reader = new FileReader();
reader.onload = function(e) {
importFileContent = e.target.result;
$('#import-options').slideDown();
};
reader.readAsText(file);
}
});
// Confirm import.
$('#confirm-import').on('click', function() {
var mode = $('input[name="import_mode"]:checked').val();
importMetrics(importFileContent, mode);
});
// Cancel import.
$('#cancel-import').on('click', function() {
$('#import-options').slideUp();
$('#import-metrics-file').val('');
importFileContent = null;
});
}
/**
* Initialize dashboards tab handlers.
*/
function initDashboardsHandlers() {
$(document).on('click', '.download-dashboard', function() {
var slug = $(this).data('slug');
downloadDashboard(slug);
});
}
/**
* Initialize reset runtime metrics handler.
*/
function initResetRuntimeHandler() {
$('#wp-prometheus-reset-runtime').on('click', function() {
if (confirm(wpPrometheus.confirmReset)) {
resetRuntimeMetrics();
}
});
}
/** /**
* Perform a license action via AJAX. * Perform a license action via AJAX.
@@ -82,6 +261,325 @@
}); });
} }
/**
* Save custom metric via AJAX.
*/
function saveCustomMetric() {
var $spinner = $('#wp-prometheus-metric-spinner');
var $message = $('#wp-prometheus-metric-message');
var $form = $('#wp-prometheus-metric-form');
$spinner.addClass('is-active');
$message.hide();
var formData = $form.serialize();
formData += '&action=wp_prometheus_save_custom_metric';
formData += '&nonce=' + wpPrometheus.customMetricNonce;
$.ajax({
url: wpPrometheus.ajaxUrl,
type: 'POST',
data: formData,
success: function(response) {
$spinner.removeClass('is-active');
if (response.success) {
$message
.removeClass('notice-error')
.addClass('notice notice-success')
.html('<p>' + response.data.message + '</p>')
.show();
setTimeout(function() {
window.location.href = window.location.pathname + '?page=wp-prometheus&tab=custom';
}, 1000);
} else {
$message
.removeClass('notice-success')
.addClass('notice notice-error')
.html('<p>' + (response.data.message || 'An error occurred.') + '</p>')
.show();
}
},
error: function() {
$spinner.removeClass('is-active');
$message
.removeClass('notice-success')
.addClass('notice notice-error')
.html('<p>Connection error. Please try again.</p>')
.show();
}
});
}
/**
* Delete custom metric via AJAX.
*
* @param {string} id Metric ID.
*/
function deleteCustomMetric(id) {
$.ajax({
url: wpPrometheus.ajaxUrl,
type: 'POST',
data: {
action: 'wp_prometheus_delete_custom_metric',
nonce: wpPrometheus.customMetricNonce,
id: id
},
success: function(response) {
if (response.success) {
$('tr[data-metric-id="' + id + '"]').fadeOut(function() {
$(this).remove();
// Check if table is empty.
if ($('.wp-prometheus-custom-metrics tbody tr').length === 0) {
location.reload();
}
});
} else {
alert(response.data.message || 'An error occurred.');
}
},
error: function() {
alert('Connection error. Please try again.');
}
});
}
/**
* Export metrics via AJAX.
*/
function exportMetrics() {
$.ajax({
url: wpPrometheus.ajaxUrl,
type: 'POST',
data: {
action: 'wp_prometheus_export_metrics',
nonce: wpPrometheus.exportNonce
},
success: function(response) {
if (response.success) {
downloadFile(response.data.json, response.data.filename, 'application/json');
} else {
alert(response.data.message || 'An error occurred.');
}
},
error: function() {
alert('Connection error. Please try again.');
}
});
}
/**
* Import metrics via AJAX.
*
* @param {string} json JSON content.
* @param {string} mode Import mode.
*/
function importMetrics(json, mode) {
var $spinner = $('#wp-prometheus-import-spinner');
var $message = $('#wp-prometheus-import-message');
$spinner.addClass('is-active');
$message.hide();
$.ajax({
url: wpPrometheus.ajaxUrl,
type: 'POST',
data: {
action: 'wp_prometheus_import_metrics',
nonce: wpPrometheus.importNonce,
json: json,
mode: mode
},
success: function(response) {
$spinner.removeClass('is-active');
if (response.success) {
$message
.removeClass('notice-error')
.addClass('notice notice-success')
.html('<p>' + response.data.message + '</p>')
.show();
$('#import-options').slideUp();
$('#import-metrics-file').val('');
importFileContent = null;
setTimeout(function() {
location.reload();
}, 1500);
} else {
$message
.removeClass('notice-success')
.addClass('notice notice-error')
.html('<p>' + (response.data.message || 'An error occurred.') + '</p>')
.show();
}
},
error: function() {
$spinner.removeClass('is-active');
$message
.removeClass('notice-success')
.addClass('notice notice-error')
.html('<p>Connection error. Please try again.</p>')
.show();
}
});
}
/**
* Download dashboard via AJAX.
*
* @param {string} slug Dashboard slug.
*/
function downloadDashboard(slug) {
$.ajax({
url: wpPrometheus.ajaxUrl,
type: 'POST',
data: {
action: 'wp_prometheus_download_dashboard',
nonce: wpPrometheus.dashboardNonce,
slug: slug
},
success: function(response) {
if (response.success) {
downloadFile(response.data.json, response.data.filename, 'application/json');
} else {
alert(response.data.message || 'An error occurred.');
}
},
error: function() {
alert('Connection error. Please try again.');
}
});
}
/**
* Reset runtime metrics via AJAX.
*/
function resetRuntimeMetrics() {
var $spinner = $('#wp-prometheus-reset-spinner');
var $message = $('#wp-prometheus-reset-message');
$spinner.addClass('is-active');
$message.hide();
$.ajax({
url: wpPrometheus.ajaxUrl,
type: 'POST',
data: {
action: 'wp_prometheus_reset_runtime_metrics',
nonce: wpPrometheus.resetRuntimeNonce
},
success: function(response) {
$spinner.removeClass('is-active');
if (response.success) {
$message
.removeClass('notice-error')
.addClass('notice notice-success')
.html('<p>' + response.data.message + '</p>')
.show();
} else {
$message
.removeClass('notice-success')
.addClass('notice notice-error')
.html('<p>' + (response.data.message || 'An error occurred.') + '</p>')
.show();
}
},
error: function() {
$spinner.removeClass('is-active');
$message
.removeClass('notice-success')
.addClass('notice notice-error')
.html('<p>Connection error. Please try again.</p>')
.show();
}
});
}
/**
* Reset the metric form to default state.
*/
function resetMetricForm() {
var $form = $('#wp-prometheus-metric-form');
$form[0].reset();
$('#metric-id').val('');
$('#wp-prometheus-form-title').text('Add New Metric');
$('#option-config-row').hide();
$('#static-values-row').show();
$('#wp-prometheus-metric-message').hide();
// Reset labels to single empty row.
$('#metric-labels-container').html(
'<div class="metric-label-row">' +
'<input type="text" name="labels[]" class="regular-text" placeholder="label_name" pattern="[a-zA-Z_][a-zA-Z0-9_]*">' +
'<button type="button" class="button remove-label">&times;</button>' +
'</div>'
);
// Reset values to single empty row.
$('#metric-values-container').html(
'<div class="metric-value-row">' +
'<input type="number" name="label_values[0][]" class="small-text" step="any" placeholder="Value">' +
'<button type="button" class="button remove-value-row">&times;</button>' +
'</div>'
);
}
/**
* Update value rows when labels change.
*/
function updateValueRows() {
var labels = getLabels();
var labelCount = labels.length;
$('#metric-values-container .metric-value-row').each(function(rowIndex) {
var $row = $(this);
var inputs = $row.find('input').toArray();
var currentValues = inputs.map(function(input) { return input.value; });
// Remove all inputs except the value and button.
$row.find('input').remove();
// Re-add label inputs.
for (var i = 0; i < labelCount; i++) {
var val = currentValues[i] || '';
$row.prepend('<input type="text" name="label_values[' + rowIndex + '][]" class="small-text" placeholder="' + (labels[i] || 'value') + '" value="' + val + '">');
}
// Re-add value input.
var metricVal = currentValues[currentValues.length - 1] || '';
$row.find('.remove-value-row').before('<input type="number" name="label_values[' + rowIndex + '][]" class="small-text" step="any" placeholder="Value" value="' + metricVal + '">');
});
}
/**
* Get current label names.
*
* @return {string[]} Array of label names.
*/
function getLabels() {
var labels = [];
$('#metric-labels-container input[name="labels[]"]').each(function() {
var val = $(this).val().trim();
if (val) {
labels.push(val);
}
});
return labels;
}
/**
* Get current label count.
*
* @return {number} Number of labels.
*/
function getLabelCount() {
return getLabels().length;
}
/** /**
* Generate a random token. * Generate a random token.
* *
@@ -96,5 +594,23 @@
} }
return token; return token;
} }
});
/**
* Download a file.
*
* @param {string} content File content.
* @param {string} filename Filename.
* @param {string} type MIME type.
*/
function downloadFile(content, filename, type) {
var blob = new Blob([content], { type: type });
var url = URL.createObjectURL(blob);
var a = document.createElement('a');
a.href = url;
a.download = filename;
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
URL.revokeObjectURL(url);
}
})(jQuery); })(jQuery);

Binary file not shown.

View File

@@ -3,7 +3,7 @@
# This file is distributed under the GPL v2 or later. # This file is distributed under the GPL v2 or later.
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: WP Prometheus 0.2.0\n" "Project-Id-Version: WP Prometheus 0.3.0\n"
"Report-Msgid-Bugs-To: https://src.bundespruefstelle.ch/magdev/wp-prometheus/issues\n" "Report-Msgid-Bugs-To: https://src.bundespruefstelle.ch/magdev/wp-prometheus/issues\n"
"POT-Creation-Date: 2026-02-02T00:00:00+00:00\n" "POT-Creation-Date: 2026-02-02T00:00:00+00:00\n"
"PO-Revision-Date: 2026-02-02T00:00:00+00:00\n" "PO-Revision-Date: 2026-02-02T00:00:00+00:00\n"
@@ -31,6 +31,14 @@ msgstr "Lizenz"
msgid "Help" msgid "Help"
msgstr "Hilfe" msgstr "Hilfe"
#: src/Admin/Settings.php
msgid "Custom Metrics"
msgstr "Eigene Metriken"
#: src/Admin/Settings.php
msgid "Dashboards"
msgstr "Dashboards"
#: src/Admin/Settings.php #: src/Admin/Settings.php
msgid "License settings saved." msgid "License settings saved."
msgstr "Lizenz-Einstellungen gespeichert." msgstr "Lizenz-Einstellungen gespeichert."
@@ -213,6 +221,18 @@ msgstr "WooCommerce-Umsatz (gesamt, heute, Monat)"
msgid "WooCommerce Customers (registered, guest)" msgid "WooCommerce Customers (registered, guest)"
msgstr "WooCommerce-Kunden (registriert, Gast)" msgstr "WooCommerce-Kunden (registriert, Gast)"
#: src/Admin/Settings.php
msgid "Reset Runtime Metrics"
msgstr "Laufzeit-Metriken zuruecksetzen"
#: src/Admin/Settings.php
msgid "Clear all accumulated runtime metric data."
msgstr "Alle gesammelten Laufzeit-Metrikdaten loeschen."
#: src/Admin/Settings.php
msgid "Reset Metrics"
msgstr "Metriken zuruecksetzen"
#: src/Admin/Settings.php #: src/Admin/Settings.php
msgid "Prometheus Configuration" msgid "Prometheus Configuration"
msgstr "Prometheus-Konfiguration" msgstr "Prometheus-Konfiguration"
@@ -329,14 +349,252 @@ msgstr "WooCommerce-Umsatz nach Zeitraum"
msgid "WooCommerce customers by type" msgid "WooCommerce customers by type"
msgstr "WooCommerce-Kunden nach Typ" msgstr "WooCommerce-Kunden nach Typ"
#: src/Admin/Settings.php
msgid "Custom Metrics"
msgstr "Benutzerdefinierte Metriken"
#: src/Admin/Settings.php #: src/Admin/Settings.php
msgid "You can add custom metrics using the wp_prometheus_collect_metrics action:" msgid "You can add custom metrics using the wp_prometheus_collect_metrics action:"
msgstr "Sie koennen benutzerdefinierte Metriken mit der wp_prometheus_collect_metrics-Aktion hinzufuegen:" msgstr "Sie koennen benutzerdefinierte Metriken mit der wp_prometheus_collect_metrics-Aktion hinzufuegen:"
#: src/Admin/Settings.php
msgid "Add Custom Metric"
msgstr "Eigene Metrik hinzufuegen"
#: src/Admin/Settings.php
msgid "Edit Custom Metric"
msgstr "Eigene Metrik bearbeiten"
#: src/Admin/Settings.php
msgid "Metric Name"
msgstr "Metrik-Name"
#: src/Admin/Settings.php
msgid "Must follow Prometheus naming conventions."
msgstr "Muss den Prometheus-Namenskonventionen entsprechen."
#: src/Admin/Settings.php
msgid "Help Text"
msgstr "Hilfetext"
#: src/Admin/Settings.php
msgid "Description shown in Prometheus output."
msgstr "Beschreibung in der Prometheus-Ausgabe."
#: src/Admin/Settings.php
msgid "Value Type"
msgstr "Werttyp"
#: src/Admin/Settings.php
msgid "Static Value"
msgstr "Statischer Wert"
#: src/Admin/Settings.php
msgid "WordPress Option"
msgstr "WordPress-Option"
#: src/Admin/Settings.php
msgid "Static Value:"
msgstr "Statischer Wert:"
#: src/Admin/Settings.php
msgid "Option Name:"
msgstr "Optionsname:"
#: src/Admin/Settings.php
msgid "The name of the WordPress option to read."
msgstr "Der Name der zu lesenden WordPress-Option."
#: src/Admin/Settings.php
msgid "Labels"
msgstr "Labels"
#: src/Admin/Settings.php
msgid "Label name"
msgstr "Label-Name"
#: src/Admin/Settings.php
msgid "Add Label"
msgstr "Label hinzufuegen"
#: src/Admin/Settings.php
msgid "Label Values"
msgstr "Label-Werte"
#: src/Admin/Settings.php
msgid "Value"
msgstr "Wert"
#: src/Admin/Settings.php
msgid "Add Value Row"
msgstr "Wertezeile hinzufuegen"
#: src/Admin/Settings.php
msgid "Enabled"
msgstr "Aktiviert"
#: src/Admin/Settings.php
msgid "Save Metric"
msgstr "Metrik speichern"
#: src/Admin/Settings.php
msgid "Cancel"
msgstr "Abbrechen"
#: src/Admin/Settings.php
msgid "Your Custom Metrics"
msgstr "Ihre eigenen Metriken"
#: src/Admin/Settings.php
msgid "Name"
msgstr "Name"
#: src/Admin/Settings.php
msgid "Status"
msgstr "Status"
#: src/Admin/Settings.php
msgid "Actions"
msgstr "Aktionen"
#: src/Admin/Settings.php
msgid "Active"
msgstr "Aktiv"
#: src/Admin/Settings.php
msgid "Inactive"
msgstr "Inaktiv"
#: src/Admin/Settings.php
msgid "Edit"
msgstr "Bearbeiten"
#: src/Admin/Settings.php
msgid "Delete"
msgstr "Loeschen"
#: src/Admin/Settings.php
msgid "No custom metrics defined yet."
msgstr "Noch keine eigenen Metriken definiert."
#: src/Admin/Settings.php
msgid "Export / Import"
msgstr "Export / Import"
#: src/Admin/Settings.php
msgid "Export your custom metrics configuration for backup or transfer to another site."
msgstr "Exportieren Sie Ihre Metriken-Konfiguration zur Sicherung oder Uebertragung auf eine andere Website."
#: src/Admin/Settings.php
msgid "Export Metrics"
msgstr "Metriken exportieren"
#: src/Admin/Settings.php
msgid "Import Metrics"
msgstr "Metriken importieren"
#: src/Admin/Settings.php
msgid "Import Options"
msgstr "Import-Optionen"
#: src/Admin/Settings.php
msgid "Skip existing metrics"
msgstr "Bestehende Metriken ueberspringen"
#: src/Admin/Settings.php
msgid "Overwrite existing metrics"
msgstr "Bestehende Metriken ueberschreiben"
#: src/Admin/Settings.php
msgid "Rename duplicates"
msgstr "Duplikate umbenennen"
#: src/Admin/Settings.php
msgid "Import"
msgstr "Importieren"
#: src/Admin/Settings.php
msgid "Grafana Dashboard Templates"
msgstr "Grafana Dashboard-Vorlagen"
#: src/Admin/Settings.php
msgid "Download pre-built Grafana dashboards for visualizing your WordPress metrics."
msgstr "Laden Sie vorgefertigte Grafana-Dashboards zur Visualisierung Ihrer WordPress-Metriken herunter."
#: src/Admin/Settings.php
msgid "Download"
msgstr "Herunterladen"
#: src/Admin/Settings.php
msgid "Import instructions:"
msgstr "Import-Anleitung:"
#: src/Admin/Settings.php
msgid "Download the desired dashboard JSON file"
msgstr "Laden Sie die gewuenschte Dashboard-JSON-Datei herunter"
#: src/Admin/Settings.php
msgid "In Grafana, go to Dashboards > Import"
msgstr "Gehen Sie in Grafana zu Dashboards > Import"
#: src/Admin/Settings.php
msgid "Upload the JSON file or paste its contents"
msgstr "Laden Sie die JSON-Datei hoch oder fuegen Sie deren Inhalt ein"
#: src/Admin/Settings.php
msgid "Select your Prometheus data source"
msgstr "Waehlen Sie Ihre Prometheus-Datenquelle"
#: src/Admin/Settings.php
msgid "Click Import"
msgstr "Klicken Sie auf Import"
#: src/Metrics/CustomMetricBuilder.php
msgid "Metric name is required."
msgstr "Metrik-Name ist erforderlich."
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid metric name format."
msgstr "Ungueltiges Metrik-Namensformat."
#: src/Metrics/CustomMetricBuilder.php
msgid "A metric with this name already exists."
msgstr "Eine Metrik mit diesem Namen existiert bereits."
#: src/Metrics/CustomMetricBuilder.php
msgid "Help text is required."
msgstr "Hilfetext ist erforderlich."
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid value type."
msgstr "Ungueltiger Werttyp."
#: src/Metrics/CustomMetricBuilder.php
msgid "Static value must be numeric."
msgstr "Statischer Wert muss numerisch sein."
#: src/Metrics/CustomMetricBuilder.php
msgid "Option name is required for option value type."
msgstr "Optionsname ist fuer den Options-Werttyp erforderlich."
#. translators: %d: Maximum number of labels
#: src/Metrics/CustomMetricBuilder.php
msgid "Maximum %d labels allowed."
msgstr "Maximal %d Labels erlaubt."
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid label name format."
msgstr "Ungueltiges Label-Namensformat."
#. translators: %d: Maximum number of label value combinations
#: src/Metrics/CustomMetricBuilder.php
msgid "Maximum %d label value combinations allowed."
msgstr "Maximal %d Label-Wert-Kombinationen erlaubt."
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid JSON format."
msgstr "Ungueltiges JSON-Format."
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid export format."
msgstr "Ungueltiges Export-Format."
#: src/Plugin.php #: src/Plugin.php
msgid "Settings" msgid "Settings"
msgstr "Einstellungen" msgstr "Einstellungen"

View File

@@ -2,7 +2,7 @@
# This file is distributed under the GPL v2 or later. # This file is distributed under the GPL v2 or later.
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: WP Prometheus 0.2.0\n" "Project-Id-Version: WP Prometheus 0.3.0\n"
"Report-Msgid-Bugs-To: https://src.bundespruefstelle.ch/magdev/wp-prometheus/issues\n" "Report-Msgid-Bugs-To: https://src.bundespruefstelle.ch/magdev/wp-prometheus/issues\n"
"POT-Creation-Date: 2026-02-02T00:00:00+00:00\n" "POT-Creation-Date: 2026-02-02T00:00:00+00:00\n"
"MIME-Version: 1.0\n" "MIME-Version: 1.0\n"
@@ -28,6 +28,14 @@ msgstr ""
msgid "Help" msgid "Help"
msgstr "" msgstr ""
#: src/Admin/Settings.php
msgid "Custom Metrics"
msgstr ""
#: src/Admin/Settings.php
msgid "Dashboards"
msgstr ""
#: src/Admin/Settings.php #: src/Admin/Settings.php
msgid "License settings saved." msgid "License settings saved."
msgstr "" msgstr ""
@@ -210,6 +218,18 @@ msgstr ""
msgid "WooCommerce Customers (registered, guest)" msgid "WooCommerce Customers (registered, guest)"
msgstr "" msgstr ""
#: src/Admin/Settings.php
msgid "Reset Runtime Metrics"
msgstr ""
#: src/Admin/Settings.php
msgid "Clear all accumulated runtime metric data."
msgstr ""
#: src/Admin/Settings.php
msgid "Reset Metrics"
msgstr ""
#: src/Admin/Settings.php #: src/Admin/Settings.php
msgid "Prometheus Configuration" msgid "Prometheus Configuration"
msgstr "" msgstr ""
@@ -327,11 +347,249 @@ msgid "WooCommerce customers by type"
msgstr "" msgstr ""
#: src/Admin/Settings.php #: src/Admin/Settings.php
msgid "Custom Metrics" msgid "You can add custom metrics using the wp_prometheus_collect_metrics action:"
msgstr "" msgstr ""
#: src/Admin/Settings.php #: src/Admin/Settings.php
msgid "You can add custom metrics using the wp_prometheus_collect_metrics action:" msgid "Add Custom Metric"
msgstr ""
#: src/Admin/Settings.php
msgid "Edit Custom Metric"
msgstr ""
#: src/Admin/Settings.php
msgid "Metric Name"
msgstr ""
#: src/Admin/Settings.php
msgid "Must follow Prometheus naming conventions."
msgstr ""
#: src/Admin/Settings.php
msgid "Help Text"
msgstr ""
#: src/Admin/Settings.php
msgid "Description shown in Prometheus output."
msgstr ""
#: src/Admin/Settings.php
msgid "Value Type"
msgstr ""
#: src/Admin/Settings.php
msgid "Static Value"
msgstr ""
#: src/Admin/Settings.php
msgid "WordPress Option"
msgstr ""
#: src/Admin/Settings.php
msgid "Static Value:"
msgstr ""
#: src/Admin/Settings.php
msgid "Option Name:"
msgstr ""
#: src/Admin/Settings.php
msgid "The name of the WordPress option to read."
msgstr ""
#: src/Admin/Settings.php
msgid "Labels"
msgstr ""
#: src/Admin/Settings.php
msgid "Label name"
msgstr ""
#: src/Admin/Settings.php
msgid "Add Label"
msgstr ""
#: src/Admin/Settings.php
msgid "Label Values"
msgstr ""
#: src/Admin/Settings.php
msgid "Value"
msgstr ""
#: src/Admin/Settings.php
msgid "Add Value Row"
msgstr ""
#: src/Admin/Settings.php
msgid "Enabled"
msgstr ""
#: src/Admin/Settings.php
msgid "Save Metric"
msgstr ""
#: src/Admin/Settings.php
msgid "Cancel"
msgstr ""
#: src/Admin/Settings.php
msgid "Your Custom Metrics"
msgstr ""
#: src/Admin/Settings.php
msgid "Name"
msgstr ""
#: src/Admin/Settings.php
msgid "Status"
msgstr ""
#: src/Admin/Settings.php
msgid "Actions"
msgstr ""
#: src/Admin/Settings.php
msgid "Active"
msgstr ""
#: src/Admin/Settings.php
msgid "Inactive"
msgstr ""
#: src/Admin/Settings.php
msgid "Edit"
msgstr ""
#: src/Admin/Settings.php
msgid "Delete"
msgstr ""
#: src/Admin/Settings.php
msgid "No custom metrics defined yet."
msgstr ""
#: src/Admin/Settings.php
msgid "Export / Import"
msgstr ""
#: src/Admin/Settings.php
msgid "Export your custom metrics configuration for backup or transfer to another site."
msgstr ""
#: src/Admin/Settings.php
msgid "Export Metrics"
msgstr ""
#: src/Admin/Settings.php
msgid "Import Metrics"
msgstr ""
#: src/Admin/Settings.php
msgid "Import Options"
msgstr ""
#: src/Admin/Settings.php
msgid "Skip existing metrics"
msgstr ""
#: src/Admin/Settings.php
msgid "Overwrite existing metrics"
msgstr ""
#: src/Admin/Settings.php
msgid "Rename duplicates"
msgstr ""
#: src/Admin/Settings.php
msgid "Import"
msgstr ""
#: src/Admin/Settings.php
msgid "Grafana Dashboard Templates"
msgstr ""
#: src/Admin/Settings.php
msgid "Download pre-built Grafana dashboards for visualizing your WordPress metrics."
msgstr ""
#: src/Admin/Settings.php
msgid "Download"
msgstr ""
#: src/Admin/Settings.php
msgid "Import instructions:"
msgstr ""
#: src/Admin/Settings.php
msgid "Download the desired dashboard JSON file"
msgstr ""
#: src/Admin/Settings.php
msgid "In Grafana, go to Dashboards > Import"
msgstr ""
#: src/Admin/Settings.php
msgid "Upload the JSON file or paste its contents"
msgstr ""
#: src/Admin/Settings.php
msgid "Select your Prometheus data source"
msgstr ""
#: src/Admin/Settings.php
msgid "Click Import"
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Metric name is required."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid metric name format."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "A metric with this name already exists."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Help text is required."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid value type."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Static value must be numeric."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Option name is required for option value type."
msgstr ""
#. translators: %d: Maximum number of labels
#: src/Metrics/CustomMetricBuilder.php
msgid "Maximum %d labels allowed."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid label name format."
msgstr ""
#. translators: %d: Maximum number of label value combinations
#: src/Metrics/CustomMetricBuilder.php
msgid "Maximum %d label value combinations allowed."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid JSON format."
msgstr ""
#: src/Metrics/CustomMetricBuilder.php
msgid "Invalid export format."
msgstr "" msgstr ""
#: src/Plugin.php #: src/Plugin.php

View File

@@ -0,0 +1,151 @@
<?php
/**
* Dashboard provider class.
*
* @package WP_Prometheus
*/
namespace Magdev\WpPrometheus\Admin;
// Prevent direct file access.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* DashboardProvider class.
*
* Provides Grafana dashboard templates for download.
*/
class DashboardProvider {
/**
* Dashboard directory path.
*
* @var string
*/
private string $dashboard_dir;
/**
* Available dashboard definitions.
*
* @var array
*/
private array $dashboards = array();
/**
* Constructor.
*/
public function __construct() {
$this->dashboard_dir = WP_PROMETHEUS_PATH . 'assets/dashboards/';
$this->dashboards = array(
'wordpress-overview' => array(
'title' => __( 'WordPress Overview', 'wp-prometheus' ),
'description' => __( 'General WordPress metrics including users, posts, comments, and plugins.', 'wp-prometheus' ),
'file' => 'wordpress-overview.json',
'icon' => 'dashicons-wordpress',
),
'wordpress-runtime' => array(
'title' => __( 'Runtime Performance', 'wp-prometheus' ),
'description' => __( 'HTTP request metrics, database query performance, and response times.', 'wp-prometheus' ),
'file' => 'wordpress-runtime.json',
'icon' => 'dashicons-performance',
),
'wordpress-woocommerce' => array(
'title' => __( 'WooCommerce Store', 'wp-prometheus' ),
'description' => __( 'WooCommerce metrics including products, orders, revenue, and customers.', 'wp-prometheus' ),
'file' => 'wordpress-woocommerce.json',
'icon' => 'dashicons-cart',
),
);
}
/**
* Get list of available dashboards.
*
* @return array
*/
public function get_available(): array {
$available = array();
foreach ( $this->dashboards as $slug => $dashboard ) {
$file_path = $this->dashboard_dir . $dashboard['file'];
if ( file_exists( $file_path ) ) {
$available[ $slug ] = $dashboard;
}
}
return $available;
}
/**
* Get dashboard content by slug.
*
* @param string $slug Dashboard slug.
* @return string|null JSON content or null if not found.
*/
public function get_dashboard( string $slug ): ?string {
// Validate slug to prevent directory traversal.
$slug = sanitize_file_name( $slug );
if ( ! isset( $this->dashboards[ $slug ] ) ) {
return null;
}
$file_path = $this->dashboard_dir . $this->dashboards[ $slug ]['file'];
// Security: Ensure file is within dashboard directory.
$real_path = realpath( $file_path );
$real_dir = realpath( $this->dashboard_dir );
if ( false === $real_path || false === $real_dir || strpos( $real_path, $real_dir ) !== 0 ) {
return null;
}
if ( ! file_exists( $file_path ) || ! is_readable( $file_path ) ) {
return null;
}
// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
$content = file_get_contents( $file_path );
if ( false === $content ) {
return null;
}
return $content;
}
/**
* Get dashboard metadata by slug.
*
* @param string $slug Dashboard slug.
* @return array|null Dashboard metadata or null if not found.
*/
public function get_metadata( string $slug ): ?array {
$slug = sanitize_file_name( $slug );
if ( ! isset( $this->dashboards[ $slug ] ) ) {
return null;
}
return $this->dashboards[ $slug ];
}
/**
* Get filename for download.
*
* @param string $slug Dashboard slug.
* @return string|null Filename or null if not found.
*/
public function get_filename( string $slug ): ?string {
$slug = sanitize_file_name( $slug );
if ( ! isset( $this->dashboards[ $slug ] ) ) {
return null;
}
return $this->dashboards[ $slug ]['file'];
}
}

View File

@@ -8,6 +8,8 @@
namespace Magdev\WpPrometheus\Admin; namespace Magdev\WpPrometheus\Admin;
use Magdev\WpPrometheus\License\Manager as LicenseManager; use Magdev\WpPrometheus\License\Manager as LicenseManager;
use Magdev\WpPrometheus\Metrics\CustomMetricBuilder;
use Magdev\WpPrometheus\Metrics\RuntimeCollector;
// Prevent direct file access. // Prevent direct file access.
if ( ! defined( 'ABSPATH' ) ) { if ( ! defined( 'ABSPATH' ) ) {
@@ -28,6 +30,20 @@ class Settings {
*/ */
private array $tabs = array(); private array $tabs = array();
/**
* Custom metric builder instance.
*
* @var CustomMetricBuilder
*/
private CustomMetricBuilder $metric_builder;
/**
* Dashboard provider instance.
*
* @var DashboardProvider
*/
private DashboardProvider $dashboard_provider;
/** /**
* Constructor. * Constructor.
*/ */
@@ -35,12 +51,25 @@ class Settings {
$this->tabs = array( $this->tabs = array(
'license' => __( 'License', 'wp-prometheus' ), 'license' => __( 'License', 'wp-prometheus' ),
'metrics' => __( 'Metrics', 'wp-prometheus' ), 'metrics' => __( 'Metrics', 'wp-prometheus' ),
'custom' => __( 'Custom Metrics', 'wp-prometheus' ),
'dashboards' => __( 'Dashboards', 'wp-prometheus' ),
'help' => __( 'Help', 'wp-prometheus' ), 'help' => __( 'Help', 'wp-prometheus' ),
); );
$this->metric_builder = new CustomMetricBuilder();
$this->dashboard_provider = new DashboardProvider();
add_action( 'admin_menu', array( $this, 'add_settings_page' ) ); add_action( 'admin_menu', array( $this, 'add_settings_page' ) );
add_action( 'admin_init', array( $this, 'register_settings' ) ); add_action( 'admin_init', array( $this, 'register_settings' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) ); add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
// AJAX handlers.
add_action( 'wp_ajax_wp_prometheus_save_custom_metric', array( $this, 'ajax_save_custom_metric' ) );
add_action( 'wp_ajax_wp_prometheus_delete_custom_metric', array( $this, 'ajax_delete_custom_metric' ) );
add_action( 'wp_ajax_wp_prometheus_export_metrics', array( $this, 'ajax_export_metrics' ) );
add_action( 'wp_ajax_wp_prometheus_import_metrics', array( $this, 'ajax_import_metrics' ) );
add_action( 'wp_ajax_wp_prometheus_download_dashboard', array( $this, 'ajax_download_dashboard' ) );
add_action( 'wp_ajax_wp_prometheus_reset_runtime_metrics', array( $this, 'ajax_reset_runtime_metrics' ) );
} }
/** /**
@@ -149,6 +178,14 @@ class Settings {
wp_localize_script( 'wp-prometheus-admin', 'wpPrometheus', array( wp_localize_script( 'wp-prometheus-admin', 'wpPrometheus', array(
'ajaxUrl' => admin_url( 'admin-ajax.php' ), 'ajaxUrl' => admin_url( 'admin-ajax.php' ),
'nonce' => wp_create_nonce( 'wp_prometheus_license_action' ), 'nonce' => wp_create_nonce( 'wp_prometheus_license_action' ),
'customMetricNonce' => wp_create_nonce( 'wp_prometheus_custom_metric' ),
'exportNonce' => wp_create_nonce( 'wp_prometheus_export' ),
'importNonce' => wp_create_nonce( 'wp_prometheus_import' ),
'dashboardNonce' => wp_create_nonce( 'wp_prometheus_dashboard' ),
'resetRuntimeNonce' => wp_create_nonce( 'wp_prometheus_reset_runtime' ),
'confirmDelete' => __( 'Are you sure you want to delete this metric?', 'wp-prometheus' ),
'confirmReset' => __( 'Are you sure you want to reset all runtime metrics? This cannot be undone.', 'wp-prometheus' ),
'confirmRegenerateToken' => __( 'Are you sure you want to regenerate the auth token? You will need to update your Prometheus configuration.', 'wp-prometheus' ),
) ); ) );
} }
@@ -189,6 +226,12 @@ class Settings {
case 'metrics': case 'metrics':
$this->render_metrics_tab(); $this->render_metrics_tab();
break; break;
case 'custom':
$this->render_custom_metrics_tab();
break;
case 'dashboards':
$this->render_dashboards_tab();
break;
case 'help': case 'help':
$this->render_help_tab(); $this->render_help_tab();
break; break;
@@ -357,6 +400,335 @@ class Settings {
submit_button(); submit_button();
?> ?>
</form> </form>
<hr style="margin: 30px 0;">
<h3><?php esc_html_e( 'Reset Runtime Metrics', 'wp-prometheus' ); ?></h3>
<p class="description"><?php esc_html_e( 'Clear all accumulated runtime metric data (HTTP requests, database queries). This is useful for testing or starting fresh.', 'wp-prometheus' ); ?></p>
<p>
<button type="button" id="wp-prometheus-reset-runtime" class="button button-secondary">
<?php esc_html_e( 'Reset Runtime Metrics', 'wp-prometheus' ); ?>
</button>
<span id="wp-prometheus-reset-spinner" class="spinner" style="float: none;"></span>
</p>
<div id="wp-prometheus-reset-message" style="display: none; margin-top: 10px;"></div>
<?php
}
/**
* Render custom metrics tab content.
*
* @return void
*/
private function render_custom_metrics_tab(): void {
$metrics = $this->metric_builder->get_all();
$editing = isset( $_GET['edit'] ) ? sanitize_key( $_GET['edit'] ) : '';
$edit_metric = $editing ? $this->metric_builder->get( $editing ) : null;
?>
<div class="wp-prometheus-custom-metrics">
<h2><?php esc_html_e( 'Custom Metrics', 'wp-prometheus' ); ?></h2>
<p class="description"><?php esc_html_e( 'Define custom gauge metrics to expose on the /metrics endpoint. For counters and histograms, use the PHP hook.', 'wp-prometheus' ); ?></p>
<div id="wp-prometheus-metric-form-container" class="wp-prometheus-metric-form" style="<?php echo $edit_metric ? '' : 'display: none;'; ?>">
<h3 id="wp-prometheus-form-title"><?php echo $edit_metric ? esc_html__( 'Edit Metric', 'wp-prometheus' ) : esc_html__( 'Add New Metric', 'wp-prometheus' ); ?></h3>
<form id="wp-prometheus-metric-form">
<input type="hidden" id="metric-id" name="id" value="<?php echo esc_attr( $edit_metric['id'] ?? '' ); ?>">
<table class="form-table" role="presentation">
<tr>
<th scope="row">
<label for="metric-name"><?php esc_html_e( 'Metric Name', 'wp-prometheus' ); ?> <span class="required">*</span></label>
</th>
<td>
<input type="text" id="metric-name" name="name" class="regular-text"
value="<?php echo esc_attr( $edit_metric['name'] ?? '' ); ?>"
pattern="[a-zA-Z_:][a-zA-Z0-9_:]*" required>
<p class="description"><?php esc_html_e( 'Must start with a letter, underscore, or colon. Only letters, numbers, underscores, and colons allowed.', 'wp-prometheus' ); ?></p>
</td>
</tr>
<tr>
<th scope="row">
<label for="metric-help"><?php esc_html_e( 'Help Text', 'wp-prometheus' ); ?> <span class="required">*</span></label>
</th>
<td>
<input type="text" id="metric-help" name="help" class="large-text"
value="<?php echo esc_attr( $edit_metric['help'] ?? '' ); ?>" required>
<p class="description"><?php esc_html_e( 'Description of what this metric measures.', 'wp-prometheus' ); ?></p>
</td>
</tr>
<tr>
<th scope="row">
<label><?php esc_html_e( 'Labels', 'wp-prometheus' ); ?></label>
</th>
<td>
<div id="metric-labels-container">
<?php
$labels = $edit_metric['labels'] ?? array();
if ( empty( $labels ) ) {
?>
<div class="metric-label-row">
<input type="text" name="labels[]" class="regular-text" placeholder="<?php esc_attr_e( 'label_name', 'wp-prometheus' ); ?>" pattern="[a-zA-Z_][a-zA-Z0-9_]*">
<button type="button" class="button remove-label">&times;</button>
</div>
<?php
} else {
foreach ( $labels as $label ) {
?>
<div class="metric-label-row">
<input type="text" name="labels[]" class="regular-text" value="<?php echo esc_attr( $label ); ?>" pattern="[a-zA-Z_][a-zA-Z0-9_]*">
<button type="button" class="button remove-label">&times;</button>
</div>
<?php
}
}
?>
</div>
<button type="button" id="add-label" class="button button-secondary"><?php esc_html_e( '+ Add Label', 'wp-prometheus' ); ?></button>
<p class="description"><?php esc_html_e( 'Optional. Maximum 5 labels per metric.', 'wp-prometheus' ); ?></p>
</td>
</tr>
<tr>
<th scope="row">
<label><?php esc_html_e( 'Value Source', 'wp-prometheus' ); ?></label>
</th>
<td>
<fieldset>
<label>
<input type="radio" name="value_type" value="static" <?php checked( ( $edit_metric['value_type'] ?? 'static' ), 'static' ); ?>>
<?php esc_html_e( 'Static Value', 'wp-prometheus' ); ?>
</label>
<br>
<label>
<input type="radio" name="value_type" value="option" <?php checked( ( $edit_metric['value_type'] ?? '' ), 'option' ); ?>>
<?php esc_html_e( 'WordPress Option', 'wp-prometheus' ); ?>
</label>
</fieldset>
</td>
</tr>
<tr id="option-config-row" style="<?php echo ( $edit_metric['value_type'] ?? 'static' ) === 'option' ? '' : 'display: none;'; ?>">
<th scope="row">
<label for="option-name"><?php esc_html_e( 'Option Name', 'wp-prometheus' ); ?></label>
</th>
<td>
<input type="text" id="option-name" name="option_name" class="regular-text"
value="<?php echo esc_attr( $edit_metric['value_config']['option_name'] ?? '' ); ?>">
<input type="number" id="option-default" name="option_default" class="small-text" step="any"
value="<?php echo esc_attr( $edit_metric['value_config']['default'] ?? 0 ); ?>"
placeholder="<?php esc_attr_e( 'Default', 'wp-prometheus' ); ?>">
<p class="description"><?php esc_html_e( 'The WordPress option name to read the value from.', 'wp-prometheus' ); ?></p>
</td>
</tr>
<tr id="static-values-row" style="<?php echo ( $edit_metric['value_type'] ?? 'static' ) === 'static' ? '' : 'display: none;'; ?>">
<th scope="row">
<label><?php esc_html_e( 'Values', 'wp-prometheus' ); ?></label>
</th>
<td>
<div id="metric-values-container">
<?php
$label_values = $edit_metric['label_values'] ?? array();
$label_count = count( $labels );
if ( empty( $label_values ) ) {
?>
<div class="metric-value-row">
<?php if ( $label_count > 0 ) : ?>
<?php for ( $i = 0; $i < $label_count; $i++ ) : ?>
<input type="text" name="label_values[0][]" class="small-text" placeholder="<?php echo esc_attr( $labels[ $i ] ?? 'value' ); ?>">
<?php endfor; ?>
<?php endif; ?>
<input type="number" name="label_values[0][]" class="small-text" step="any" placeholder="<?php esc_attr_e( 'Value', 'wp-prometheus' ); ?>">
<button type="button" class="button remove-value-row">&times;</button>
</div>
<?php
} else {
foreach ( $label_values as $row_index => $row ) {
?>
<div class="metric-value-row">
<?php foreach ( $row as $col_index => $value ) : ?>
<?php if ( $col_index < $label_count ) : ?>
<input type="text" name="label_values[<?php echo esc_attr( $row_index ); ?>][]" class="small-text" value="<?php echo esc_attr( $value ); ?>" placeholder="<?php echo esc_attr( $labels[ $col_index ] ?? 'value' ); ?>">
<?php else : ?>
<input type="number" name="label_values[<?php echo esc_attr( $row_index ); ?>][]" class="small-text" step="any" value="<?php echo esc_attr( $value ); ?>" placeholder="<?php esc_attr_e( 'Value', 'wp-prometheus' ); ?>">
<?php endif; ?>
<?php endforeach; ?>
<button type="button" class="button remove-value-row">&times;</button>
</div>
<?php
}
}
?>
</div>
<button type="button" id="add-value-row" class="button button-secondary"><?php esc_html_e( '+ Add Row', 'wp-prometheus' ); ?></button>
<p class="description"><?php esc_html_e( 'Enter label values and the metric value for each combination.', 'wp-prometheus' ); ?></p>
</td>
</tr>
<tr>
<th scope="row">
<label for="metric-enabled"><?php esc_html_e( 'Enabled', 'wp-prometheus' ); ?></label>
</th>
<td>
<label>
<input type="checkbox" id="metric-enabled" name="enabled" value="1" <?php checked( $edit_metric['enabled'] ?? true ); ?>>
<?php esc_html_e( 'Enable this metric', 'wp-prometheus' ); ?>
</label>
</td>
</tr>
</table>
<p class="submit">
<button type="submit" class="button button-primary"><?php esc_html_e( 'Save Metric', 'wp-prometheus' ); ?></button>
<button type="button" id="cancel-metric-form" class="button"><?php esc_html_e( 'Cancel', 'wp-prometheus' ); ?></button>
<span id="wp-prometheus-metric-spinner" class="spinner" style="float: none;"></span>
</p>
</form>
<div id="wp-prometheus-metric-message" style="display: none; margin-top: 10px;"></div>
</div>
<p>
<button type="button" id="show-metric-form" class="button button-primary" style="<?php echo $edit_metric ? 'display: none;' : ''; ?>">
<?php esc_html_e( '+ Add New Metric', 'wp-prometheus' ); ?>
</button>
</p>
<h3><?php esc_html_e( 'Your Custom Metrics', 'wp-prometheus' ); ?></h3>
<?php if ( empty( $metrics ) ) : ?>
<p class="description"><?php esc_html_e( 'No custom metrics defined yet.', 'wp-prometheus' ); ?></p>
<?php else : ?>
<table class="wp-list-table widefat fixed striped">
<thead>
<tr>
<th><?php esc_html_e( 'Name', 'wp-prometheus' ); ?></th>
<th><?php esc_html_e( 'Help', 'wp-prometheus' ); ?></th>
<th><?php esc_html_e( 'Labels', 'wp-prometheus' ); ?></th>
<th><?php esc_html_e( 'Value Type', 'wp-prometheus' ); ?></th>
<th><?php esc_html_e( 'Status', 'wp-prometheus' ); ?></th>
<th><?php esc_html_e( 'Actions', 'wp-prometheus' ); ?></th>
</tr>
</thead>
<tbody>
<?php foreach ( $metrics as $metric ) : ?>
<tr data-metric-id="<?php echo esc_attr( $metric['id'] ); ?>">
<td><code><?php echo esc_html( $metric['name'] ); ?></code></td>
<td><?php echo esc_html( $metric['help'] ); ?></td>
<td><?php echo ! empty( $metric['labels'] ) ? esc_html( implode( ', ', $metric['labels'] ) ) : '—'; ?></td>
<td><?php echo esc_html( ucfirst( $metric['value_type'] ) ); ?></td>
<td>
<?php if ( $metric['enabled'] ) : ?>
<span class="dashicons dashicons-yes-alt" style="color: green;" title="<?php esc_attr_e( 'Enabled', 'wp-prometheus' ); ?>"></span>
<?php else : ?>
<span class="dashicons dashicons-dismiss" style="color: gray;" title="<?php esc_attr_e( 'Disabled', 'wp-prometheus' ); ?>"></span>
<?php endif; ?>
</td>
<td>
<a href="<?php echo esc_url( add_query_arg( array( 'page' => 'wp-prometheus', 'tab' => 'custom', 'edit' => $metric['id'] ), admin_url( 'options-general.php' ) ) ); ?>" class="button button-small">
<?php esc_html_e( 'Edit', 'wp-prometheus' ); ?>
</a>
<button type="button" class="button button-small delete-metric" data-id="<?php echo esc_attr( $metric['id'] ); ?>">
<?php esc_html_e( 'Delete', 'wp-prometheus' ); ?>
</button>
</td>
</tr>
<?php endforeach; ?>
</tbody>
</table>
<?php endif; ?>
<hr style="margin: 30px 0;">
<h3><?php esc_html_e( 'Import / Export', 'wp-prometheus' ); ?></h3>
<p class="description"><?php esc_html_e( 'Export your custom metrics to a JSON file for backup or to import on another site.', 'wp-prometheus' ); ?></p>
<p>
<button type="button" id="export-metrics" class="button button-secondary" <?php disabled( empty( $metrics ) ); ?>>
<?php esc_html_e( 'Export All Metrics', 'wp-prometheus' ); ?>
</button>
<button type="button" id="import-metrics-btn" class="button button-secondary">
<?php esc_html_e( 'Import Metrics', 'wp-prometheus' ); ?>
</button>
<input type="file" id="import-metrics-file" accept=".json" style="display: none;">
</p>
<div id="import-options" style="display: none; margin-top: 15px; padding: 15px; background: #f9f9f9; border: 1px solid #ddd;">
<p><strong><?php esc_html_e( 'Import Mode:', 'wp-prometheus' ); ?></strong></p>
<label>
<input type="radio" name="import_mode" value="skip" checked>
<?php esc_html_e( 'Skip existing (keep current metrics with same name)', 'wp-prometheus' ); ?>
</label>
<br>
<label>
<input type="radio" name="import_mode" value="overwrite">
<?php esc_html_e( 'Overwrite existing (replace metrics with same name)', 'wp-prometheus' ); ?>
</label>
<br>
<label>
<input type="radio" name="import_mode" value="rename">
<?php esc_html_e( 'Rename duplicates (add suffix to imported metrics)', 'wp-prometheus' ); ?>
</label>
<p style="margin-top: 15px;">
<button type="button" id="confirm-import" class="button button-primary"><?php esc_html_e( 'Import', 'wp-prometheus' ); ?></button>
<button type="button" id="cancel-import" class="button"><?php esc_html_e( 'Cancel', 'wp-prometheus' ); ?></button>
<span id="wp-prometheus-import-spinner" class="spinner" style="float: none;"></span>
</p>
</div>
<div id="wp-prometheus-import-message" style="display: none; margin-top: 10px;"></div>
</div>
<?php
}
/**
* Render dashboards tab content.
*
* @return void
*/
private function render_dashboards_tab(): void {
$dashboards = $this->dashboard_provider->get_available();
?>
<div class="wp-prometheus-dashboards">
<h2><?php esc_html_e( 'Grafana Dashboard Templates', 'wp-prometheus' ); ?></h2>
<p class="description"><?php esc_html_e( 'Pre-built dashboards for visualizing your WordPress metrics in Grafana.', 'wp-prometheus' ); ?></p>
<div class="wp-prometheus-dashboard-grid">
<?php foreach ( $dashboards as $slug => $dashboard ) : ?>
<div class="wp-prometheus-dashboard-card">
<div class="dashboard-icon">
<span class="dashicons <?php echo esc_attr( $dashboard['icon'] ); ?>"></span>
</div>
<h3><?php echo esc_html( $dashboard['title'] ); ?></h3>
<p><?php echo esc_html( $dashboard['description'] ); ?></p>
<button type="button" class="button button-primary download-dashboard" data-slug="<?php echo esc_attr( $slug ); ?>">
<?php esc_html_e( 'Download', 'wp-prometheus' ); ?>
</button>
</div>
<?php endforeach; ?>
</div>
<hr style="margin: 30px 0;">
<h3><?php esc_html_e( 'Installation Instructions', 'wp-prometheus' ); ?></h3>
<ol>
<li><?php esc_html_e( 'Download the JSON file for your desired dashboard.', 'wp-prometheus' ); ?></li>
<li><?php esc_html_e( 'In Grafana, go to Dashboards → Import.', 'wp-prometheus' ); ?></li>
<li><?php esc_html_e( 'Upload the JSON file or paste its contents.', 'wp-prometheus' ); ?></li>
<li><?php esc_html_e( 'Select your Prometheus data source when prompted.', 'wp-prometheus' ); ?></li>
<li><?php esc_html_e( 'Click Import to create the dashboard.', 'wp-prometheus' ); ?></li>
</ol>
<p class="description">
<?php
printf(
/* translators: %s: Metrics URL */
esc_html__( 'Make sure your Prometheus instance is configured to scrape %s with the correct authentication token.', 'wp-prometheus' ),
'<code>' . esc_html( home_url( '/metrics/' ) ) . '</code>'
);
?>
</p>
</div>
<?php <?php
} }
@@ -633,4 +1005,209 @@ class Settings {
return array_map( 'sanitize_text_field', $input ); return array_map( 'sanitize_text_field', $input );
} }
/**
* AJAX handler for saving custom metrics.
*
* @return void
*/
public function ajax_save_custom_metric(): void {
check_ajax_referer( 'wp_prometheus_custom_metric', 'nonce' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error( array( 'message' => __( 'Permission denied.', 'wp-prometheus' ) ) );
}
$metric = array(
'id' => isset( $_POST['id'] ) ? sanitize_key( $_POST['id'] ) : '',
'name' => isset( $_POST['name'] ) ? sanitize_key( $_POST['name'] ) : '',
'help' => isset( $_POST['help'] ) ? sanitize_text_field( wp_unslash( $_POST['help'] ) ) : '',
'type' => 'gauge',
'labels' => array(),
'value_type' => isset( $_POST['value_type'] ) ? sanitize_key( $_POST['value_type'] ) : 'static',
'value_config' => array(),
'label_values' => array(),
'enabled' => ! empty( $_POST['enabled'] ),
);
// Process labels.
if ( ! empty( $_POST['labels'] ) && is_array( $_POST['labels'] ) ) {
foreach ( $_POST['labels'] as $label ) {
$label = sanitize_key( $label );
if ( ! empty( $label ) ) {
$metric['labels'][] = $label;
}
}
}
// Process value config.
if ( 'option' === $metric['value_type'] ) {
$metric['value_config'] = array(
'option_name' => isset( $_POST['option_name'] ) ? sanitize_key( $_POST['option_name'] ) : '',
'default' => isset( $_POST['option_default'] ) ? floatval( $_POST['option_default'] ) : 0,
);
}
// Process label values.
if ( 'static' === $metric['value_type'] && ! empty( $_POST['label_values'] ) && is_array( $_POST['label_values'] ) ) {
foreach ( $_POST['label_values'] as $row ) {
if ( is_array( $row ) ) {
$sanitized_row = array();
foreach ( $row as $index => $value ) {
// Last value is numeric.
if ( $index === count( $row ) - 1 ) {
$sanitized_row[] = floatval( $value );
} else {
$sanitized_row[] = sanitize_text_field( wp_unslash( $value ) );
}
}
if ( ! empty( array_filter( $sanitized_row, function( $v ) { return $v !== '' && $v !== 0.0; } ) ) || end( $sanitized_row ) !== '' ) {
$metric['label_values'][] = $sanitized_row;
}
}
}
}
try {
$id = $this->metric_builder->save( $metric );
wp_send_json_success( array(
'message' => __( 'Metric saved successfully.', 'wp-prometheus' ),
'id' => $id,
) );
} catch ( \InvalidArgumentException $e ) {
wp_send_json_error( array( 'message' => $e->getMessage() ) );
}
}
/**
* AJAX handler for deleting custom metrics.
*
* @return void
*/
public function ajax_delete_custom_metric(): void {
check_ajax_referer( 'wp_prometheus_custom_metric', 'nonce' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error( array( 'message' => __( 'Permission denied.', 'wp-prometheus' ) ) );
}
$id = isset( $_POST['id'] ) ? sanitize_key( $_POST['id'] ) : '';
if ( empty( $id ) ) {
wp_send_json_error( array( 'message' => __( 'Invalid metric ID.', 'wp-prometheus' ) ) );
}
if ( $this->metric_builder->delete( $id ) ) {
wp_send_json_success( array( 'message' => __( 'Metric deleted.', 'wp-prometheus' ) ) );
} else {
wp_send_json_error( array( 'message' => __( 'Metric not found.', 'wp-prometheus' ) ) );
}
}
/**
* AJAX handler for exporting metrics.
*
* @return void
*/
public function ajax_export_metrics(): void {
check_ajax_referer( 'wp_prometheus_export', 'nonce' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error( array( 'message' => __( 'Permission denied.', 'wp-prometheus' ) ) );
}
$json = $this->metric_builder->export();
wp_send_json_success( array(
'json' => $json,
'filename' => 'wp-prometheus-metrics-' . gmdate( 'Y-m-d' ) . '.json',
) );
}
/**
* AJAX handler for importing metrics.
*
* @return void
*/
public function ajax_import_metrics(): void {
check_ajax_referer( 'wp_prometheus_import', 'nonce' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error( array( 'message' => __( 'Permission denied.', 'wp-prometheus' ) ) );
}
$json = isset( $_POST['json'] ) ? wp_unslash( $_POST['json'] ) : '';
$mode = isset( $_POST['mode'] ) ? sanitize_key( $_POST['mode'] ) : 'skip';
if ( empty( $json ) ) {
wp_send_json_error( array( 'message' => __( 'No data provided.', 'wp-prometheus' ) ) );
}
try {
$result = $this->metric_builder->import( $json, $mode );
$message = sprintf(
/* translators: 1: Imported count, 2: Skipped count, 3: Error count */
__( 'Import complete: %1$d imported, %2$d skipped, %3$d errors.', 'wp-prometheus' ),
$result['imported'],
$result['skipped'],
$result['errors']
);
wp_send_json_success( array(
'message' => $message,
'result' => $result,
) );
} catch ( \InvalidArgumentException $e ) {
wp_send_json_error( array( 'message' => $e->getMessage() ) );
}
}
/**
* AJAX handler for downloading dashboards.
*
* @return void
*/
public function ajax_download_dashboard(): void {
check_ajax_referer( 'wp_prometheus_dashboard', 'nonce' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error( array( 'message' => __( 'Permission denied.', 'wp-prometheus' ) ) );
}
$slug = isset( $_POST['slug'] ) ? sanitize_file_name( $_POST['slug'] ) : '';
if ( empty( $slug ) ) {
wp_send_json_error( array( 'message' => __( 'Invalid dashboard.', 'wp-prometheus' ) ) );
}
$content = $this->dashboard_provider->get_dashboard( $slug );
$filename = $this->dashboard_provider->get_filename( $slug );
if ( null === $content || null === $filename ) {
wp_send_json_error( array( 'message' => __( 'Dashboard not found.', 'wp-prometheus' ) ) );
}
wp_send_json_success( array(
'json' => $content,
'filename' => $filename,
) );
}
/**
* AJAX handler for resetting runtime metrics.
*
* @return void
*/
public function ajax_reset_runtime_metrics(): void {
check_ajax_referer( 'wp_prometheus_reset_runtime', 'nonce' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error( array( 'message' => __( 'Permission denied.', 'wp-prometheus' ) ) );
}
RuntimeCollector::reset_metrics();
wp_send_json_success( array( 'message' => __( 'Runtime metrics have been reset.', 'wp-prometheus' ) ) );
}
} }

View File

@@ -64,6 +64,7 @@ final class Installer {
'wp_prometheus_enable_default_metrics', 'wp_prometheus_enable_default_metrics',
'wp_prometheus_enabled_metrics', 'wp_prometheus_enabled_metrics',
'wp_prometheus_runtime_metrics', 'wp_prometheus_runtime_metrics',
'wp_prometheus_custom_metrics',
); );
foreach ( $options as $option ) { foreach ( $options as $option ) {

View File

@@ -302,10 +302,47 @@ final class Manager {
* @return bool * @return bool
*/ */
public static function is_license_valid(): bool { public static function is_license_valid(): bool {
// Bypass license check on localhost for development.
if ( self::is_localhost() ) {
return true;
}
$status = get_option( self::OPTION_LICENSE_STATUS, 'unchecked' ); $status = get_option( self::OPTION_LICENSE_STATUS, 'unchecked' );
return 'valid' === $status; return 'valid' === $status;
} }
/**
* Check if the current site is running on localhost.
*
* @return bool
*/
public static function is_localhost(): bool {
$host = wp_parse_url( home_url(), PHP_URL_HOST );
$localhost_patterns = array(
'localhost',
'127.0.0.1',
'::1',
);
// Check exact matches.
if ( in_array( $host, $localhost_patterns, true ) ) {
return true;
}
// Check .localhost TLD (e.g., mysite.localhost).
if ( str_ends_with( $host, '.localhost' ) ) {
return true;
}
// Check .local TLD (common for local development).
if ( str_ends_with( $host, '.local' ) ) {
return true;
}
return false;
}
/** /**
* Get the license key. * Get the license key.
* *
@@ -396,9 +433,16 @@ final class Manager {
* @return void * @return void
*/ */
private function update_cached_status( string $status, array $data = array() ): void { private function update_cached_status( string $status, array $data = array() ): void {
$previous_status = get_option( self::OPTION_LICENSE_STATUS, 'unchecked' );
update_option( self::OPTION_LICENSE_STATUS, $status ); update_option( self::OPTION_LICENSE_STATUS, $status );
update_option( self::OPTION_LICENSE_DATA, $data ); update_option( self::OPTION_LICENSE_DATA, $data );
update_option( self::OPTION_LAST_CHECK, time() ); update_option( self::OPTION_LAST_CHECK, time() );
// Flush rewrite rules when license becomes valid to register the /metrics endpoint.
if ( 'valid' === $status && 'valid' !== $previous_status ) {
flush_rewrite_rules();
}
} }
/** /**
@@ -465,6 +509,9 @@ final class Manager {
update_option( self::OPTION_LICENSE_DATA, array() ); update_option( self::OPTION_LICENSE_DATA, array() );
delete_transient( self::TRANSIENT_LICENSE_CHECK ); delete_transient( self::TRANSIENT_LICENSE_CHECK );
// Flush rewrite rules to remove the /metrics endpoint.
flush_rewrite_rules();
wp_send_json_success( array( wp_send_json_success( array(
'success' => true, 'success' => true,
'message' => __( 'License deactivated.', 'wp-prometheus' ), 'message' => __( 'License deactivated.', 'wp-prometheus' ),

View File

@@ -10,6 +10,7 @@ namespace Magdev\WpPrometheus\Metrics;
use Prometheus\CollectorRegistry; use Prometheus\CollectorRegistry;
use Prometheus\Storage\InMemory; use Prometheus\Storage\InMemory;
use Prometheus\RenderTextFormat; use Prometheus\RenderTextFormat;
use Magdev\WpPrometheus\Metrics\CustomMetricBuilder;
// Prevent direct file access. // Prevent direct file access.
if ( ! defined( 'ABSPATH' ) ) { if ( ! defined( 'ABSPATH' ) ) {
@@ -113,6 +114,10 @@ class Collector {
// Collect runtime metrics (HTTP requests, DB queries). // Collect runtime metrics (HTTP requests, DB queries).
$this->collect_runtime_metrics( $enabled_metrics ); $this->collect_runtime_metrics( $enabled_metrics );
// Collect custom user-defined metrics.
$custom_builder = new CustomMetricBuilder();
$custom_builder->register_with_collector( $this );
/** /**
* Fires after default metrics are collected. * Fires after default metrics are collected.
* *
@@ -466,11 +471,14 @@ class Collector {
array( 'status' ) array( 'status' )
); );
// Use WooCommerce's built-in order count function. // Get all registered order statuses and count each.
$order_counts = wc_orders_count(); $statuses = wc_get_order_statuses();
foreach ( $order_counts as $status => $count ) { foreach ( array_keys( $statuses ) as $status ) {
$gauge->set( (int) $count, array( $status ) ); // Remove 'wc-' prefix for the label.
$status_label = str_replace( 'wc-', '', $status );
$count = wc_orders_count( $status );
$gauge->set( (int) $count, array( $status_label ) );
} }
} }

View File

@@ -0,0 +1,496 @@
<?php
/**
* Custom metric builder class.
*
* @package WP_Prometheus
*/
namespace Magdev\WpPrometheus\Metrics;
// Prevent direct file access.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* CustomMetricBuilder class.
*
* Manages custom user-defined Prometheus metrics.
*/
class CustomMetricBuilder {
/**
* Option name for storing custom metrics.
*
* @var string
*/
const OPTION_NAME = 'wp_prometheus_custom_metrics';
/**
* Export format version.
*
* @var string
*/
const EXPORT_VERSION = '1.0.0';
/**
* Maximum number of labels per metric.
*
* @var int
*/
const MAX_LABELS = 5;
/**
* Maximum number of label value combinations per metric.
*
* @var int
*/
const MAX_LABEL_VALUES = 50;
/**
* Get all custom metrics.
*
* @return array
*/
public function get_all(): array {
$metrics = get_option( self::OPTION_NAME, array() );
return is_array( $metrics ) ? $metrics : array();
}
/**
* Get a single metric by ID.
*
* @param string $id Metric ID.
* @return array|null
*/
public function get( string $id ): ?array {
$metrics = $this->get_all();
return $metrics[ $id ] ?? null;
}
/**
* Save a metric (create or update).
*
* @param array $metric Metric data.
* @return string Metric ID.
* @throws \InvalidArgumentException If validation fails.
*/
public function save( array $metric ): string {
$errors = $this->validate( $metric );
if ( ! empty( $errors ) ) {
throw new \InvalidArgumentException( implode( ', ', $errors ) );
}
$metrics = $this->get_all();
// Generate ID if not provided.
if ( empty( $metric['id'] ) ) {
$metric['id'] = wp_generate_uuid4();
$metric['created_at'] = time();
}
$metric['updated_at'] = time();
// Sanitize and normalize the metric data.
$metric = $this->sanitize_metric( $metric );
$metrics[ $metric['id'] ] = $metric;
update_option( self::OPTION_NAME, $metrics );
return $metric['id'];
}
/**
* Delete a metric.
*
* @param string $id Metric ID.
* @return bool True if deleted, false if not found.
*/
public function delete( string $id ): bool {
$metrics = $this->get_all();
if ( ! isset( $metrics[ $id ] ) ) {
return false;
}
unset( $metrics[ $id ] );
update_option( self::OPTION_NAME, $metrics );
return true;
}
/**
* Validate a Prometheus metric name.
*
* @param string $name Metric name.
* @return bool True if valid.
*/
public function validate_name( string $name ): bool {
// Prometheus metric names must match: [a-zA-Z_:][a-zA-Z0-9_:]*
return (bool) preg_match( '/^[a-zA-Z_:][a-zA-Z0-9_:]*$/', $name );
}
/**
* Validate a Prometheus label name.
*
* @param string $name Label name.
* @return bool True if valid.
*/
public function validate_label_name( string $name ): bool {
// Prometheus label names must match: [a-zA-Z_][a-zA-Z0-9_]*
// Labels starting with __ are reserved.
if ( strpos( $name, '__' ) === 0 ) {
return false;
}
return (bool) preg_match( '/^[a-zA-Z_][a-zA-Z0-9_]*$/', $name );
}
/**
* Validate a complete metric definition.
*
* @param array $metric Metric data.
* @return array Array of error messages (empty if valid).
*/
public function validate( array $metric ): array {
$errors = array();
// Name is required.
if ( empty( $metric['name'] ) ) {
$errors[] = __( 'Metric name is required.', 'wp-prometheus' );
} elseif ( ! $this->validate_name( $metric['name'] ) ) {
$errors[] = __( 'Metric name must start with a letter, underscore, or colon, and contain only letters, numbers, underscores, and colons.', 'wp-prometheus' );
}
// Check for reserved prefixes.
if ( ! empty( $metric['name'] ) ) {
$reserved_prefixes = array( 'wordpress_', 'go_', 'process_', 'promhttp_' );
foreach ( $reserved_prefixes as $prefix ) {
if ( strpos( $metric['name'], $prefix ) === 0 ) {
$errors[] = sprintf(
/* translators: %s: Reserved prefix */
__( 'Metric name cannot start with reserved prefix "%s".', 'wp-prometheus' ),
$prefix
);
break;
}
}
}
// Check for duplicate names (excluding current metric if editing).
if ( ! empty( $metric['name'] ) ) {
$existing = $this->get_all();
foreach ( $existing as $id => $existing_metric ) {
if ( $existing_metric['name'] === $metric['name'] && ( empty( $metric['id'] ) || $metric['id'] !== $id ) ) {
$errors[] = __( 'A metric with this name already exists.', 'wp-prometheus' );
break;
}
}
}
// Help text is required.
if ( empty( $metric['help'] ) ) {
$errors[] = __( 'Help text is required.', 'wp-prometheus' );
}
// Validate type.
$valid_types = array( 'gauge' );
if ( empty( $metric['type'] ) || ! in_array( $metric['type'], $valid_types, true ) ) {
$errors[] = __( 'Invalid metric type. Only gauge is supported.', 'wp-prometheus' );
}
// Validate labels.
if ( ! empty( $metric['labels'] ) ) {
if ( ! is_array( $metric['labels'] ) ) {
$errors[] = __( 'Labels must be an array.', 'wp-prometheus' );
} elseif ( count( $metric['labels'] ) > self::MAX_LABELS ) {
$errors[] = sprintf(
/* translators: %d: Maximum labels */
__( 'Maximum %d labels allowed per metric.', 'wp-prometheus' ),
self::MAX_LABELS
);
} else {
foreach ( $metric['labels'] as $label ) {
if ( ! $this->validate_label_name( $label ) ) {
$errors[] = sprintf(
/* translators: %s: Label name */
__( 'Invalid label name: %s', 'wp-prometheus' ),
$label
);
}
}
}
}
// Validate value type.
$valid_value_types = array( 'static', 'option' );
if ( empty( $metric['value_type'] ) || ! in_array( $metric['value_type'], $valid_value_types, true ) ) {
$errors[] = __( 'Invalid value type. Must be "static" or "option".', 'wp-prometheus' );
}
// Validate value config based on type.
if ( ! empty( $metric['value_type'] ) ) {
if ( 'static' === $metric['value_type'] ) {
// Static values validated in label_values.
} elseif ( 'option' === $metric['value_type'] ) {
if ( empty( $metric['value_config']['option_name'] ) ) {
$errors[] = __( 'Option name is required for option-based metrics.', 'wp-prometheus' );
}
}
}
// Validate label values count.
if ( ! empty( $metric['label_values'] ) && is_array( $metric['label_values'] ) ) {
if ( count( $metric['label_values'] ) > self::MAX_LABEL_VALUES ) {
$errors[] = sprintf(
/* translators: %d: Maximum label combinations */
__( 'Maximum %d label value combinations allowed.', 'wp-prometheus' ),
self::MAX_LABEL_VALUES
);
}
// Validate each row has correct number of values.
$label_count = count( $metric['labels'] ?? array() );
foreach ( $metric['label_values'] as $row ) {
if ( is_array( $row ) && count( $row ) !== $label_count + 1 ) { // +1 for value.
$errors[] = __( 'Each label value row must have values for all labels plus a metric value.', 'wp-prometheus' );
break;
}
}
}
return $errors;
}
/**
* Sanitize metric data.
*
* @param array $metric Raw metric data.
* @return array Sanitized metric data.
*/
private function sanitize_metric( array $metric ): array {
$sanitized = array(
'id' => sanitize_key( $metric['id'] ?? '' ),
'name' => sanitize_key( $metric['name'] ?? '' ),
'help' => sanitize_text_field( $metric['help'] ?? '' ),
'type' => sanitize_key( $metric['type'] ?? 'gauge' ),
'labels' => array(),
'value_type' => sanitize_key( $metric['value_type'] ?? 'static' ),
'value_config' => array(),
'label_values' => array(),
'enabled' => ! empty( $metric['enabled'] ),
'created_at' => absint( $metric['created_at'] ?? time() ),
'updated_at' => absint( $metric['updated_at'] ?? time() ),
);
// Sanitize labels.
if ( ! empty( $metric['labels'] ) && is_array( $metric['labels'] ) ) {
foreach ( $metric['labels'] as $label ) {
$sanitized['labels'][] = sanitize_key( $label );
}
}
// Sanitize value config.
if ( 'static' === $sanitized['value_type'] ) {
$sanitized['value_config'] = array();
} elseif ( 'option' === $sanitized['value_type'] ) {
$sanitized['value_config'] = array(
'option_name' => sanitize_key( $metric['value_config']['option_name'] ?? '' ),
'default' => floatval( $metric['value_config']['default'] ?? 0 ),
);
}
// Sanitize label values.
if ( ! empty( $metric['label_values'] ) && is_array( $metric['label_values'] ) ) {
foreach ( $metric['label_values'] as $row ) {
if ( is_array( $row ) ) {
$sanitized_row = array();
foreach ( $row as $index => $value ) {
// Last value is the metric value (numeric).
if ( $index === count( $row ) - 1 ) {
$sanitized_row[] = floatval( $value );
} else {
$sanitized_row[] = sanitize_text_field( $value );
}
}
$sanitized['label_values'][] = $sanitized_row;
}
}
}
return $sanitized;
}
/**
* Export all metrics to JSON.
*
* @return string JSON string.
*/
public function export(): string {
$metrics = $this->get_all();
$export_data = array(
'version' => self::EXPORT_VERSION,
'plugin_version' => WP_PROMETHEUS_VERSION,
'exported_at' => gmdate( 'c' ),
'site_url' => home_url(),
'metrics' => array_values( $metrics ),
);
return wp_json_encode( $export_data, JSON_PRETTY_PRINT );
}
/**
* Import metrics from JSON.
*
* @param string $json JSON string.
* @param string $mode Import mode: 'skip', 'overwrite', or 'rename'.
* @return array Result with 'imported', 'skipped', 'errors' counts.
* @throws \InvalidArgumentException If JSON is invalid.
*/
public function import( string $json, string $mode = 'skip' ): array {
$data = json_decode( $json, true );
if ( json_last_error() !== JSON_ERROR_NONE ) {
throw new \InvalidArgumentException( __( 'Invalid JSON format.', 'wp-prometheus' ) );
}
if ( empty( $data['metrics'] ) || ! is_array( $data['metrics'] ) ) {
throw new \InvalidArgumentException( __( 'No metrics found in import file.', 'wp-prometheus' ) );
}
$result = array(
'imported' => 0,
'skipped' => 0,
'errors' => 0,
'messages' => array(),
);
$existing_metrics = $this->get_all();
$existing_names = array_column( $existing_metrics, 'name', 'id' );
foreach ( $data['metrics'] as $metric ) {
if ( empty( $metric['name'] ) ) {
$result['errors']++;
continue;
}
// Check for name collision.
$name_exists = in_array( $metric['name'], $existing_names, true );
if ( $name_exists ) {
if ( 'skip' === $mode ) {
$result['skipped']++;
$result['messages'][] = sprintf(
/* translators: %s: Metric name */
__( 'Skipped "%s" (already exists).', 'wp-prometheus' ),
$metric['name']
);
continue;
} elseif ( 'rename' === $mode ) {
// Generate unique name.
$base_name = $metric['name'];
$counter = 1;
while ( in_array( $metric['name'], $existing_names, true ) ) {
$metric['name'] = $base_name . '_imported_' . $counter;
$counter++;
}
}
// 'overwrite' mode: continue with same name, will overwrite below.
}
// Clear ID to create new metric (unless overwriting).
if ( 'overwrite' === $mode && $name_exists ) {
// Find existing ID by name.
$metric['id'] = array_search( $metric['name'], $existing_names, true );
} else {
unset( $metric['id'] );
}
try {
$this->save( $metric );
$result['imported']++;
// Update existing names for subsequent collision checks.
$existing_names = array_column( $this->get_all(), 'name', 'id' );
} catch ( \InvalidArgumentException $e ) {
$result['errors']++;
$result['messages'][] = sprintf(
/* translators: 1: Metric name, 2: Error message */
__( 'Error importing "%1$s": %2$s', 'wp-prometheus' ),
$metric['name'],
$e->getMessage()
);
}
}
return $result;
}
/**
* Register custom metrics with the Collector.
*
* @param Collector $collector The metrics collector instance.
* @return void
*/
public function register_with_collector( Collector $collector ): void {
$metrics = $this->get_all();
foreach ( $metrics as $metric ) {
if ( empty( $metric['enabled'] ) ) {
continue;
}
try {
$gauge = $collector->register_gauge(
$metric['name'],
$metric['help'],
$metric['labels'] ?? array()
);
// Set values based on value type.
if ( 'option' === $metric['value_type'] ) {
// Option-based metric: read from WordPress option.
$option_name = $metric['value_config']['option_name'] ?? '';
$default = $metric['value_config']['default'] ?? 0;
if ( ! empty( $option_name ) ) {
$value = get_option( $option_name, $default );
$value = is_numeric( $value ) ? floatval( $value ) : $default;
// For option-based, use empty labels if no labels defined.
$label_values = array();
if ( ! empty( $metric['labels'] ) && ! empty( $metric['label_values'][0] ) ) {
// Use first row of labels (without the value).
$label_values = array_slice( $metric['label_values'][0], 0, count( $metric['labels'] ) );
}
$gauge->set( $value, $label_values );
}
} elseif ( 'static' === $metric['value_type'] ) {
// Static metric: use predefined label values.
if ( ! empty( $metric['label_values'] ) ) {
foreach ( $metric['label_values'] as $row ) {
if ( ! is_array( $row ) || count( $row ) < 1 ) {
continue;
}
// Last element is the value.
$value = array_pop( $row );
// Remaining elements are label values.
$gauge->set( floatval( $value ), $row );
}
} else {
// No labels, single value.
$gauge->set( 0, array() );
}
}
} catch ( \Exception $e ) {
// Log error but don't break metric collection.
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
error_log( sprintf( 'WP Prometheus: Failed to register custom metric "%s": %s', $metric['name'], $e->getMessage() ) );
}
}
}
}
}

View File

@@ -3,7 +3,7 @@
* Plugin Name: WP Prometheus * Plugin Name: WP Prometheus
* Plugin URI: https://src.bundespruefstelle.ch/magdev/wp-prometheus * Plugin URI: https://src.bundespruefstelle.ch/magdev/wp-prometheus
* Description: Prometheus metrics endpoint for WordPress with extensible hooks for custom metrics. * Description: Prometheus metrics endpoint for WordPress with extensible hooks for custom metrics.
* Version: 0.2.0 * Version: 0.3.0
* Requires at least: 6.4 * Requires at least: 6.4
* Requires PHP: 8.3 * Requires PHP: 8.3
* Author: Marco Graetsch * Author: Marco Graetsch
@@ -26,7 +26,7 @@ if ( ! defined( 'ABSPATH' ) ) {
* *
* @var string * @var string
*/ */
define( 'WP_PROMETHEUS_VERSION', '0.2.0' ); define( 'WP_PROMETHEUS_VERSION', '0.3.0' );
/** /**
* Plugin file path. * Plugin file path.