endpoint alert schema

Yelp · Aug 30, 2024 · da0d194 · da0d194
1 parent 3fdb334
commit da0d194
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/docs/source/yelpsoa_configs.rst b/docs/source/yelpsoa_configs.rst
@@ -1110,7 +1110,8 @@ These keys provide optional overrides for the default alerting behaviour.
      environments. Defaults to **false**.
    - ``error_threshold_ratio``: Error threshold ratio (0-1). Defaults to **0.01**.
    - ``minimum_error_rps``: Minimum error rate per second, minimum is zero. Defaults to **5**.
-   - ``namespace_alert``: Toggle namespace alerting. Defaults to **true**.
+   - ``namespace_alert``: Toggle namespace alerting. Defaults to **true**. Can be used to disable alerting for the
+     namespace when alerts are configured for specific endpoints.
    - ``endpoints``: List of enpoints to create alerts for.
       - ``name``: The name of the endpoint.
       - ``error_threshold_ratio``: Error threshold ratio (0-1). If not specified the threshold will be inherited from the parent.