Include connection details from a MySQL server

The mysql collector will validate and add information about a MySQL server to a support bundle.


The mysql collector has the following parameters:

The name of the collector. This is recommended to set to a string identifying the MySQL instance, and can be used to refer to this collector in analyzers and preflight checks. If unset, this will be set to the string "mysql".

uri (Required)

The connection URI to use when connecting to the MySQL server.

Example Collector Definition

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
  name: sample
    - mysql:
        collectorName: mysql
        uri: 'testuser:[email protected](mysql:3306)/dbname?tls=false'

Note: troubleshoot.sh/v1beta2 was introduced in preflight and support-bundle krew plugin version 0.9.39 and Kots version 1.19.0. Kots vendors should read the guide to maintain backwards compatibility.

Included resources

A single JSON file will be added to the support bundle, in the path /mysql/[collector-name].json:

    "isConnected": false,
    "error": "invalid password",
    "version": "5.6.49"



a boolean indicating if the collector was able to connect and authenticate using the connection string provided.


a string that indicates the connection error, if there was one


when connected, a string indicating the version of MySQL that's running

Edit on GitHub