Skip to main content
Sumo Logic

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

Download

Download the Collector in either of the following ways:

  • In Sumo Logic choose Manage > 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 pod. If you're not sure which pod you're using, check the login page (US2, EU, or AU appears in the URL for those pods; only US1 is not included in the URL). The download begins immediately. See Download a Collector from a Static URL for a list of the URLs for your Linux version and pod.

Install

Install the Collector using either of the following methods:

After installing Collectors, you can configure Sources by using the Web Application or by providing the Source settings in a JSON file. If you are using a 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.

Install 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.

  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.
  • Setup Wizard Token: If Sumo Logic has provided you with a token for the UI Installer, click Next, enter the token, and click Next.
  • Access Key: If you have a Sumo Logic access ID and key, click Next, enter the access ID and key, and click Next.
  1. Click Finish to complete the setup.
  2. Go to Manage > Collection in the Web Application 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.

Install 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.
  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
  1. 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 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

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.
  1. Remove the Collector from the Sumo Logic Web Application.

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
  1. Run the JavaApplicationStub binary with the -q option. The -q option executes the command without presenting additional prompts.
    Example:
sudo Sumo Logic Collector Uninstaller.app/Contents/MacOS/JavaApplicationStub -q

Delete the Collector from the Web Application

  1. In the Sumo Logic Web Application, go to Manage > 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.