Connecting to SQL Server (MS-SQL)

This document is a step-by-step guide to connecting to a SQL server within BrightGauge. 


Step 1 - Log in to your BrightGauge Account

If you haven’t created an account yet, go here to get started.

After you log in:

  • New Accounts

On first login, from the account Overview page, click Add a Datasource.

  • Existing Accounts

Select Data > Datasources.


Locate SQL Server under All.


Click on the SQL Server tile to open the datasource settings screen. Leave this page open as it is used in Step 4.



Step 2 - Download and Install BrightGauge Agent

You’ll need to download and configure the BrightGauge Agent so that we can communicate with the SQL Server. The link to download the BrightGauge Agent is on this screen. Documentation to help 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 MS-SQL database. If you have issues, review the known issues or contact Support by selecting Help > Open a Ticket from the top menu bar.


Step 3 - Create a SQL User

After the agent is up and running, you’ll now need to create a local SQL user within the database. Here’s a guide on how to do that. Make sure to enable the user to log into the database. You’ll need to put the database name into the Database Name field.


Step 4 - Configure the Datasource Settings


Refer to the screenshot above and match the corresponding numbered fields:

  1. Name: A name for the connection.
  2. Agent Host: The computer on which the agent is installed.
  3. 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:\instance or SQLServer\instance).
  4. Database Name: The database name (e.g., cwwebapp_brightgauge).
  5. 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).
  6. Database Username: Your database username.
  7. 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 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.

After you save the connection it's now off to build some new datasets! Help documents for SQL building in BrightGauge can be found here.

For additional information, please check out our support forums here.

Was this article helpful?
3 out of 3 found this helpful