Skip to main content

Threat Detection ManagementThreat Detection Management Guide

Analytics Rules Syntax

When you create an analytics rule or create an exclusion, ensure you use the correct syntax when creating expressions and using functions.

Analytics rule syntax:

  • Is case-insensitive

  • Allows you to nest expressions using parentheses; for example, ((true || false) && (role != "guest")) ensures the expression applies to all users except ones with the guest role.

  • Allows you to reference event fields directly in the expression so the expression dynamically adapts to the actual data it's evaluating; for example, concat(user, "-", src_host) dynamically concatenates the value of user and device as a string.

With analytics rule syntax, you can create expressions that define logical relationships and retrieve, manipulate, and evaluate data for the analytics engine.

  • Advanced Analytics Rule Syntax vs. Analytics Rule Syntax

    Compare the syntax used to write expressions for Advanced Analytics rules in the Fusion and Exabeam Security Operations licenses with the syntax used to write expressions for analytics rules in the New-Scale Security Operations Platform.

  • Logical Expressions

    Define boolean or other logical relationships using analytics rule syntax.

  • String Operations

    Manipulate and evaluate string data using analytics rule syntax.

  • Integer Operations

    Perform mathematical calculations and other operations involving integers using analytics rule syntax.

  • Time Operations

    Retrieve the time of day, day of the week, or day of the month using analytics rule syntax.

  • Network Operations

    Evaluate IP addresses, hosts, and domains using analytics rule syntax.

  • Context Operations

    Evaluate and retrieve data from context tables using analytics rule syntax.

  • Entity Operations

    Evaluate and retrieve entity attributes using analytics rule syntax.

  • Correlation Rule Operations

    Some analytics rules model a correlation rule. These expressions evaluate and retrieve the value of a correlation rule field from event context using analytics rule syntax.