Skip to content

Commit

Permalink
proofread
Browse files Browse the repository at this point in the history
  • Loading branch information
judell committed Jan 30, 2025
1 parent ccadb49 commit 3bb2ce6
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 20 deletions.
16 changes: 3 additions & 13 deletions docs/build/writing-detections.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Writing Detections

Many detections and benchmarks are available in [mods on the Powerpipe Hub](https://hub.powerpipe.io/). However, if these don't meet your needs, Tailpipe makes it easy to create your own detections and benchmarks to tailor solutions to *your* organization.

This guide introduces the core concepts for creating detections and benchmarks
This guide introduces the core concepts for creating detections and benchmarks.

## What are Detections?

Expand All @@ -18,18 +18,8 @@ Let's build a simple detection for monitoring AWS CloudTrail logs, and wrap it i

### Prerequisites

1. [Download and install Tailpipe](https://tailpipe.io/downloads).
2. A download of the CloudTrail logs you want to analyze.
3. A `~/.tailpipe/config/aws.tpc` your logs configured as a data source. For example, assuming you have downloaded events to `~/tailpipe`

```
partition "cloudtrail" "cloudtrail_log" {
source "file_system" {
paths = ["~/tailpipe"]
extensions = [".json"]
}
}
```
1. [Tailpipe](https://tailpipe.io/downloads)
2. A [configuration](https://tailpipe.io.vercel.app/docs#configure-data-collection) for CloudTrail logs

### Create a Detection

Expand Down
6 changes: 3 additions & 3 deletions docs/learn/tailpipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ The AWS plugin documentation provides additional examples to [configure your cre

## Collect log data

Powerpipe mods for Tailpipe work with tables built from log data collected by Tailpipe. The Tailpipe docs show you how to [configure](https://tailpipe.io/docs#configure-data-collection) to configure the AWS plugin for Tailpipe and then [collect](https://tailpipe-io.vercel.app/docs#configure-data-collection) log data. Follow those steps create the table `aws_cloudtrail_log`, and verify that you can run the sample queries shown there.
Powerpipe mods for Tailpipe work with tables built from log data collected by Tailpipe. The Tailpipe docs show you how to [configure](https://tailpipe.io/docs#configure-data-collection) the AWS plugin for Tailpipe and then [collect](https://tailpipe-io.vercel.app/docs#configure-data-collection) log data. Follow those steps create the table `aws_cloudtrail_log`, and verify that you can run the sample queries shown there.


## Run a benchmark

Powerpipe [benchmarks](/docs/run/benchmarks) provide a mechanism for defining and running log detections to evaluate threat and error patterns, system performance, and user behavior. Benchmarks are written in simple HCL, and packaged in mods. It is simple to create your own, but there are also many benchmarks available on the [Powerpipe Hub](https://hub.powerpipe.io/).

Powerpipe always runs in the context of a [mod](/docs/build/). A Powerpipe mod is a portable, versioned collection of related Powerpipe resources such as dashboards, benchmarks, and detections defined in HCL, and distributed as simple text files. Powerpipe loads the mod from the [mod location](/docs/run#mod-location) which defaults to the current directory.
Powerpipe always runs in the context of a [mod](/docs/build/). A Powerpipe mod is a portable, versioned collection of related Powerpipe resources (dashboards, benchmarks, detections) defined in HCL and distributed as simple text files. Powerpipe loads the mod from the [mod location](/docs/run#mod-location) which defaults to the current directory.

Let's create a new directory for our mod:

Expand All @@ -78,7 +78,7 @@ Visit `localhost:9033` in a browser.

![](/images/docs/learn/tailpipe-benchmark-detect-kms-key-updated.png)

The Tailpipe mod has detected 14 potential issues, of which 5 are detectionsd related to updates to KMS keys. If you know that *ExampleUser* is non-malicious you can exclude those 5 rows with a single click on any row in the `actor` column that matches *ExampleUser*.
The Tailpipe mod has detected 14 potential issues, of which 5 are detections related to updates to KMS keys. If you know that *ExampleUser* is non-malicious you can exclude those 5 rows with a single click on any row in the `actor` column that matches *ExampleUser*.

![](/images/docs/learn/tailpipe-benchmark-detect-kms-key-updated-2.png)

Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ title: Powerpipe CLI
| Command | Description
|-|-
| [powerpipe help](reference/cli/help) | Help about any command.
| [powerpipe detection](reference/cli/detection) | List, view, and run Powerpipe detections.
| [powerpipe login](reference/cli/login) | Log in to Turbot Pipes.
| [powerpipe mod](reference/cli/mod) | Powerpipe mod management.
| [powerpipe benchmark](reference/cli/benchmark) | List, view, and run Powerpipe benchmarks.
Expand Down
4 changes: 0 additions & 4 deletions docs/reference/config-files/connection/tailpipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ The `tailpipe` connection is used to pre-filter the default database, scoping th
| `from` | String | Optional | Set the earliest date. Default: unbounded.
| `to` | String | Optional | Set the latest date. Default: unbounded.

## Attributes (Read-Only)

TBD

## Default Connection

The `tailpipe` connection type includes an implicit, default connection (`connection.tailpipe.default`) that includes all collected data.
Expand Down

0 comments on commit 3bb2ce6

Please sign in to comment.