Rename RabbitMQ config fields for consistency and add backward compatibility (#1495)

## Summary
This PR renames RabbitMQ toolset configuration fields to improve naming
consistency and clarity, while maintaining full backward compatibility
with existing configurations.

## Key Changes
- **Field Renames:**
- `management_url` → `api_url` (more accurately describes the RabbitMQ
Management API endpoint)
- `request_timeout_seconds` → `timeout_seconds` (shorter, more concise
naming)

- **Backward Compatibility:**
- Added deprecated field mappings in
`RabbitMQClusterConfig._deprecated_mappings` to automatically migrate
old field names to new ones
- Old configurations using `management_url` and
`request_timeout_seconds` will continue to work without modification
  - Deprecation warnings are logged when old field names are used

- **Documentation Updates:**
- Updated all documentation examples to use new field names (`api_url`
and `timeout_seconds`)
  - Updated configuration examples in docstrings and test fixtures

- **Code Updates:**
- Updated all internal references from `config.management_url` to
`config.api_url`
- Updated all internal references from `config.request_timeout_seconds`
to `config.timeout_seconds`
- Updated test fixtures and expected outputs to reflect new field names

- **Test Coverage:**
- Added comprehensive test suite
(`TestRabbitMQConfigBackwardCompatibility`) covering:
    - Deprecated field migration with warning logs
    - New field names without warnings
    - Equivalence between old and new configurations
    - Precedence when both old and new fields are provided

## Implementation Details
The backward compatibility is implemented using Pydantic's field
validation mechanism through the `ToolsetConfig` base class, which
automatically maps deprecated field names to their new equivalents while
logging appropriate warnings for visibility.

https://claude.ai/code/session_01UaU7bba5JVNMXujWwWr1Ec

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* RabbitMQ toolset now exposes cluster endpoints as api_url and uses
timeout_seconds for request timeouts (backward-compatible with old
names).

* **Documentation**
* Docs updated to replace management_url → api_url and
request_timeout_seconds → timeout_seconds across examples and guides.

* **Tests**
* Added tests to verify backward compatibility, deprecation warnings,
and precedence between old and new RabbitMQ config fields.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Claude <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>

Author: naomi-robusta

docs/data-sources/builtin-toolsets/rabbitmq.md

@@ -4,7 +4,7 @@ By enabling this toolset, HolmesGPT will be able to detect RabbitMQ partitions,
 
 This toolset follows a two-step process to detect partition:
 
-1. The nodes and partitioning status is obtained by fetching information from the configured `management_url`.
+1. The nodes and partitioning status is obtained by fetching information from the configured `api_url`.
 2. If some nodes are reported as not-running, the toolset will try to contact these nodes individually and deduce any partitioning state for any node that is actually running.
 
 ## Configuration
@@ -18,7 +18,7 @@ toolsets:
         - id: rabbitmq # must be unique across all configured clusters
           username: <user>
           password: <password>
-          management_url: <http://rabbitmq.rabbitmq:15672>
+          api_url: <http://rabbitmq.rabbitmq:15672>
 ```
 
 ## Advanced Configuration
@@ -33,8 +33,8 @@ rabbitmq/core:
       - id: rabbitmq # must be unique across all configured clusters
         username: <user>
         password: <password>
-        management_url: <http://rabbitmq.rabbitmq:15672>
-        request_timeout_seconds: 30 # timeout for HTTP requests
+        api_url: <http://rabbitmq.rabbitmq:15672>
+        timeout_seconds: 30 # timeout for HTTP requests
         verify_ssl: true # SSL certificate verification (default: true)
 ```
 
@@ -49,7 +49,7 @@ toolsets:
     config:
       clusters:
         - id: rabbitmq
-          management_url: https://rabbitmq.internal:15672
+          api_url: https://rabbitmq.internal:15672
           username: <user>
           password: <password>
           verify_ssl: false  # Disable SSL verification (default: true)

holmes/plugins/toolsets/rabbitmq/api.py

@@ -21,6 +21,8 @@ class ClusterConnectionStatus(str, Enum):
 class RabbitMQClusterConfig(ToolsetConfig):
     _deprecated_mappings: ClassVar[Dict[str, Optional[str]]] = {
         "verify_certs": "verify_ssl",
+        "management_url": "api_url",
+        "request_timeout_seconds": "timeout_seconds",
     }
 
     id: str = Field(
@@ -29,8 +31,8 @@ class RabbitMQClusterConfig(ToolsetConfig):
         description="Unique identifier for this cluster",
         examples=["rabbitmq", "rabbitmq-prod"],
     )
-    management_url: str = Field(
-        title="Management URL",
+    api_url: str = Field(
+        title="API URL",
         description="RabbitMQ Management API URL",
         examples=[
             "http://<your-rabbitmq-server-or-service>:15672",
@@ -48,7 +50,7 @@ class RabbitMQClusterConfig(ToolsetConfig):
         description="Password for authentication",
         examples=["holmes_password"],
     )
-    request_timeout_seconds: int = Field(
+    timeout_seconds: int = Field(
         default=30,
         title="Request Timeout",
         description="Request timeout in seconds",
@@ -155,7 +157,7 @@ def make_request(
             auth=get_auth(config),
             params=params,
             json=data,
-            timeout=config.request_timeout_seconds,
+            timeout=config.timeout_seconds,
             verify=config.verify_ssl,
         )
         response.raise_for_status()
@@ -188,7 +190,7 @@ def get_status_from_node(
         hostname = parts[1]
 
         # Construct the target node's management URL based on the original config's scheme/port
-        parsed_original_url = urlparse(config.management_url)
+        parsed_original_url = urlparse(config.api_url)
         scheme = parsed_original_url.scheme or "http"
         port = parsed_original_url.port or (
             443 if scheme == "https" else 15672
@@ -258,7 +260,7 @@ def get_cluster_status(config: RabbitMQClusterConfig) -> ClusterStatus:
     """
     raw_nodes_data: List[Dict] = []
     try:
-        url = get_url(config.management_url, "api/nodes")
+        url = get_url(config.api_url, "api/nodes")
         raw_nodes_data = make_request(
             config=config,
             method="GET",
@@ -268,7 +270,7 @@ def get_cluster_status(config: RabbitMQClusterConfig) -> ClusterStatus:
         config.connection_error = None
     except Exception as e:
         logging.error(
-            f"Failed to get primary cluster status from {config.management_url}: {e}"
+            f"Failed to get primary cluster status from {config.api_url}: {e}"
         )
         config.connection_status = ClusterConnectionStatus.ERROR
         config.connection_error = str(e)

holmes/plugins/toolsets/rabbitmq/toolset_rabbitmq.py

@@ -30,9 +30,7 @@ class RabbitMQConfig(ToolsetConfig):
     clusters: List[RabbitMQClusterConfig] = Field(
         title="Clusters",
         description="List of RabbitMQ clusters to connect to",
-        examples=[
-            [build_config_example(RabbitMQClusterConfig)]
-        ],
+        examples=[[build_config_example(RabbitMQClusterConfig)]],
     )
 
 
@@ -78,7 +76,7 @@ def _invoke(self, params: dict, context: ToolInvokeContext) -> StructuredToolRes
         available_clusters = [
             {
                 "cluster_id": c.id,
-                "management_url": c.management_url,
+                "api_url": c.api_url,
                 "connection_status": c.connection_status,
             }
             for c in self.toolset.config.clusters
@@ -169,13 +167,13 @@ def prerequisites_callable(self, config: dict[str, Any]) -> Tuple[bool, str]:
             if not env_url:
                 return (
                     False,
-                    "RabbitMQ toolset is misconfigured. 'management_url' is required.",
+                    "RabbitMQ toolset is misconfigured. 'api_url' is required.",
                 )
             config = {
                 "clusters": [
                     {
                         "id": "rabbitmq",
-                        "management_url": env_url,
+                        "api_url": env_url,
                         "username": env_user,
                         "password": env_pass,
                     }
@@ -193,7 +191,7 @@ def prerequisites_callable(self, config: dict[str, Any]) -> Tuple[bool, str]:
     def _check_clusters_config(self, config: RabbitMQConfig) -> Tuple[bool, str]:
         errors = []
         for cluster_config in config.clusters:
-            url = urljoin(cluster_config.management_url, "api/overview")
+            url = urljoin(cluster_config.api_url, "api/overview")
 
             try:
                 data = make_request(

tests/llm/fixtures/test_ask_holmes/38_rabbitmq_split_head/list_configured_clusters.txt

@@ -7,7 +7,7 @@
   "data": [
     {
       "cluster_id": "rabbitmq",
-      "management_url": "http://localhost:15672",
+      "api_url": "http://localhost:15672",
       "connection_status": "success"
     }
   ],

tests/llm/fixtures/test_ask_holmes/38_rabbitmq_split_head/toolsets.yaml

@@ -6,4 +6,4 @@ toolsets:
         - id: rabbitmq
           username: user
           password: "{{env.RABBITMQ_PASSWORD}}"
-          management_url: http://localhost:15672
+          api_url: http://localhost:15672

tests/llm/fixtures/test_ask_holmes/39_failed_toolset/toolsets.yaml

@@ -5,6 +5,6 @@ toolsets:
         - id: rabbitmq
           username: user
           password: "incorrect_password"
-          management_url: http://localhost:15672
+          api_url: http://localhost:15672
   kubernetes/core:
     enabled: true

tests/utils/test_toolset_config.py

@@ -7,6 +7,10 @@
 
 from holmes.plugins.toolsets.newrelic.newrelic import NewrelicConfig
 from holmes.plugins.toolsets.prometheus.prometheus import PrometheusConfig
+from holmes.plugins.toolsets.rabbitmq.api import RabbitMQClusterConfig
+from holmes.plugins.toolsets.servicenow_tables.servicenow_tables import (
+    ServiceNowTablesConfig,
+)
 from holmes.utils.pydantic_utils import ToolsetConfig
 
 
@@ -119,15 +123,88 @@ def test_new_prometheus_fields_no_warning(self, caplog):
         assert "deprecated" not in caplog.text.lower()
 
 
+class TestRabbitMQConfigBackwardCompatibility:
+    """Test backward compatibility for RabbitMQClusterConfig deprecated fields."""
+
+    def test_deprecated_rabbitmq_fields(self, caplog):
+        """Test that deprecated RabbitMQ config fields are migrated."""
+        with caplog.at_level(logging.WARNING):
+            # Use old field names (deprecated)
+            old_config = RabbitMQClusterConfig(
+                management_url="http://rabbitmq:15672",
+                request_timeout_seconds=45,
+            )
+
+        # Verify migration to new field names
+        assert old_config.api_url == "http://rabbitmq:15672"
+        assert old_config.timeout_seconds == 45
+        assert "management_url -> api_url" in caplog.text
+        assert "request_timeout_seconds -> timeout_seconds" in caplog.text
+
+    def test_new_rabbitmq_fields_no_warning(self, caplog):
+        """Test that new RabbitMQ field names don't trigger warnings."""
+        with caplog.at_level(logging.WARNING):
+            # Use new field names (current)
+            new_config = RabbitMQClusterConfig(
+                api_url="http://rabbitmq:15672",
+                timeout_seconds=30,
+            )
+
+        assert new_config.api_url == "http://rabbitmq:15672"
+        assert new_config.timeout_seconds == 30
+        assert "deprecated" not in caplog.text.lower()
+
+    def test_old_and_new_configs_produce_same_result(self, caplog):
+        """Test that configs created with old and new field names produce identical results."""
+        with caplog.at_level(logging.WARNING):
+            # Create config using old field names
+            old_config = RabbitMQClusterConfig(
+                id="test-cluster",
+                management_url="http://rabbitmq:15672",
+                username="user",
+                password="pass",
+                request_timeout_seconds=60,
+                verify_ssl=False,
+            )
+
+        # Create config using new field names
+        new_config = RabbitMQClusterConfig(
+            id="test-cluster",
+            api_url="http://rabbitmq:15672",
+            username="user",
+            password="pass",
+            timeout_seconds=60,
+            verify_ssl=False,
+        )
+
+        # Both configs should have identical values
+        assert old_config.id == new_config.id
+        assert old_config.api_url == new_config.api_url
+        assert old_config.username == new_config.username
+        assert old_config.password == new_config.password
+        assert old_config.timeout_seconds == new_config.timeout_seconds
+        assert old_config.verify_ssl == new_config.verify_ssl
+
+    def test_new_field_takes_precedence_over_deprecated(self, caplog):
+        """Test that new field takes precedence if both old and new are provided."""
+        with caplog.at_level(logging.WARNING):
+            config = RabbitMQClusterConfig(
+                management_url="http://old-url:15672",
+                api_url="http://new-url:15672",
+                request_timeout_seconds=30,
+                timeout_seconds=60,
+            )
+
+        # New fields should take precedence
+        assert config.api_url == "http://new-url:15672"
+        assert config.timeout_seconds == 60
+
+
 class TestServiceNowConfigBackwardCompatibility:
     """Test backward compatibility for ServiceNowTablesConfig deprecated fields."""
 
     def test_deprecated_servicenow_fields(self, caplog):
         """Test that deprecated ServiceNow config fields are migrated."""
-        from holmes.plugins.toolsets.servicenow_tables.servicenow_tables import (
-            ServiceNowTablesConfig,
-        )
-
         with caplog.at_level(logging.WARNING):
             old_config = ServiceNowTablesConfig(
                 api_key="now_test123",
@@ -140,10 +217,6 @@ def test_deprecated_servicenow_fields(self, caplog):
 
     def test_new_servicenow_fields_no_warning(self, caplog):
         """Test that new ServiceNow field names don't trigger warnings."""
-        from holmes.plugins.toolsets.servicenow_tables.servicenow_tables import (
-            ServiceNowTablesConfig,
-        )
-
         with caplog.at_level(logging.WARNING):
             new_config = ServiceNowTablesConfig(
                 api_key="now_test123",
@@ -155,10 +228,6 @@ def test_new_servicenow_fields_no_warning(self, caplog):
 
     def test_deprecated_and_new_servicenow_configs_equivalent(self, caplog):
         """Test that configs created with old and new fields are equivalent."""
-        from holmes.plugins.toolsets.servicenow_tables.servicenow_tables import (
-            ServiceNowTablesConfig,
-        )
-
         # Create config using deprecated field name
         with caplog.at_level(logging.WARNING):
             old_config = ServiceNowTablesConfig(