Add debugging steps for nest integration. #37050
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the Nest integration documentation by adding a troubleshooting note regarding a configuration error related to Google Pub/Sub subscriptions. It highlights that subscriptions may be deleted after 31 days of inactivity, which can lead to integration failures. The documentation instructs users to check Home Assistant logs for specific error messages and outlines steps for resolving the issue, including re-enabling the Pub/Sub Topic and potentially recreating the Nest integration. Changes
📜 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)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nest.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nest.markdown
[uncategorized] ~629-~629: Possible missing comma found.
Context: ...-any-deletion-logs-000004170)). If this happens then the integration will fail, and you...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/nest.markdown
[error] 629-629: Incorrect usage of the term: "google", use "Google" instead
[error] 629-629: Incorrect usage of the term: "home assistant", use "Home Assistant" instead
[error] 629-629: Incorrect usage of the term: "google", use "Google" instead
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
Google can delete your pub/sub subscription. This adds troubleshooting steps to address that issue for the nest integration.
433dc33 to
3418b88
Compare
|
(just force pushed some linting changes with capitalization. figure single commit is better, but let me know if more commits are preferred). |
|
(I'm not clear on why these other CI steps are failing?) |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/nest.markdown (1)
629-629: Fix grammatical error and improve readability.The content is helpful, but there's a small grammatical error and the formatting could be improved for better readability.
Apply this diff to fix the grammar and improve readability:
-- **Configuration error: Failed to create subscriber `subscription/name` was not found** - By default, Google pub/sub subscriptions will be deleted after 31 days of inactivity ([reference](https://cloud.google.com/knowledge/kb/pub-sub-subscriptions-disappeared-without-any-deletion-logs-000004170)). If this happens, then the integration will fail, and you will see the preceding log line in your Home Assistant logs. If that is the case, then go to the [Device Access Console](https://console.nest.google.com/device-access/project-list) again, and re-enable the Pub/Sub Topic. The nest integration may need to be recreated to pick up the new pub/sub topic. To avoid this issue in the future, go to your [Google Cloud Console Pub/Sub subscription page](https://console.cloud.google.com/cloudpubsub/subscription/list) and edit the pub/sub subscription that was created by Nest. Change it so that is does not expire by default. +- **Configuration error: Failed to create subscriber `subscription/name` was not found** - By default, Google pub/sub subscriptions will be deleted after 31 days of inactivity ([reference](https://cloud.google.com/knowledge/kb/pub-sub-subscriptions-disappeared-without-any-deletion-logs-000004170)). If this happens, then the integration will fail, and you will see the preceding log line in your Home Assistant logs. If that is the case, then: + + 1. Go to the [Device Access Console](https://console.nest.google.com/device-access/project-list) and re-enable the Pub/Sub Topic + 2. The Nest integration may need to be recreated to pick up the new Pub/Sub topic + 3. (Optional) To prevent future expirations, visit your [Google Cloud Console Pub/Sub subscription page](https://console.cloud.google.com/cloudpubsub/subscription/list) and edit the Pub/Sub subscription created by Nest to not expire by defaultChanges made:
- Fixed grammar: "so that is does not expire" → "to not expire"
- Restructured the steps into a numbered list
- Added line breaks to improve readability
- Fixed capitalization of product names (Nest, Pub/Sub)
🧰 Tools
🪛 LanguageTool
[grammar] ~629-~629: The verb form seems incorrect.
Context: ... was created by Nest. Change it so that is does not expire by default.(IS_VBZ)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nest.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nest.markdown
[grammar] ~629-~629: The verb form seems incorrect.
Context: ... was created by Nest. Change it so that is does not expire by default.
(IS_VBZ)
@coderabbitai apply suggested changes |
|
@c0ffeeca7: i'll apply the suggested changes to improve the grammar and readability of the documentation. ✅ Actions performedComments resolved. |
@coderabbittai make a committable suggestion |
|
Tip For best results, initiate chat on the files or code changes. @c0ffeeca7 Here's the complete updated content for the troubleshooting section: - **Configuration error: Failed to create subscriber `subscription/name` was not found** - By default, Google pub/sub subscriptions will be deleted after 31 days of inactivity ([reference](https://cloud.google.com/knowledge/kb/pub-sub-subscriptions-disappeared-without-any-deletion-logs-000004170)). If this happens, then the integration will fail, and you will see the preceding log line in your Home Assistant logs. If that is the case, then:
1. Go to the [Device Access Console](https://console.nest.google.com/device-access/project-list) and re-enable the Pub/Sub Topic
2. The Nest integration may need to be recreated to pick up the new Pub/Sub topic
3. (Optional) To prevent future expirations, visit your [Google Cloud Console Pub/Sub subscription page](https://console.cloud.google.com/cloudpubsub/subscription/list) and edit the Pub/Sub subscription created by Nest to not expire by default🔗 Analysis chain🏁 Scripts executedThe following scripts were executed for the analysis: Script: Length of output: 38240 |
My neither, apparently. I will give it another try tomorrow. |
| - **Configuration error: Failed to create subscriber `subscription/name` was not found** - By default, Google pub/sub subscriptions will be deleted after 31 days of inactivity ([reference](https://cloud.google.com/knowledge/kb/pub-sub-subscriptions-disappeared-without-any-deletion-logs-000004170)). If this happens, then the integration will fail, and you will see the preceding log line in your Home Assistant logs. If that is the case, then: | ||
|
|
||
| 1. Go to the [Device Access Console](https://console.nest.google.com/device-access/project-list) and re-enable the Pub/Sub Topic. | ||
| 2. The Nest integration may need to be recreated to pick up the new Pub/Sub topic. |
There was a problem hiding this comment.
Thanks for adding this. I think we may need to add a repair flow or reconfigure flow for this.
Proposed change
Google can delete your pub/sub subscription. This adds troubleshooting steps to address that issue for the nest integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.NOTE: it's possible that we should add a step to the general setup documentation to remove the expiry on the pub/sub subscription after creation, but I went for the smaller change here providing troubleshooting instructions. For context I didn't access home assistant for more than 31 days and my nest integration stopped working.
NOTE 2: I put that the nest integration may need to be recreated, as that's what I did, and that resolved the issue for me. I don't know if there is a way to change the registered pub/sub topic without reinitializing the integration or not.
Summary by CodeRabbit