<commit_before># Boundary MySQL Plugin

Collects metrics from a MySQL database instance. See video [walkthrough](https://help.boundary.com/hc/articles/201536772).

### Prerequisites

#### Supported OS

|     OS    | Linux | Windows | SmartOS | OS X |
|:----------|:-----:|:-------:|:-------:|:----:|
| Supported |   v   |    v    |    v    |  v   |

#### Boundary Meter versions v4.2 or later

- To install new meter go to Settings->Installation or [see instructions](https://help.boundary.com/hc/en-us/sections/200634331-Installation).
- To upgrade the meter to the latest version - [see instructions](https://help.boundary.com/hc/en-us/articles/201573102-Upgrading-the-Boundary-Meter).

#### For Boundary Meter earlier than v4.2

|  Runtime | node.js | Python | Java |
|:---------|:-------:|:------:|:----:|
| Required |    +    |        |      |

- [How to install node.js?](https://help.boundary.com/hc/articles/202360701)

### Plugin Setup

None

#### Plugin Configuration Fields

#### For All Versions

|Field Name |Description                                                                                           |
|:----------|:-----------------------------------------------------------------------------------------------------|
|Host   |The hostname of the MySQL Server (Socket Path or Hostname is required)                                |
|Port       |Port to use when accessing the MySQL Server                                                           |
|Username   |Username to access the MySQL database (Username is required)                                          |
|Password   |Password to access the MySQL database (Password is required)                                          |
|Poll Interval | How often (in milliseconds) to poll for metrics |
|Source     |The Source to display in the legend for the mysql data.  It will default to the hostname of the server|

### Metrics Collected

#### For All Versions

|Metric Name              |Description                                                                   |
|:------------------------|:-----------------------------------------------------------------------------|
|MySQL Connections        |The number of connection attempts                                             |
|MySQL Aborted Connections|The number of failed connection attempts including those aborted by the client|
|MySQL Bytes In           |bytes in                                                                      |
|MySQL Bytes Out          |bytes out                                                                     |
|MySQL Slow Queries       |The number of queries that have taken more than long_query_time seconds       |
|MySQL Row Modification   |The number of requests to insert/update/delete a row                          |
|MySQL Row Reads          |The number of requests to read a row                                          |
|MySQL Table Locks        |The number of table locks granted                                             |
|MySQL Table Wait Locks   |The number of table locks that required a wait                                |
|MySQL Commits            |The number commits                                                            |
|MySQL Rollback           |The number rollbacks                                                          |
|MySQL Query Memory       |The percentage of used query memory                                           |
|MySQL Query Cache Hits   |The percentage of queries from cache                                          |
|MySQL Query Cache Prunes |The number of queries delete from the query cache                             |

### Dashboards<commit_msg>Remove references to meter's prior 4.2 release ; clean up<commit_after># Boundary MySQL Plugin

Collects metrics from a MySQL database instance. See video [walkthrough](https://help.boundary.com/hc/articles/201536772).

### Prerequisites

#### Supported OS

|     OS    | Linux | Windows | SmartOS | OS X |
|:----------|:-----:|:-------:|:-------:|:----:|
| Supported |   v   |    v    |    v    |  v   |

#### Boundary Meter versions v4.2 or later

- To install new meter go to Settings->Installation or [see instructions](https://help.boundary.com/hc/en-us/sections/200634331-Installation).
- To upgrade the meter to the latest version - [see instructions](https://help.boundary.com/hc/en-us/articles/201573102-Upgrading-the-Boundary-Meter).

### Plugin Setup

None

#### Plugin Configuration Fields

|Field Name   |Description                                                                                           |
|:------------|:-----------------------------------------------------------------------------------------------------|
|Host         |The hostname of the MySQL Server (Socket Path or Hostname is required)                                |
|Port         |Port to use when accessing the MySQL Server                                                           |
|Username     |Username to access the MySQL database (Username is required)                                          |
|Password     |<PASSWORD> the MySQL database (Password is required)                                          |
|Poll Interval|How often (in milliseconds) to poll for metrics                                                       |
|Source       |The Source to display in the legend for the mysql data.  It will default to the hostname of the server|

### Metrics Collected

#### For All Versions

|Metric Name              |Description                                                                   |
|:------------------------|:-----------------------------------------------------------------------------|
|MySQL Connections        |The number of connection attempts                                             |
|MySQL Aborted Connections|The number of failed connection attempts including those aborted by the client|
|MySQL Bytes In           |bytes in                                                                      |
|MySQL Bytes Out          |bytes out                                                                     |
|MySQL Slow Queries       |The number of queries that have taken more than long_query_time seconds       |
|MySQL Row Modification   |The number of requests to insert/update/delete a row                          |
|MySQL Row Reads          |The number of requests to read a row                                          |
|MySQL Table Locks        |The number of table locks granted                                             |
|MySQL Table Wait Locks   |The number of table locks that required a wait                                |
|MySQL Commits            |The number commits                                                            |
|MySQL Rollback           |The number rollbacks                                                          |
|MySQL Query Memory       |The percentage of used query memory                                           |
|MySQL Query Cache Hits   |The percentage of queries from cache                                          |
|MySQL Query Cache Prunes |The number of queries delete from the query cache                             |

### Dashboards
{'fraction_non_alphanumeric': 0.1351764378994165, 'fraction_numerical': 0.009863851069741594, 'mean_word_length': 1.0830439814814814, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 6, 'https://': 7, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 58, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '33349', 'n_tokens_mistral': 1487, 'n_tokens_neox': 1394, 'n_words': 574}