Skip to main content
Sumo Logic

Install a Collector on Linux

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

System Requirements 

  • Linux, major distributions, 32-bit or 64-bit, or any generic Unix capable of running Java 1.8
  • Single core, 512MB RAM
  • 8GB disk space

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 pod. If you're not sure which pod you're using, check the login page (US2, EU, AU, or DE 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 a collector on Linux

Choose one of these methods to install the Collector:

You can build a Collector into a Linux machine image such as an Amazon AMI or VMware image.

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 UTF-8 encoded JSON file, you must provide the file before starting the collector. The JSON file needs to be UTF-8 encoded.

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

Install using the command line installer

  1. Add execution permissions to the downloaded Collector file (.sh):

    chmod +x SumoCollector.sh

  2. Run the script with the parameters that you want to configure. See Parameters for the Command Line Installer for a description of the parameters.  By default the Collector will be installed in either /opt/SumoCollector or /usr/local/SumoCollector.

Examples 

Using access ID and access key:

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

Adding proxy settings:

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

Including syncSources and a customized Collector name:

sudo ./SumoCollector.sh -q -Vsumo.accessid=<accessId> -Vsumo.accesskey=<accessKey> -VsyncSources=<filepath> -Vcollector.name=<name>

Install using the RPM or Debian package

You can use the RPM or Debian package to install a Collector on a Linux 64-bit system.

  1. Install the Collector using the downloaded installation package.
    For the RPM package, use the command:

    sudo rpm -i SumoCollector-19.XXX-XX.x86_64.rpm

    For the Debian package, use the command:

    sudo dpkg -i SumoCollector-19.XXX-XX.x86_64.deb

    The RPM and Debian packages install the collector in the /opt/SumoCollector directory.  By default, the Collector is installed as a system service, but not yet started.
  2. Configure the Collector  user.properties file in the /opt/SumoCollector/config/ directory. The Collector uses the settings defined in user.properties to register and start. Add entries in the following format for registration and start-up using access ID and access key for authentication.

    Example user.properties file:

name = [My Collector]
accessid = [accessId]
accesskey = [accessKey]

See user.properties for a full list of all the supported parameters.

  1. (Optional) Set the run a user for the Collector if you want the Collector to run as a user other than root. See run as for a Collector.
  2. Start the Collector using the following command.

    sudo service collector start

Install using the binary package

  1. Install the version of JRE you want to use from the following location. (The collector requires Java 8 or higher). The binary installation process does not include JRE installation.

    http://www.oracle.com/technetwork/ja...ads/index.html

  2. Check the version of Java is 8 or higher:

    java -version

  3. Untar the downloaded binary file inside your desired destination directory to create a subdirectory named sumocollector:

    tar -xvf SumoCollector_unix_XXX.tar.gz

  4. Copy the platform-specific wrapper file to the sumocollector directory:

    cp /sumocollector/tanuki/wrapper-<platform>/sumocollector

  5. Make the wrappercollector, and script directory files executable:

    chmod ug+x wrapper
    chmod ug+x collector
    chmod ug+x script/*

  6. Create the user.properties file under config directory and add the settings you want to specify for the installation.

    This example user.properties file configures basic settings for registration and start-up using the access ID and key for authentication.

    name = My Collector
    accessid = [accessId]
    accesskey = [accessKey]
    wrapper.java.command = java

    See user.properties for a full list of all the parameters that you can add to the file.

  7. Set access control for files under the sumocollector directory:

    sudo script/secureFiles.sh

  8. (Optional) Provide the JSON Source information.
    You can pass all Source settings in a UTF-8 encoded JSON file. If you are using a JSON file, you must provide the file before starting the Collector. See Using JSON to configure Sources.

    Alternatively, you can configure sources at any time by using the Sumo web app. See Sources.

  9. (Optional) Set the run as user for the Collector if you want the Collector to run as a user other than root. See run as for a Collector.
  10. Install the Collector as a service.
    Use the following command to install the Collector as a service that is started when the machine starts.

    sudo /sumocollector/collector install

  11. Start the Collector service.
    Use the following command to start the collector service.

    sudo /sumocollector/collector start

  12. To verify that the collector is installed, go to Manage Data > Collection > Collection in the Sumo web app and verify that you can see the collector.

Uninstall the collector

Uninstalling a collector requires the following two steps:

  1. Uninstall the collector from the Linux system using any of these methods:
  1. Remove the collector from the Sumo Logic Web Application

Uninstall using the UI Installer

  1. On your system, in the Applications folder, find the Sumo Logic Collector folder.
  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 using the command line

  1. In a terminal prompt, change the directory to the collector installation directory. By default, the collector will be installed in either /opt/SumoCollector or /usr/local/SumoCollector.

    cd /usr/local/SumoCollector

  1. Run the uninstall binary with the -q option. The -q option executes the command without presenting additional prompts.

    sudo ./uninstall -q

Uninstall using the RPM/Debian packages

For the RPM package, use the command:

sudo rpm -e SumoCollector

For the Debian package, use the command:

sudo dpkg -r SumoCollector

Uninstall using the binary package

  1. Uninstall the collector service.

    sudo <Collector Installation Directory>/collector remove

  2. Remove the collector installation directory.

    sudo rm -rf <Collector Installation Directory>

  3. (Optional) On some distributions, for instance, Ubuntu, you may need to re-synchronize the daemon setting before installing the collector again.

    sudo systemctl daemon-reload

Remove the collector from the web app 

  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.