Skip to main content
Sumo Logic

Collector Upgrade Best Practices

We recommend you follow these best practices when upgrading Installed Collectors.

Stay Current

While we make every effort to keep backwards compatibility for collectors, many new collector versions contain important bug fixes along with new functionality, so we recommend keeping up-to-date with collector versions you’re using in your production environments.  You can read the Release Notes for each Collector version here, so you know exactly what changes are made.

Use the Sumo Logic User Interface to Upgrade

When one or more of your Collectors are eligible for an upgrade, you'll be notified through the collectors page in our UI. Follow the instructions to upgrade (or downgrade) as needed.

Upgrade collectors with search

Test Your New Collector in a Staging Environment

We go to great lengths to test each new Collector version before making it generally available to our customers.  However, given the number of small differences possible in customer environments, corner cases can get past our testing and into our generally available Collector versions.  For this reason, we strongly recommend that you always try a new Collector version in a representative staging environment or on a small number of Production servers before rolling out across your entire environment.

Check These 3 Items When Testing Your Collector

Although regressions and new bugs are rare in our Collectors, when they do occur, they typically show themselves in one of a few known ways.  So, after rolling out a new Collector version into a test, staging or fractional production environment, monitor the following things:

  • Observe if the Collector is ingesting roughly the amount of data you expect.  You can monitor this from the Account / Status page.
  • For file-based sources on the new Collector version, ensure the log files are rotating at the frequency you’d expect.
  • For all installed Collectors, observe that the CPU, memory, I/O, and disk space utilization for the Collector process are inline with expectations and past Collector versions.

If you find abnormalities, contact Sumo Logic Support to help investigate before you push the new Collector Version to full production status.

Take a Methodical Approach to Collector Management

Follow this checklist whenever you make any changes to the collector:

  • Have a baseline prior to any changes or updates.
  • Perform any changes within a development or staging environment prior to production. Do this when:
    • Upgrading to a new Collector version.
    • Adding new Sources to a Collector.
    • Modifying existing Collector or Source configurations, such as memory, CPU throttling, etc.
    • Upgrading or patching the host environment.
  • Monitor the staging environment for any significant changes to the following: 
    • Collector service CPU usage patterns
    • Collector service Memory usage patterns
    • Disk I/O and space utilization
  • Validate Collector service operation
    • Upgrade was successful and the Collector is online with the new version.
    • The Collector continues to run over a period of time without errors or failures.
    • Existing Sources continue to read and send data.
    • New Sources read and send data as expected.
  • Validate Host/Application operation
    • Other services on the host continue to operate as expected without errors
  • Make sure your monitoring covers a period of time that also includes any normal maintenance operations of the hosts, such as backups, virus scans, etc. to ensure there are no issues that come up during those specific tasks.