Skip to content

docs: add tedge-watchdog decision page#3193

Merged
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:decision-tedge-watchdog
Oct 22, 2024
Merged

docs: add tedge-watchdog decision page#3193
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:decision-tedge-watchdog

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Add a new decision page after a decision about the future of the tedge-watchdog component and rationale on why shifting focus to independent solutions such as monit would lead to a more reliable/holistic approach to moniting components and performing corrective actions to bring a system back to a healthy state.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Oct 18, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 18, 2024

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
509 0 2 509 100 1h37m42.032322999s

Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm okay to go in the direction proposed here. i.e. to stop further development of the tedge-watchdog component (at to deprecate it) and to improve the tedge-monit-setup for thin-edge.

@reubenmiller
Copy link
Copy Markdown
Contributor Author

I'm okay to go in the direction proposed here. i.e. to stop further development of the tedge-watchdog component (at to deprecate it) and to improve the tedge-monit-setup for thin-edge.

I'm still in two minds about whether to fully deprecate the plugin or not. I'm leaning towards at least keeping it in the code based, so the other users can continue development (if they do prefer the systemd based approach).

@didier-wenzek What do you think?

@didier-wenzek
Copy link
Copy Markdown
Contributor

I'm still in two minds about whether to fully deprecate the plugin or not.

Do we have known users? Not sure. We have few or no questions about it.

I would keep the code for the tedge_watchdog but remove it from the documentation as we do for the c8y_firmware_plugin.

@reubenmiller
Copy link
Copy Markdown
Contributor Author

I'm still in two minds about whether to fully deprecate the plugin or not.

Do we have known users? Not sure. We have few or no questions about it.

We don't have any exact data to support this, however since the tedge-watchdog always needed some manual configuration to enable it, I really doubt anyone has been using it, however I would use caution and expect there to be at least a few users.

I would keep the code for the tedge_watchdog but remove it from the documentation as we do for the c8y_firmware_plugin.

The tedge watchdog docs has already been marked as "unlisted" since a while now (when the original limitation was found see #2635). Unlisted pages don't turn up in the doc searches, but can still be accessed if someone knows the url (e.g. they have saved it in a bookmark) - here is a link to the unlisted page

@didier-wenzek
Copy link
Copy Markdown
Contributor

The tedge watchdog docs has already been marked as "unlisted"

So, let's leave things as they are now.

Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

# tedge-watchdog

* Date: __2024-10-18__
* Status: __New__
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Status: __New__
* Status: __Approved__

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved by 79a9ab1

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller added this pull request to the merge queue Oct 22, 2024
Merged via the queue into thin-edge:main with commit be82810 Oct 22, 2024
@reubenmiller reubenmiller added the theme:monitoring Theme: Service monitoring and watchdogs label Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation theme:monitoring Theme: Service monitoring and watchdogs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants