Skip to main content
Sumo Logic

How do I use the binary package to install a Collector on Windows or MacOS?

Use the binary package to install a Collector on MacOS or Windows only if you need to use a particular version of JRE. See Install a Collector on Linux for instructions on using the binary package to install a Collector on Linux.

Before you begin:

Prepare the binary file

  1. Untar the downloaded binary file inside your desired destination directory to create a /sumocollector directory:
    tar -xvf SumoCollector_unix_XXX.tar.gz
  2. Move the platform-specific wrapper file to the /sumocollector/wrapper directory:
    mv /sumocollector/tanuki/<Platform>/wrapper /sumocollector/wrapper
  3. If your platform has a file (Linux) or DLL file (Windows), move the library file to <Sumo Version>/bin/native/lib/.
    mv <Sumo Version>/bin/native/lib/

The following example shows the result:

├── 19.115-21
│ ├── alerts
│ ├── bin
│ │ ├── collector
│ │ ├── jvm.options
│ │ ├── native
│ │ │ |── lib
| | | | └──​
  1. (MacOS only) Make the wrapper and collector files executable:
    chmod ug+x wrapper
    chmod ug+x collector

(Optional) Configure sources

The Collector Management API allows you to pass all Source settings in a JSON file, including Source name, metadata tags, and pointer to the files you want to collect. For instructions, see Using JSON to configure Sources.

Optionally, you can configure Source using the Sumo Logic Web Application after the Collector has been installed.

Create the file

The Collector uses the settings defined in to register and start up.

This example configures basic settings for registration and start-up using access Id and Key for authentication.

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

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

Start the Collector

Use either of the following commands to start the Collector.

sudo ./collector start


To verify that the Collector is installed, go to Manage > Collection in the Web Application and verify that you can see the Collector.