Metrics note for SaaS product #1767
Conversation
Add note about security design for Metrics Capturing.
Update config-file-reference.md with security note
There was a problem hiding this comment.
Pull request overview
This pull request adds a documentation note to clarify the security behavior of metrics capturing in the Runbook Automation SaaS product. The note informs users that metrics capturing is restricted by default in the SaaS offering as a security design decision.
Changes:
- Added a tip callout box in the Metrics Capturing section to inform users about the default metrics behavior in the SaaS product
| ``` | ||
|
|
||
| :::tip | ||
| By security design, the Metrics Capturing is capped by default in the SaaS product. |
There was a problem hiding this comment.
The term "Metrics Capturing" uses title case in the middle of a sentence, which is inconsistent with standard documentation style. It should be lowercase "metrics capturing" unless it's a proper noun or refers to a specific feature name. Based on the surrounding text which uses "metrics capturing" and "metrics data", lowercase is more appropriate here.
| By security design, the Metrics Capturing is capped by default in the SaaS product. | |
| By security design, metrics capturing is capped by default in the SaaS product. |
| ``` | ||
|
|
||
| :::tip | ||
| By security design, the Metrics Capturing is capped by default in the SaaS product. |
There was a problem hiding this comment.
The phrase "the SaaS product" is inconsistent with product naming conventions used throughout the documentation. The codebase consistently uses "Runbook Automation SaaS" or "Runbook Automation" when referring to the SaaS offering. Consider changing to "Runbook Automation SaaS" for consistency.
| ``` | ||
|
|
||
| :::tip | ||
| By security design, the Metrics Capturing is capped by default in the SaaS product. |
There was a problem hiding this comment.
The term "capped" is ambiguous in this context. It's unclear whether metrics capturing is disabled, limited, throttled, or restricted in some other way. Consider using more precise language such as "disabled", "limited", or "restricted" to clearly communicate what users should expect regarding metrics behavior in Runbook Automation SaaS.
| By security design, the Metrics Capturing is capped by default in the SaaS product. | |
| By security design, metrics capturing is restricted by default in the SaaS product, and not all metrics are collected. |
1 participant
This pull request adds a documentation note to clarify the default security behavior of metrics capturing in the SaaS product.