Document zabbix publish_string_states config #36734
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe pull request adds a new configuration option Changes
Sequence DiagramsequenceDiagram
participant User
participant Zabbix Integration
User->>Zabbix Integration: Configure with publish_string_states
alt publish_string_states is true
Zabbix Integration->>Zabbix Integration: Publish string states
else publish_string_states is false (default)
Zabbix Integration->>Zabbix Integration: Skip string states
end
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/zabbix.markdown (2)
65-69: Enhance documentation clarity for theinclude_stringsoption.While the documentation follows the correct format, it could be more helpful by:
- Clarifying what happens to string states when
include_stringsis false (are they ignored, filtered out, etc?)- Adding an example configuration showing its usage
Consider adding this example to the "Full configuration" section:
zabbix: host: ZABBIX_HOST path: ZABBIX_PATH ssl: false username: USERNAME password: PASSWORD publish_states_host: homeassistant + include_strings: true exclude: domains: - device_tracker
65-69: Add reference to the parent PR.To help with tracking changes and providing additional context, consider adding a comment referencing the parent PR where this feature was introduced (PR 134773).
Add a small note in the description:
include_strings: description: >- Also publish string states, i.e. states which cannot be cast to a numeric value. + Introduced in Home Assistant Core PR #134773. required: false type: boolean default: false
| @@ -62,6 +62,11 @@ publish_states_host: | |||
| description: The host that will receive the state changes from Home Assistant. It needs to be manually created in Zabbix first and have the template associated with it (see above). | |||
| required: false | |||
| type: string | |||
| publish_string_states: | |||
| description: Also publish string states, i.e. states which cannot be cast to a numeric value. | |||
There was a problem hiding this comment.
| description: Also publish string states, i.e. states which cannot be cast to a numeric value. | |
| description: Also publish string states. That is, states that cannot be cast to a numeric value. |
There was a problem hiding this comment.
It was already merged - @c0ffeeca7 should I re-open the PR?
|
haha, yes, Frenck was quick 🚀 . Nah, it's fine. It's a nitpick. We avoid e.g. and i.e., as per Style Guide. Keep an eye out for it next time. |
Proposed change
This PR documents the new Zabbix config value
publish_string_statesintroduced in PR 134773.Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
publish_string_statesfor Zabbix integration.