detection

Detections provide a defined structure for queries against logs collected by Tailpipe. These queries look for patterns and anomalies in logs.

Example Usage

You can run a detection from the command line:

Detections can be organized into benchmarks. You can run all detections for a benchmark:

Argument	Type	Optional?	Description
args	Map	Optional	A map of arguments to pass to the query. The args argument may only be specified for detections that specify the query argument.
database	String	Optional	A database connection reference, connection string, or Pipes workspace to query. If not specified, the default database will be used.
description	String	Optional	A description of the detection.
documentation	String (Markdown)	Optional	A markdown string containing a long form description, used as documentation for the mod on hub.powerpipe.io.
param	Block	Optional	A param block that defines the parameters that can be passed in to the detection's query. param blocks may only be specified for detections that specify the sql argument.
query	Query Reference	Optional	A reference to a query resource that defines the detection query to run. A detection must either specify the query argument or the sql argument, but not both.
sql	String	Required	An SQL string that returns rows found by the detection's query. A detection must either specify the query argument or the sql argument, but not both.
tags	Map	Optional	A map of key:value metadata for the benchmark, used to categorize, search, and filter. The structure is up to the mod author and varies by benchmark and provider.
title	String	Optional	Display title for the detection.