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.

Sign up for GitHub

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

Jump to bottom

Rename check_vmware_datastore to have size, usage or space suffix? #510

Closed
atc0005 opened this issue Nov 10, 2021 · 4 comments · Fixed by #571
Closed

Rename check_vmware_datastore to have size, usage or space suffix? #510

atc0005 opened this issue Nov 10, 2021 · 4 comments · Fixed by #571
Assignees
@atc0005
Labels
builds CI config contrib datastore documentation Improvements or additions to documentation enhancement New feature or request output/extended Long Service Output (aka, "extended" or "detailed") output/logging output/perfdata Service Perf Data (aka, "performance data") output/summary Service Output (aka, "one-line-summary")
Milestone
v0.28.0

Comments

@atc0005
Copy link
Owner

atc0005 commented Nov 10, 2021 •
edited
Loading

With the future implementation of a plugin to monitor datastore performance (#505) and datastore (in)accessibility (#507), the check_vmware_datastore plugin should probably be renamed to have a size, usage or space suffix?

I believe I originally intended to make the plugin capable of monitoring most/all attributes related to datastores, but even if implementing the additional support with subcommands, that likely packs too much functionality in one place. Instead, keeping the functionality separate is probably the best direction for now.

While this isn't exactly a breaking change, it could certainly impact deployment tooling and documentation which makes references to the current plugin name. As soon as decision is made to proceed with this change I need to start giving a heads up for at least 1-2 releases before doing so.
@atc0005 atc0005 added question Further information is requested datastore labels Nov 10, 2021
@atc0005 atc0005 added this to the Future milestone Nov 10, 2021
@atc0005 atc0005 self-assigned this Nov 10, 2021
@atc0005
Copy link
Owner Author

atc0005 commented Nov 10, 2021 •
edited
Loading

Note: I'm already referring to the plugin internally as being specific to "size":

check-vmware/internal/config/constants.go

Line 169 in 8bb1795

PluginTypeDatastoresSize string = "datastore-size"

check-vmware/cmd/check_vmware_datastore/main.go

Lines 64 to 67 in 8bb1795

// Setup configuration by parsing user-provided flags. Note plugin type so
// that only applicable CLI flags are exposed and any plugin-specific
// settings are applied.
cfg, cfgErr := config.New(config.PluginType{DatastoresSize: true})

That said, I also refer to datastore "usage" quite a bit in the docs. The original check_disk Nagios plugin has this description:

This plugin checks the amount of used disk space on a mounted file system and generates an alert if free space is less than one of the threshold values

Perhaps using a space suffix is the better approach?

@atc0005
Copy link
Owner Author

atc0005 commented Nov 24, 2021

Note to self: Don't forget to update the contrib/README.md file with a new tree listing.

@atc0005 atc0005 changed the title Rename check_vmware_datastore to check_vmware_datastore_size ? Rename check_vmware_datastore to check_vmware_datastore_size or check_vmware_datastore_usage ? Nov 24, 2021
@atc0005 atc0005 changed the title Rename check_vmware_datastore to check_vmware_datastore_size or check_vmware_datastore_usage ? Rename check_vmware_datastore to have size, usage or space suffix? Nov 24, 2021
@atc0005 atc0005 modified the milestones: Future, v0.28.0 Nov 24, 2021
@atc0005 atc0005 mentioned this issue Nov 24, 2021
Closed
@atc0005
Copy link
Owner Author

atc0005 commented Nov 24, 2021

The .gitignore file may also need updating.

@atc0005
Copy link
Owner Author

atc0005 commented Nov 27, 2021

Perhaps using a space suffix is the better approach?

I'm leaning this direction.

  • usage could reasonably be interpreted to mean that activity is occurring
  • size could potentially be interpreted to mean that the total size is within some threshold
    • e.g., making sure that its capacity isn't resized past a certain point

space seems to be the more explicit of the naming suffixes available.

atc0005 added a commit that referenced this issue Dec 30, 2021
@atc0005
Rename check_vmware_datastore plugin
449027a 
- Rename from `check_vmware_datastore` to
  `check_vmware_datastore_space` in an effort to explicitly
  note the scope of the plugin's functionality
- Update references to the plugin to reflect this change

refs GH-510
@atc0005 atc0005 mentioned this issue Dec 30, 2021
Merged
atc0005 added a commit that referenced this issue Dec 30, 2021
@atc0005
Rename check_vmware_datastore plugin, refs to it
98c6c3e 
- Rename from `check_vmware_datastore` to
  `check_vmware_datastore_space` in an effort to explicitly
  note the scope of the plugin's functionality
- Update references to the plugin to reflect this change, both
  plugin name and internal constants, variables, functions,
  types, etc.
- Update performance data metric names to reflect the plugin
  rename

refs GH-510
atc0005 added a commit that referenced this issue Dec 30, 2021
@atc0005
Rename check_vmware_datastore plugin, refs to it
623c2b7 
- Rename from `check_vmware_datastore` to
  `check_vmware_datastore_space` in an effort to explicitly
  note the scope of the plugin's functionality
- Update references to the plugin to reflect this change, both
  plugin name and internal constants, variables, functions,
  types, etc.
- Update performance data metric names to reflect the plugin
  rename

refs GH-510
atc0005 added a commit that referenced this issue Dec 30, 2021
@atc0005
Rename check_vmware_datastore plugin, refs to it
36f7bb9 
- Rename from `check_vmware_datastore` to
  `check_vmware_datastore_space` in an effort to explicitly
  note the scope of the plugin's functionality
- Update references to the plugin to reflect this change, both
  plugin name and internal constants, variables, functions,
  types, etc.
- Update performance data metric names to reflect the plugin
  rename
- Update CHANGELOG coverage for plugin rename, performance
  data metric changes

refs GH-510
atc0005 added a commit that referenced this issue Dec 30, 2021
@atc0005
Rename check_vmware_datastore plugin, refs to it
62e4ea3 
- Rename from `check_vmware_datastore` to
  `check_vmware_datastore_space` in an effort to explicitly
  note the scope of the plugin's functionality
- Update references to the plugin to reflect this change, both
  plugin name and internal constants, variables, functions,
  types, etc.
- Update performance data metric names to reflect the plugin
  rename
- Update CHANGELOG coverage for plugin rename, performance
  data metric changes

refs GH-510
@atc0005 atc0005 added documentation Improvements or additions to documentation contrib CI builds config enhancement New feature or request output/extended Long Service Output (aka, "extended" or "detailed") output/logging output/perfdata Service Perf Data (aka, "performance data") output/summary Service Output (aka, "one-line-summary") and removed question Further information is requested labels Dec 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@atc0005 atc0005

Labels
builds CI config contrib datastore documentation Improvements or additions to documentation enhancement New feature or request output/extended Long Service Output (aka, "extended" or "detailed") output/logging output/perfdata Service Perf Data (aka, "performance data") output/summary Service Output (aka, "one-line-summary")
Projects
None yet
Milestone
v0.28.0
Development

Successfully merging a pull request may close this issue.

Rename check_vmware_datastore plugin atc0005/check-vmware
1 participant
@atc0005