Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add official monitoring plugin #3160

Merged
merged 20 commits into from
Mar 25, 2024
Merged

Add official monitoring plugin #3160

merged 20 commits into from
Mar 25, 2024

Conversation

Abrynos
Copy link
Member

@Abrynos Abrynos commented Mar 17, 2024

Checklist

  • I read and understood the Contributing Guidelines.
  • This is not a duplicate of an existing merge request.
  • I believe this falls into the scope of the project and should be part of the built-in functionality.
  • My code follows the code style of this project.
  • I have added tests to cover my changes, wherever they are necessary.
  • All new and existing tests pass.

Changes

New functionality

Added official plugin for monitoring, which is NOT included with ASF by default.

Changed functionality

None

Removed functionality

None

Additional info

I am prepared to provide maintenance and support for this plugin, but I prefer this to be an OFFICIAL plugin, keeping my home setup supported in turn.

I've prepared the plugin to be updatable from GitHub and the pipelines to compile the plugin, but I've not yet changed the pipeline to zip and upload the binaries. The scripting skills of @JustArchi are superior to mine in every way and I am sure you would have thousands of complaints if I added that myself. It's faster if you do it in the post-PR cleanup (thanks in advance <3)


Thank you for considering the inclusion of this merge request.

@JustArchi JustArchi added the ✨ Enhancement Issues marked with this label indicate further enhancements to the program, such as new features. label Mar 17, 2024
Copy link
Member

@ezhevita ezhevita left a comment

Choose a reason for hiding this comment

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

Also overall question - can this plugin be extended by meters that other plugins could possibly add?

.github/workflows/publish.yml Outdated Show resolved Hide resolved
ArchiSteamFarm/Plugins/Interfaces/IWebServiceProvider.cs Outdated Show resolved Hide resolved
Directory.Packages.props Show resolved Hide resolved
@Abrynos Abrynos requested a review from ezhevita March 17, 2024 15:47
@JustArchi JustArchi added the 👀 Evaluation Issues marked with this label are currently being evaluated if they're going to be considered. label Mar 17, 2024
@Abrynos
Copy link
Member Author

Abrynos commented Mar 17, 2024

Just saw this comment:

Also overall question - can this plugin be extended by meters that other plugins could possibly add?

As per my messages towars Archi earlier on our discord channel:

In the current state it is not, but I have put some thoughts into it and I would like the input of other people.

One option is to add an interface to ASF core, which the plugin could utilize. However, I am not a fan of adding features that are only used by a plugin that is not distributed by default.

Another solution would be to add a public interface to the plugin project itself and tell people to add a reference to it. However, that requires this plugin to be installed even on setups that might not utilize monitoring capabilties.

A third option is to somehow discover meters added by plugins in a way that neither adds a monitoring-specific interface to ASF core nor to this plugin. This would be my preferred option, but I am unsure of how to achieve this in a nice way. Of course we could load meter names from the configuration, but that would mean that users need to manually add the meters of alls their plugins and I am definitely not in favour of that.

@JustArchi JustArchi added 📢 Feedback welcome Issues marked with this label are open to any potential feedback that could help us. 🔧 Fixes required Issues marked with this label require further follow-up fixes before they can be considered. 🚧 Work in progress Issues marked with this label are in active work-in-progress and they're not ready for review yet. and removed 👀 Evaluation Issues marked with this label are currently being evaluated if they're going to be considered. labels Mar 18, 2024
Copy link
Member

@JustArchi JustArchi left a comment

Choose a reason for hiding this comment

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

Another round, I don't believe there will be much more after that (if anything), and most of those changes are really misc - good job 🏆

.github/workflows/publish.yml Outdated Show resolved Hide resolved
ArchiSteamFarm/IPC/ArchiKestrel.cs Show resolved Hide resolved
ArchiSteamFarm/Plugins/PluginsCore.cs Outdated Show resolved Hide resolved
Copy link
Member

@JustArchi JustArchi left a comment

Choose a reason for hiding this comment

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

Last 3 things + please resolve conflicts 😎

ArchiSteamFarm/Plugins/PluginsCore.cs Outdated Show resolved Hide resolved
Directory.Build.props Outdated Show resolved Hide resolved
Copy link
Member

@JustArchi JustArchi left a comment

Choose a reason for hiding this comment

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

LGTM, leaving this up for a few days in case anybody else wanted to review. Good job 🏆

@JustArchi JustArchi added 🏁 Finished Issues marked with this label were finished already and no further work is required on them. and removed 🔧 Fixes required Issues marked with this label require further follow-up fixes before they can be considered. 🚧 Work in progress Issues marked with this label are in active work-in-progress and they're not ready for review yet. labels Mar 24, 2024
@JustArchi JustArchi merged commit f9f6e20 into JustArchiNET:main Mar 25, 2024
21 checks passed
@JustArchi
Copy link
Member

Thanks! 🏆

@Abrynos Abrynos deleted the monitoring branch March 26, 2024 05:09
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
✨ Enhancement Issues marked with this label indicate further enhancements to the program, such as new features. 📢 Feedback welcome Issues marked with this label are open to any potential feedback that could help us. 🏁 Finished Issues marked with this label were finished already and no further work is required on them.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants