Install a Collector on macOS

Follow the steps in this topic to install or uninstall a Collector on macOS. See Installed Collectors for information on other OSs.

System Requirements

• macOS 10.X
• Single core, 512MB RAM
• 8GB disk space

note

If your machine has already had an Installed Collector installed in the past and you want a fresh install, you'll need to delete the previously installed base application folder path /Application/Sumo Logic Installer before installing.

Download

Download the Collector in either of the following ways:

• In Sumo Logic, select Manage Data > Collection > Collection. Click Add Collector, click Installed Collector, and then click the link for the Collector to begin the download.
• Open a browser and enter the static URL for your Sumo deployment. See how to determine which endpoint to use if you are unsure. The download begins immediately. See Download a Collector from a Static URL for a list of URLs for your deployment pod.

Install Collector

Install the Collector using either the UI or command line method.

After installing the Collector, you can configure Sources from Sumo Logic or by providing the Source settings in a JSON file. If you're using a UTF-8 encoded JSON file, you must provide the file before starting the Collector.

If necessary, you can use the binary package to install a Collector on macOS. See this Collector FAQ topic for details.

Using the UI installer 

Run the installer on your server with root or Administrator privileges. If you are not logged in as root or Administrator, you might be prompted to reauthenticate to your system when you start the UI Installer.

note

This method does not support all advanced settings.

1. Open the downloaded installer file.
2. If prompted, enter the root or Administrator user name and password for the system.
3. Open the wizard to show the Welcome page. Click Next.
4. Accept the license agreement and click Next.
5. Browse to select a location for the Collector or accept the default and click Next to install the Collector files on your machine.
6. The Installer displays the summary of the default settings. If you want to change any of these, click Advanced UI Installer Settings and follow the instructions. Click Next.
7. Choose an authentication method.
   • Access Key. If you have a Sumo Logic access ID and key, click Next, enter the access ID and key, and click Next.
   • Installation Token. The Setup Wizard has not yet been updated to provide an option for Installation Tokens. You can provide the Installation Token using the Setup Wizard Token option. Enter the Token String you want to use to register the Collector in the input box for a Setup Wizard one-time token.
8. Click Finish to complete the setup.
9. In Sumo Logic, select Manage Data > Collection > Collection and verify that you can see the Collector. Look for the name that is listed as Collector Name in the confirmation step of this procedure (the name can be customized under Advanced Settings). If a Collector with that name already exists, a suffix is appended to uniquely identify it. If you don’t see the Collector, check the Error Codes list to help troubleshoot.

Using the command line installer 

Quiet mode performs the same installation steps as the UI installer, but runs in the background and doesn’t require any user interaction while it is running. It is useful for scripting an automated installation of multiple Collectors.

Specify the installation parameters on the command line, or create a variables file (varfile) to call from the command line. See Parameters for the Command Line Installer for a description of the parameters.

1. Open the downloaded installer file to mount it.

   open /Volumes/SumoCollector/Sumo\ Logic\ Collector\ Installer.app
2. In a terminal prompt, change the directory to the Java class within the mounted location:

   cd /Volumes/SumoCollector/Sumo\ Logic\ Collector\ Installer.app/Contents/MacOS/
3. Run the JavaApplicationStub binary with the parameters that you want to configure. See Parameters for the Command Line Installer for a description of the parameters.

Examples

Using an Installation Token:

sudo ./JavaApplicationStub -q -Vsumo.token_and_url=<installationToken>

Using access ID and access key:

sudo ./JavaApplicationStub -q -Vsumo.accessid=<accessId> -Vsumo.accesskey=<accessKey>

Using access ID and access key with proxy settings:

sudo ./JavaApplicationStub -q -Vsumo.accessid=<accessId> -Vsumo.accesskey=<accessKey> -Vproxy.host=<proxyHost> -Vproxy.port=<proxyPort>

Uninstall Collector

If you uninstall a Collector, no more data is sent to Sumo Logic from that machine. Uninstalling a Collector doesn't cancel your Sumo Logic account or delete any data from Sumo Logic.

Uninstalling a Sumo Logic installed Collector requires the following steps:

1. Uninstall the Collector from the host machine using either of these methods.
   • Uninstall using the installer
   • Uninstall from the command line
2. Delete the Collector from Sumo Logic.

Uninstall using the installer

1. On your system, in the Applications folder, find the folder Sumo Logic Collector.
2. Double-click the file Sumo Logic Collector Uninstaller.
3. If prompted, select your language and click OK.
4. Enter the user name and password for the system.
5. When the Sumo Logic Collector Uninstall wizard is displayed, click Next to remove the Collector.
6. When the success message is displayed, click Finish.

Uninstall from the command line

1. In a terminal prompt, change the directory to the Collector installation directory. Example:

   cd /Applications/Sumo\ Logic\ Collector
2. Run the JavaApplicationStub binary with the -q option, which executes the command without presenting additional prompts. Example:

   sudo Sumo\ Logic\ Collector\ Uninstaller.app/Contents/MacOS/JavaApplicationStub -q

Delete the Collector from Sumo Logic

1. In Sumo Logic, select Manage Data > Collection > Collection.
2. Find the Collector you want to remove, and click Delete.
3. When the Confirm dialog displays, click OK.

A success message is displayed and the Collector is removed from the list.

Troubleshooting

note

This issue only applies to Collector versions prior to 19.361-8.

When you try to install a Sumo Logic Collector on a Mac running OS X Mountain Lion or later, you may see the error message "App cannot be opened because it is from an unidentified developer". This message appears to prevent installing applications from developers that aren't verified through the Mac App Store:

This doesn't mean that you cannot install a Sumo Logic Collector. The Sumo Logic Collector app is a legitimate and safe download. It just takes an extra step.

To install a Sumo Logic Collector:

1. Control + click (or right-click) the Sumo Logic application icon and choose Open.
   
2. In the next dialog, click Open. This will allow the Collector to install.