Skip to main content
Sumo Logic

LogCompare Syntax

The logcompare operator allows you to compare two sets of logs: baseline (historical) and target (current). To run a LogCompare operation, you can use the LogCompare button on the Messages tab to generate a properly formatted query.

The syntax of the LogCompare operator is described here. For examples of syntax used with saved baselines, see LogCompare Saved Baseline Options.

LogCompare Syntax

  • ... | logcompare timeshift -24h
    Compare the result of a query with the result of the same query for a time range shifted by 24 hours.
     
  • ... | logcompare timeshift -1d
    Compare the result of a query with the result of the same query for a time range shifted by 1 day. (Same as previous example.)
     
  • ... | logcompare start_time 2016-01-06T12:00:00-08:00 end_time 2016-01-07T12:00:00-08:00
    Compare the result of a query with the result of the same query for a time range specified by start_time and end_time. This must be a valid time range. 
     
  • _sourceHost=cluster-1| logcompare timeshift -0s baseline(_sourceHost=cluster-2)
    Compare logs on two different hosts (cluster-1 and cluster-2) for the same time period.

New Hidden Fields

These fields are generated by the logcompare operator, and can be used in the following logcompare operator query string.

These fields are described in the following table:

Field Description

_count

The number of log messages that belong to this cluster for this query.

_deltaPercentage

The percent change of the signature, calculated as (targetPercentage - baselinePercentage) / baselinePercentage, where baselinePercentage is the number of logs matched to the signature divided by the total number of logs in the baseline, and similarly for targetPercentage. This is infinity for new signatures.

_anomalyScore

The value is calculated using a symmetric version of Kullback-Leibler divergence score.

_isNew

Values are Boolean.1 if the cluster is new, otherwise 0.

Using Hidden Fields

 

When you use the logcompare operator, new hidden fields are created that you can use to focus your results. Here's how you can use these fields.

Show only signatures that are missing in the baseline query:

For example, you can run the query:

error | logcompare prod/search-error-baseline/2016-01 | where (_isNew)

The query results are constrained to new clusters only using the _isNew field.

Show only signatures that are missing in the target query:

And in this example, the logcompare operator shows only clusters that no longer include any messages:

error | logcompare prod/search-error-baseline/2016-01 | where _count ==0

LogCompare Saved Baseline Options

 

Syntax:

  • ... | logcompare <path> 
    Compare current signatures with the saved ones.

As logcompare <path> is an alias for summarize delta <path>, you may also use summarize in the syntax:

Syntax: 

  • ... | summarize delta <path> 

Options:

  • update
  • purge
  • nopurge

When you use the LogReduce operation and click the Save Baseline button, thelogreduce save /path/ to/baseline/baseline_name operation is performed. When this baseline is saved, you can recall it and use these options: updatepurge, and nopurge. See the following use case examples.

Update the saved baseline.

When you use the update option, empty clusters older than seven days are purged and the new LogReduce results are saved as the baseline. The syntax is as follows:

error | logcompare prod/search-error-baseline/2016-01 update

Overwrite the baseline and remove empty clusters.

You can combine update and purge to overwrite the baseline and remove empty clusters at the same time. With the purge option, you can set a specific time period other than seven days to purge empty clusters. The syntax for the time expression is relative to now.

In this example, we are updating the baseline and purging clusters older than three days:

error | logcompare prod/search-error-baseline/2016-01 update purge 3d

Keep empty clusters indefinitely.

Additionally, you have the option to keep empty clusters indefinitely using the nopurge option:

error | logcompare prod/search-error-baseline/2016-01 update nopurge