Initial plugin setup (v0.0.1)

- Create initial WordPress plugin structure - Add Prometheus metrics collector with default metrics - Implement authenticated /metrics endpoint with Bearer token - Add license management integration - Create admin settings page under Settings > Metrics - Set up Gitea CI/CD pipeline for automated releases - Add extensibility via wp_prometheus_collect_metrics hook Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-01 15:31:21 +01:00
commit 7ff87f7c8d
21 changed files with 2890 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,164 @@
+# WP Prometheus
+
+A WordPress plugin that provides a Prometheus-compatible `/metrics` endpoint with extensible hooks for custom metrics.
+
+## Features
+
+- Prometheus-compatible authenticated `/metrics` endpoint
+- Default WordPress metrics (users, posts, comments, plugins)
+- Extensible by other plugins using hooks
+- Settings page under Settings > Metrics
+- Bearer token authentication
+- License management integration
+
+## Requirements
+
+- PHP 8.3 or higher
+- WordPress 6.4 or higher
+- Composer (for development)
+
+## Installation
+
+### From Release Package
+
+1. Download the latest release from the [releases page](https://src.bundespruefstelle.ch/magdev/wp-prometheus/releases)
+2. Upload the zip file via Plugins > Add New > Upload Plugin
+3. Activate the plugin
+4. Configure settings under Settings > Metrics
+
+### From Source
+
+1. Clone the repository to your WordPress plugins directory:
+
+   ```bash
+   cd wp-content/plugins/
+   git clone https://src.bundespruefstelle.ch/magdev/wp-prometheus.git
+   cd wp-prometheus
+   git submodule update --init --recursive
+   composer install
+   ```
+
+2. Activate the plugin in WordPress admin
+
+## Configuration
+
+### License
+
+1. Go to Settings > Metrics
+2. Enter your license server URL, license key, and server secret
+3. Click "Save License Settings"
+4. Click "Validate License" or "Activate License"
+
+### Authentication Token
+
+A random auth token is generated on activation. You can view it or regenerate it in Settings > Metrics.
+
+### Prometheus Configuration
+
+Add the following to your `prometheus.yml`:
+
+```yaml
+scrape_configs:
+  - job_name: 'wordpress'
+    static_configs:
+      - targets: ['your-wordpress-site.com']
+    metrics_path: '/metrics/'
+    scheme: 'https'
+    authorization:
+      type: Bearer
+      credentials: 'your-auth-token-from-settings'
+```
+
+## Default Metrics
+
+| Metric | Type | Labels | Description |
+|--------|------|--------|-------------|
+| wordpress_info | Gauge | version, php_version, multisite | WordPress installation info |
+| wordpress_users_total | Gauge | role | Total users by role |
+| wordpress_posts_total | Gauge | post_type, status | Total posts by type and status |
+| wordpress_comments_total | Gauge | status | Total comments by status |
+| wordpress_plugins_total | Gauge | status | Total plugins (active/inactive) |
+
+## Extending with Custom Metrics
+
+Add your own metrics using the `wp_prometheus_collect_metrics` action:
+
+```php
+add_action( 'wp_prometheus_collect_metrics', function( $collector ) {
+    // Register a gauge
+    $gauge = $collector->register_gauge(
+        'my_custom_metric',
+        'Description of my metric',
+        array( 'label1', 'label2' )
+    );
+
+    // Set value with labels
+    $gauge->set( 42, array( 'value1', 'value2' ) );
+} );
+```
+
+### Available Methods
+
+```php
+// Gauge (can go up and down)
+$gauge = $collector->register_gauge( $name, $help, $labels );
+$gauge->set( $value, $labelValues );
+
+// Counter (only goes up)
+$counter = $collector->register_counter( $name, $help, $labels );
+$counter->inc( $labelValues );
+$counter->incBy( $amount, $labelValues );
+
+// Histogram (for distributions)
+$histogram = $collector->register_histogram( $name, $help, $labels, $buckets );
+$histogram->observe( $value, $labelValues );
+```
+
+## Development
+
+### Build for Release
+
+```bash
+# Set PHP platform version
+composer config platform.php 8.3.0
+
+# Install production dependencies
+composer install --no-dev --optimize-autoloader
+
+# Compile translations
+for po in languages/*.po; do msgfmt -o "${po%.po}.mo" "$po"; done
+```
+
+### Create Release Package
+
+From the plugins directory (parent of wp-prometheus):
+
+```bash
+cd /wp-content/plugins/
+zip -r wp-prometheus/releases/wp-prometheus-x.x.x.zip wp-prometheus \
+  -x "wp-prometheus/.git/*" \
+  -x "wp-prometheus/.gitea/*" \
+  -x "wp-prometheus/.claude/*" \
+  -x "wp-prometheus/CLAUDE.md" \
+  -x "wp-prometheus/wp-core" \
+  -x "wp-prometheus/wp-plugins" \
+  -x "wp-prometheus/releases/*" \
+  -x "wp-prometheus/composer.lock" \
+  -x "*.DS_Store"
+```
+
+## Author
+
+**Marco Graetsch**
+
+- Website: <https://src.bundespruefstelle.ch/magdev>
+- Email: magdev3.0@gmail.com
+
+## License
+
+This plugin is licensed under the GPL v2 or later.
+
+## Credits
+
+- [PromPHP/prometheus_client_php](https://github.com/PromPHP/prometheus_client_php) - Prometheus client library
+- Built with Claude AI assistance