Skip to main content
Sumo Logic

Script Source

If you need to collect data that isn't stored in log files (like system performance metrics, database records, or perhaps data output from third-party monitoring solutions) you can use a Script Source that uses a script to fetch those custom sources of data. The script executes at defined intervals and then sends the data to Sumo Logic for analysis. A Script Source allows you to collect all sorts of data from any supported OS, including data from command-line tools (for example, as iostat) or transient or unstable data sources.

Once a Script Source is configured, access to the machine running the Collector associated with the Source is granted to all Sumo Logic users with roles that include Collector management.

Preparing your script

Collecting from a Script Source depends on a well-constructed script. When considering the data you'd like to collect through a script, keep the following in mind:

  • The script must run on the host computer; remote scripts won't result in data collection. The Script Source assumes that the Collector is running the host where the script is executed. However, the script itself can connect to remote hosts to gather relevant information.
  • Supported script types:
    • .bat (Windows only)
    • Visual Basic (Windows only)
    • Ruby
    • Python
    • Perl
    • csh
    • bash
  • Wildcards are not supported in these scripts.

Configuring a Script Source

To configure a Script Source:

  1. In Sumo Logic select Manage Data > Collection > Collection (Manage > Collection in the classic UI).
  2. Find the name of the installed Collector to which you'd like to add a Source. Click Add... then choose Add Source from the pop-up menu.
  3. Select Script for the Source type.
  4. Enter a Name to display for the new Source. Description is optional. Source name metadata is stored in a searchable field called _sourceName.
  5. For Source Host, enter the hostname or the IP address of the machine. The hostname is stored in a searchable field called _sourceHost. The hostname can be a maximum of 128 characters.
  6. For Source Category, enter any information you'd like to include in the metadata.
  7. For Frequency, choose one of the following:
    • An option to run the script at the selected frequency.
    • Other (CRON Expression) if you'd like to set a customized frequency using a CRON Expression, then type the CRON Expression in the Expression text box.

    Using a CRON Expression allows you to specify an exact time for your script to run, like each day at 2:15 pm, or Monday through Friday at midnight. (Learn more about supported CRON Expressions.)

  8. If you'd like to set a timeout for your script, select Specify a timeout for your command. If you don't need a timeout, or if you're running a script once daily, we recommend that you leave this option deselected. 
  9. For Command, choose the type of command you're going to use. The options in this menu depend on the type of Collector you're using:


    Mac/Linux options.


    Windows options. 
    There is a workaround for PowerShell.
  10. For Script, do one of the following:
    • Choose Type a path to the script to execute if you have the script saved to a file location. For example:

      Script Path
       
    • OR, choose Type the script to execute if you'd like to enter the script directly in the Sumo Logic Web Application. Then type the script in the text box. For example:

      Script
  11. For Working Directory, you'll only need to enter a path if your script refers to a file indirectly. So, enter the path of the file you'd like to collect if required; otherwise, this option can remain blank.
  12. Under Advanced you'll see options regarding timestamps and time zones:
    • Timestamp Parsing. By default Extract timestamp information from log file entries is selected, meaning that we use the timestamp information from the data you collect. Deselecting this option turns off all timestamp parsing.
    • Time Zone. Select an option under Use time zone from log file, but if none present use. Or, if you'd like to override all time zones from data you collect, choose an option under Ignore time zone and instead use.
  13. For Multiline Processing, by default only Boundary Regex is selected. To make any changes to this setting, select Detect messages spanning multiple lines only if the type of data you're collecting is suited to being collected as multiline log messages.
  14. If you'd like to filter data being collected, set Processing Rule options. See Creating Processing Rules for more information.
  15. Click Save to complete the Source setup.

Hash and Mask filters can be used to obfuscate proprietary information included in data collected from a Script Source.

When should I set a timeout for my script?

A timeout essentially allows a grace period for a script to finish. Without it, when the next run of the script is scheduled to go, and the script hasn't finished, the Collector will kill the script before running it again. If you're running a long script that needs to complete on its own, setting a timeout will cancel the next scheduled run (and all subsequent ones that fall within the timeout period). However, after the timeout, it's important to note that if the script still hasn't finished, it will be killed by the Collector.