This document is a step-by-step guide for connecting to a MySQL database within BrightGauge.
Step 1 - Log in to your BrightGauge Account
If you haven’t created an account yet, go here to get started.
If you are logged in with a New Account:
From the account Overview page, click on the "Add a Datasource" button:
If you are logged in with an Existing Account:
Click on the Data menu at the top righthand corner of the screen, and select Datasources from the drop-down menu:
Find the MySQL icon under All:
Whether a new or existing account, you'll come to datasource settings screen below. Leave this page open as it will be used in Step 4. You can now proceed to the next steps.
Step 2 - Download and Install BrightGauge Agent
You’ll need to download and configure the BrightGauge Agent. Click Download to download the agent. Documentation to help set up configure the BrightGauge Agent can be found here. Make sure to install the BrightGauge agent on a machine somewhere within the same network as your mySQL database. If you have issues, view the known issues here or contact Support by selecting Help > Open a Ticket from the top menu bar.
Step 3 - Create a SQL User within the Database
After the agent is up and running, you’ll now need to create a SQL user within the MySQL database. Here’s a guide on how to do that. Make sure to enable the user to log into the MySQL database. You’ll need to put the database name into #5 in the screenshot above.
Note: Please make sure that your database password consists of only alphanumeric characters (A-Z or 1-9).
Step 4 - Configure the Datasource Settings
Refer to the screenshot above and match the corresponding numbered fields:
- Name: A name for the connection.
- Agent Host: The computer on which the agent is installed.
- Database Internal IP/Hostname: Internal IP address or hostname for the database server (if using multiple SQL instances, use the IP or machine name followed by a backslash and then the instance name: 192.168.1.100\instance or SQLServer\instance).
- Database Name: The database name (e.g., cwwebapp_brightgauge).
- Database Internal Port: This field is for advanced SQL setups not using the default SQL port (1433). Enter the non-default port in this field. Leave BLANK if using the default SQL port (1433).
- Database Username: Your database username.
- Database Password: Your database password.
Step 5 - Test Connection
After you complete all fields, make sure to test the connection. If successful, save the connection.
Please note, a common issue we have seen clients experience is with the "AutoFill" feature in web browsers inputting the wrong the credentials for the database user field. When a test connection is successful, the page is refreshed and the autofill takes effect automatically without the user realizing. The user then selects save, accidentally saving the autofilled credentials which are incorrect. A way to prevent this issue is to open a private browsing window (or incognito window) to fill out the datasource configuration page, or simply retyping the credentials after the test connection and clicking Save.
Once you’ve saved the connection it's now off to build some new datasets! Help documents for SQL building in BrightGauge can be found here.
Add a User to MySQL
Note: Sometimes, the more efficient way to do this is to create a user in Automate and modify the permissions in SQLYog.
To add a user in SQLYog:
- Click on the User Manager button in the top navigation.
- Click Add New User.
- Enter the Username and Password, then click Create.
- Select the SELECT privilege. then click Save Changes.
If you have any questions, please contact Support by selecting Help > Open a Ticket from the top menu bar.