feat(metrics): Allow sending remediation metrics to blaas (#171)

* feat(blaas): Allow usage metrics for Blaas

* feat(blaas): Remove reset remediation metrics feature

Author: julienloizelet

CHANGELOG.md

@@ -6,6 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [2.13.0](https://github.com/crowdsecurity/cs-wordpress-bouncer/releases/tag/v2.13.0) - 2025-12-12
+[_Compare with previous release_](https://github.com/crowdsecurity/cs-wordpress-bouncer/compare/v2.12.0...v2.13.0)
+
+### Changed
+
+- Allow sending remediation metrics even with BLaaS LAPI
+
+### Removed
+
+- Remove "Reset remediation metrics" feature previously added for BLaaS LAPI
+
+
+---
+
+
 ## [2.12.0](https://github.com/crowdsecurity/cs-wordpress-bouncer/releases/tag/v2.12.0) - 2025-12-05
 [_Compare with previous release_](https://github.com/crowdsecurity/cs-wordpress-bouncer/compare/v2.11.1...v2.12.0)
 

crowdsec.php

@@ -4,7 +4,7 @@
  * Plugin URI: https://github.com/crowdsecurity/cs-wordpress-bouncer
  * Description: Safer Together. Protect your WordPress application with CrowdSec.
  * Tags: security, captcha, ip-blocker, crowdsec, hacker-protection, appsec
- * Version: 2.12.0
+ * Version: 2.13.0
  * Author: CrowdSec
  * Author URI: https://www.crowdsec.net/
  * Github: https://github.com/crowdsecurity/cs-wordpress-bouncer
@@ -13,7 +13,7 @@
  * Requires PHP: 7.2
  * Requires at least: 4.9
  * Tested up to: 6.9
- * Stable tag: 2.12.0
+ * Stable tag: 2.13.0
  * Text Domain: crowdsec-wp
  * First release: 2021.
  */

docs/DEVELOPER.md

@@ -457,16 +457,8 @@ Before publishing a new release, there are some manual steps to take:
 
 Then, you have to [run the action manually from the GitHub repository](https://github.com/crowdsecurity/cs-wordpress-bouncer/actions/workflows/release.yml)
 
-
 Alternatively, you could use the [GitHub CLI](https://github.com/cli/cli):
-- create a draft release:
-```
-gh workflow run release.yml -f tag_name=vx.y.z -f draft=true
-```
-- publish a prerelease:
-```
-gh workflow run release.yml -f tag_name=vx.y.z -f prerelease=true
-```
+
 - publish a release:
 ```
 gh workflow run release.yml -f tag_name=vx.y.z

docs/USER_GUIDE.md

@@ -141,7 +141,6 @@ note the following:
 
 - The Authentication type must be "Bouncer API key"
 - Stream mode must be enabled (see Communication mode with the Local API in [Advanced settings](#advanced-settings)).
-- Remediation Metrics cannot be sent (see Remediation Metrics in [Advanced settings](#advanced-settings)).
 - AppSec component cannot be used (see Appsec Component in [Advanced settings](#advanced-settings))
 
 ***

inc/Admin/advanced-settings.php

@@ -163,12 +163,6 @@ function crowdsec_multi_save_advanced_settings()
     // Field "crowdsec_usage_metrics"
     addFieldCheckbox('crowdsec_usage_metrics', 'Enable Remediation Metrics', 'crowdsec_plugin_advanced_settings', 'crowdsec_advanced_settings', 'crowdsec_admin_advanced_usage_metrics', function () {
         // Usage metrics push just activated.
-        $lapiUrl = is_multisite() ? get_site_option('crowdsec_api_url') : get_option('crowdsec_api_url');
-        if (0 === strpos($lapiUrl, Constants::BAAS_URL)) {
-            AdminNotice::displayError('Pushing remediation metrics with a Block as a Service LAPI ('.esc_html
-                ($lapiUrl).') is not supported. ');
-            return false;
-        }
         scheduleUsageMetricsPush();
         return true;
     }, function () {
@@ -182,7 +176,7 @@ function crowdsec_multi_save_advanced_settings()
     <div id="usage-metrics-report">
             <p>'.displayBouncerMetricsInAdminPage().'</p> 
             </div>
-    ' .displayPushMetricsInAdminPage($isUsageMetricsEnabled).displayResetMetricsInAdminPage()
+    ' .displayPushMetricsInAdminPage($isUsageMetricsEnabled)
     );
 
 

inc/Admin/init.php

@@ -121,27 +121,6 @@ function pushBouncerMetricsInAdminPage()
         }
     }
 
-    function resetBouncerMetricsInAdminPage()
-    {
-        try {
-            $configs = getDatabaseConfigs();
-            $bouncer = new Bouncer($configs);
-            $bouncer->resetUsageMetrics();
-            AdminNotice::displaySuccess(__('CrowdSec remediation metrics have been reset successfully.'));
-        } catch (Exception $e) {
-            if(isset($bouncer) && $bouncer->getLogger()) {
-                $bouncer->getLogger()->error('', [
-                    'type' => 'WP_EXCEPTION_WHILE_RESETTING_USAGE_METRICS',
-                    'message' => $e->getMessage(),
-                    'code' => $e->getCode(),
-                    'file' => $e->getFile(),
-                    'line' => $e->getLine(),
-                ]);
-            }
-            AdminNotice::displayError('Technical error while resetting remediation metrics: '.$e->getMessage());
-        }
-    }
-
     function displayBouncerMetricsInAdminPage()
     {
         try {
@@ -263,43 +242,11 @@ function displayBouncerMetricsInAdminPage()
         }
     }
 
-
-    function displayResetMetricsInAdminPage()
-    {
-        try {
-            $configs = getDatabaseConfigs();
-            $bouncer = new Bouncer($configs);
-            if ($bouncer->hasBaasUri()) {
-                return '<p><input id="crowdsec_reset_usage_metrics" style="margin-right:10px" type="button" value="Reset remediation metrics now" class="button button-secondary button-small" onclick="document.getElementById(\'crowdsec_action_reset_usage_metrics\').submit();"></p>';
-            }
-
-            return '';
-        }
-        catch (Exception $e) {
-            if (isset($bouncer) && $bouncer->getLogger()) {
-                $bouncer->getLogger()->error('', [
-                    'type'    => 'WP_EXCEPTION_WHILE_DISPLAYING_RESET_METRICS',
-                    'message' => $e->getMessage(),
-                    'code'    => $e->getCode(),
-                    'file'    => $e->getFile(),
-                    'line'    => $e->getLine(),
-                ]);
-            }
-
-            AdminNotice::displayError('Technical error while displaying reset metrics button: ' . esc_html($e->getMessage()));
-            return '';
-        }
-
-    }
-
     function displayPushMetricsInAdminPage($isPushEnabled = false)
     {
         try {
             $configs = getDatabaseConfigs();
             $bouncer = new Bouncer($configs);
-            if($bouncer->hasBaasUri()) {
-                return '';
-            }
             if( $isPushEnabled) {
                 return '<p><input id="crowdsec_push_usage_metrics" style="margin-right:10px" type="button" value="Push remediation metrics now" class="button button-secondary button-small" onclick="document.getElementById(\'crowdsec_action_push_usage_metrics\').submit();"></p>';
             }
@@ -440,15 +387,6 @@ function testGeolocationInAdminPage($ip)
         header("Location: {$_SERVER['HTTP_REFERER']}");
         exit(0);
     });
-    add_action('admin_post_crowdsec_reset_usage_metrics', function () {
-        if (
-            !isset($_POST['nonce']) || !wp_verify_nonce($_POST['nonce'], 'crowdsec_reset_usage_metrics')) {
-            die('This link expired.');
-        }
-        resetBouncerMetricsInAdminPage();
-        header("Location: {$_SERVER['HTTP_REFERER']}");
-        exit(0);
-    });
     add_action('admin_post_crowdsec_prune_cache', function () {
         if (
             !isset($_POST['nonce']) || !wp_verify_nonce($_POST['nonce'], 'crowdsec_prune_cache')) {

inc/Admin/settings.php

@@ -77,7 +77,6 @@ function crowdsec_multi_save_settings()
             $message .= '<br><b>Please note the following: </b><ul>';
             $message .= '<li>- The Authentication type must be "Bouncer API key".</li>';
             $message .= '<li>- Stream mode must be enabled (see Communication mode with the Local API in Advanced Settings).</li>';
-            $message .= '<li>- Usage Metrics cannot be sent (see Usage Metrics in Advanced Settings).</li>';
             $message .= '<li>- AppSec component cannot be used (see Appsec Component in Advanced Settings).</li>';
             $message .= '</ul>';
             AdminNotice::displayWarning($message);

inc/Constants.php

@@ -21,5 +21,5 @@ class Constants extends LibConstants
     public const BOUNCER_NAME = 'wordpress-bouncer';
     public const DEFAULT_BASE_FILE_PATH = __DIR__ . '/../../../../wp-content/uploads/crowdsec/';
     public const STANDALONE_CONFIG_PATH = __DIR__ . '/standalone-settings.php';
-    public const VERSION = 'v2.12.0';
+    public const VERSION = 'v2.13.0';
 }

inc/templates/advanced-settings.php

@@ -137,11 +137,6 @@ function updateDsnDisplay () {
         <form action="<?php echo admin_url('admin-post.php'); ?>" method="post" id="crowdsec_action_push_usage_metrics">
             <input type="hidden" name="action" value="crowdsec_push_usage_metrics">
             <input type="hidden" name="nonce" value="<?php echo wp_create_nonce('crowdsec_push_usage_metrics'); ?>">
-        </form>
-        <form action="<?php echo admin_url('admin-post.php'); ?>" method="post"
-              id="crowdsec_action_reset_usage_metrics">
-            <input type="hidden" name="action" value="crowdsec_reset_usage_metrics">
-            <input type="hidden" name="nonce" value="<?php echo wp_create_nonce('crowdsec_reset_usage_metrics'); ?>">
         </form>
 		</div>
 		<p style="padding-top:15px">

readme.txt

@@ -4,7 +4,7 @@ Donate link: https://crowdsec.net/
 Tags: security, captcha, ip-blocker, crowdsec, hacker-protection
 Requires at least: 4.9
 Tested up to: 6.9
-Stable tag: 2.12.0
+Stable tag: 2.13.0
 Requires PHP: 7.2
 License: MIT
 License URI: https://opensource.org/licenses/MIT
@@ -63,6 +63,10 @@ Multiple ways you can use the plugin
 
 == Changelog ==
 
+= 2.13 (2025-12-12) =
+
+- Allow sending remediation metrics even with a Blocklist as a Service (BLaaS) LAPI
+
 = 2.12 (2025-12-05) =
 
 - Remove Blocklist as a Service (BLaaS) subscription button