Skip to main content
Sumo Logic

Lab 1: Install a Collector

Learn how to install a collector.

To ingest data into Sumo Logic, you must set up one or more collectors and sources. For this tutorial, we’ll show you how to install a collector. In Lab 2  we will set up an Apache Access log source,  and in Lab 3 we will set up a host metric source. 


Before you begin

For the tutorial, we want to make sure you have some basic data to work with. So we’ll start by having you download an Apache log file.  Of course, during normal operations you’ll be sourcing your own log files:

  • Download the file apache_access_logs_tutorial.txt.If clicking the link initially opens the file in a new browser window, right click the link and choose the "Download" or "Save As" option instead.

Install a Collector  

To stream data into Sumo Logic for viewing and analysis, you first set up an installed collector and sources.  An installed collector is a lightweight software package that you install on host machines in your environment to collect data from those machines, and a source specifies the type of data to collect.

We’ll show you how to install a collector from the Collection page, which gives you the most options and flexibility. (You can also use the Setup wizard.)

Sign in to Sumo Logic, if you’re not already signed in.

Download the Collector package 
  1. Sign in to Sumo Logic's training environment, if you’re not already signed in.  From the left navigation pane, select Manage Data> Collection.
  2. On the top right corner, click Add Collector

  3. Click Installed Collector.

  4. Select your operating system (please note this will install a collector on the machine you are performing the labs on).  For this lab, we will show how to install using the UI installer, which is available for Linux, Windows, and macOS. When you click an operating system option, the installation file downloads automatically. After the download completes, you can run the UI installer. 


Install the collector 
  1. Open the downloaded installer file. If prompted, enter the root or Administrator username and password for your local machine. You may want to reposition this wizard popup screen to remain visible. This allows you can toggle back to this popup window.
  2. Click Next on the Welcome page.

  3. Accept the license agreement and click Next.

  4. Browse to select a location for the collector or accept the default and click Next to install the Collector files on your machine. The installer presents a confirmation screen.

  5. Click Advanced Settings.

  6. Change the collector name to  client_<your_intials>. Use the default value for the rest of the settings. If you want to use a different name for any of the settings, take note of them as you will need them when adding a source. 

  7. Click Next.

  8. Click Next at the confirmation screen


  9. Select Access Key as the option to connect the collector to the Sumo Logic service and click Next.


Generate an access key: 
  1. Now let's see how to generate an access key so we can continue this process. From the left navigation pane at the bottom, click your account name, then click Preferences.
  2. Scroll down to the My Access Keys section and click Add Access Key.

  3. Create a Name for the access key. Use client_<your initials>_AK for the Access Key Name then click Create Key .

  4. Sumo Logic generates the Access ID and Access Key. You will copy and paste each one into the add collector wizard. Click Copy for each and toggle back to the UI and paste them in one at a time.  Ensure you have pasted them each one into the add collector wizard. Once you click Done the access id and access key won’t be available again in the UI.


  5. Paste in the Access ID and then copy and paste in the Access Key from the previous step, and click Next.

    Installed Collector 5.png

  6. The installer confirms the connection to the Sumo Logic service and completes the installation. Click Finish to close the installer.

  7. Close the Add Installer Collector dialog to return to the Manage Data > Collection > Collection page. You should now be able to find the collector you have just installed by searching for your initials, if not search for your hostname. 


Good work! You've completed these tasks in Lab 1:

  1. Downloaded a static Apache Access log file to your local machine.
  2. Installed a collector on your local machine.

In Lab 2, you'll learn how to add a source for the collector to collect a particular type of data.