Giters

sensu-plugins / sensu-plugins-mysql

This plugin provides native MySQL instrumentation for monitoring and metrics collection, including: service health, database connectivity, `InnoDB` locks, replication status, metrics collection, and sending metrics to a MySQL database.

Home Page:http://sensu-plugins.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

`metrics-mysql.rb` should be renamed to indicate it is a handler

majormoses opened this issue · comments

commented

Discovered in #63:

In order to help users quickly identify and start using various components we have a naming convention for files:

  • check-*: indicates that it is a non metric check
  • metric-*: indicates that it is a metric check
  • handler-*: indicates that it is a handler
  • mutator-*: indicates that it is a mutator

I am not sure this is actually documented anywhere but it really needs to be (I will create another issue for that).

The file is named metrics-mysql.rb only after looking at the code did I realize it was not a metrics gatheror for mysql it was a handler to send metric data to mysql. To avoid confusion in a major release we should rename it to better reflect its nature, I am open to ideas but this is my initial thought:

  • handler-mysql-metrics.rb
  • handler-mysql.rb

@sensu-plugins/commit-bit any thoughts?

commented

Naming is documented at https://github.com/sensu-plugins/documentation/blob/master/docs/developer_guidelines.md#naming-conventions. 👍 to renaming. handler-mysql-metrics.rb sounds good.

commented

So it is I actually opened that document and somehow skipped right over it. I am glad we do as I was very confused as I recalled seeing something. Great I will re-purpose the issue to expand on it a bit.