In most cases, a Wavefront proxy must be running in your installation before metrics begin streaming to Wavefront from a host or application.
We offer several deployment options. During development, a single proxy is often sufficient for all data sources. In production, place a team of proxies behind a load balancer.
Proxy Host Requirements
- Internet access - run
timeout 3s curl -fIsS <wavefront_api_url>
from the host and make sure you get a response and not a timeout. - Networking - For metrics, the proxy uses port 2878 by default. Make sure this port is reachable from other machines on your network. If you want to change this default, the proxy configuration file has options.
- Memory - The proxy does not use a lot of CPU, memory, or storage. However, we recommend running the proxy on a host with at least 4GB of free memory.
- Operating system - Wavefront proxy is a Java application and can run on operating systems supported by Java. Java 8 or later is required, the latest version of Java is recommended.
Install a Proxy
Many users install a proxy when they set up an integration. You can also install a proxy from the UI or perform a scripted installation.
Install a Proxy from the UI
To install and run a proxy:
- Log in to your Wavefront instance and select Browse > Proxies.
- Select Add > New Proxy at the top of the filter bar.
- Click the [Linux | Mac | Windows | Docker ] tab.
- (Windows Only) Download the proxy.
- Copy the script and run it on your host.
Note: On Windows, do not run the installer
.exe
file. Run the script instead. - After the proxy contacts the Wavefront service, the proxy name displays under “Checking for new proxies…”.
- Click Done.
- Select Browse > Proxies and verify that your proxy is listed.
The proxy starts listening on port 2878. You can customize listener ports with the proxy configuration file.
Scripted Proxy Installation
You can use steps in an integration or perform a package install.
- Select Browse > Integrations and find the host integration (Mac, Windows, or Linux). The Setup tab give the installation script. For Mac and Linux, you can install the proxy with or without the Telegraf agent.
- To perform a package install, see Installing a Proxy manually.
Manage Proxy Services
After installing a proxy, you can start and stop the proxy service, check service status, and view the logs that are generated by the service. See Logging for customizing your proxy, including its log configuration options.
Start and Stop a Proxy
Run the following commands on the proxy host:
OS | Instructions |
---|---|
Linux | service wavefront-proxy [start | stop | restart] |
Windows |
cd C:\Program Files (x86)\Wavefront\bin
./nssm.exe [start | stop] WavefrontProxy
|
Mac OS | brew services [start | stop | restart] wfproxy |
Docker | docker [start | stop ] <proxy_container_id> |
Check Proxy Service Status
To check if the proxy is running, run the following commands on the proxy host:
OS | Instructions |
---|---|
Linux | service wavefront-proxy status
Proxy log at |
Windows |
cd C:\Program Files (x86)\Wavefront\bin
./nssm.exe status WavefrontProxy
Proxy log at |
Mac OS | brew services list
Proxy log at |
Test a Proxy
You can test that a proxy is receiving and sending data as follows:
-
Send data by running the following command:
echo -e "test.metric 1 source=test_host\n" | nc <wavefront_proxy_address> 2878
where
<wavefront_proxy_address>
is the address of your Wavefront proxy. - In the Wavefront UI, select Browse > Metrics.
- In the Metrics field, type
test.metric
. - Click
test.metric
to display a chart of the metric.
Upgrade a Proxy
Wavefront frequently releases new proxy versions with new features. See the Wavefront proxy github page for details.
Upgrade from the UI
To upgrade from the UI, select Browse > Proxies > Add New Proxy. If an older version of the proxy exists, this process replaces it.
Upgrade from the Command Line
For Linux and Mac OS, can also upgrade a proxy from the command line as follows:
OS | Instructions |
---|---|
Linux | sudo apt-get update && sudo apt-get install wavefront-proxy |
Linux (RPM) | yum update wavefront-proxy
|
Mac OS | brew update && brew upgrade wfproxy |
Uninstall a Proxy
When you upgrade a proxy, we uninstall the older version for you. You can also uninstall a proxy explicitly:
OS | Instructions |
---|---|
Windows | The precise process depends on the version of Windows you're using. You follow the process for uninstalling programs.
|
Linux | sudo apt-get remove wavefront-proxy
sudo apt-get remove telegraf |
Linux (RPM) | sudo yum remove wavefront-proxy
sudo yum remove telegraf |
Mac OS | bash -c "$(curl -s https://raw.githubusercontent.com/wavefrontHQ/homebrew-wavefront/master/sh/uninstall.sh)" |
See Also
Advanced users can export proxy data to a file and perform other customizations.
- Export Data Queued at the Proxy
- Install a Proxy in Non-Default Environments
- Use the proxy configuration file to customize proxy behavior for metrics, histograms, and traces.