This article describes how to install and configure the BrightGauge agent. The agent is used to connect on premises datasources to BrightGauge. The agent runs as a service on the host computer and transfers data between systems using 2048-bit SSL encryption.
Installing the agent consists of the following steps:
- Configure firewall rules for the agent.
- Select a host computer on which to install the agent.
- Download the agent from BrightGauge.
- Install the agent on the host computer.
- .NET 4.0
- 500MB available RAM (2GB+ recommended)
Note: This is a free requirement as the agent temporarily stores data in RAM after receiving it from your SQL server and before passing it to BrightGauge.
- Consistent uptime
- Windows Server® 2008 R2 or later for servers
- Windows® 7 or later for workstations
Configure Firewall Rules
The agent requires inbound communication from BrightGauge through its own dedicated port. Port 2666 is recommended. The port must not be in use by any other service or tool. All communications from BrightGauge are sent from the following IP addresses (be sure to create exceptions for both):
You must also create a NAT route on your firewall to direct traffic from the BrightGauge public IP address on the specified port to the internal IP address of the device you have chosen to install the agent on.
Note: If you are setting up more than one agent on the same network, ensure that each agent uses a different port and has its own NAT route.
Windows Firewall may block traffic even if the firewall is disabled. Please create an advanced port exception in the firewall on the machine you choose to install the agent on.
Select a Host
Select a machine (either a Windows server or workstation) that has access to the servers where your database is installed. For best results with data syncs, it is recommended to install the agent directly on the database server. If this is not an option, the agent can be installed on any other machine that meets the system requirements. It is recommended to install one agent per datasource, though one agent can be used for multiple datasources if all datasources are all on the same internal network.
To configure the agent, you must have the following information:
- Your BrightGauge subdomain, username, and password.
- IP Address: Your public IP address.
- Port: The port you specified for the BrightGauge agent.
- Local IP: The local IP address of the agent computer. If the computer is exposed to the internet, use the computer's public IP address.
Download and Install the Agent
To download and install the agent:
- Log in as an administrator to the device you have chosen to be the host.
- Log in to your BrightGauge account.
- Navigate to the Data > Datasources.
- Select Add A New Datasource.
- Select the appropriate datasource from the list.
- Click the BrightGauge Agent link to download the agent.
- Extract the contents of the downloaded agent file.
- Right-click the executable file and select Run as administrator.
- Follow the install prompts. Be sure to select to install for Everyone when prompted.
- Enter your BrightGauge Subdomain, Username, and Password.
- Enter the host computer's IP Address, Port, and Local IP.
- Click Test Connection.
- After a successful connection, click Save & Start Service.
- After the install completes, right-click the BrightGauge Manager icon on the desktop and select Properties.
- Select the Compatibility tab.
- Click Change settings for all users.
- Select the Run this program as an administrator checkbox.
- Click Apply.
- Click OK.
If you're having issues connecting or have questions here are a few documents that can help:
- Common Agent Connectivity Issues
- Windows Firewall Inbound Rule for the Agent
- Multiple Databases, how many agents are needed?
Of course, if those links don't help, feel free to drop us a line using this link or email us at firstname.lastname@example.org