From 88ce757b3d383e19ba672c637db7b0f673e29bc4 Mon Sep 17 00:00:00 2001 From: Jon Udell Date: Wed, 29 Jan 2025 21:17:42 -0800 Subject: [PATCH] proofread --- docs/learn.md | 21 +++-- docs/manage/collection.md | 4 +- docs/manage/plugin.md | 17 ++-- docs/manage/source.md | 2 - docs/pipes-ecosystem/index.md | 2 +- docs/reference/cli/compact.md | 4 +- docs/reference/cli/connect.md | 15 ++-- docs/reference/cli/partition.md | 84 +++++++++---------- docs/reference/cli/plugin.md | 4 +- docs/reference/cli/query.md | 3 +- docs/reference/config-files/connection.md | 4 +- docs/reference/config-files/partition.md | 11 ++- .../env-vars/tailpipe_install_dir.md | 7 +- docs/reference/env-vars/tailpipe_workspace.md | 2 +- docs/reference/glossary.md | 4 +- docs/sql/tips.md | 6 +- 16 files changed, 86 insertions(+), 104 deletions(-) diff --git a/docs/learn.md b/docs/learn.md index bb55a38..d7930f6 100644 --- a/docs/learn.md +++ b/docs/learn.md @@ -69,8 +69,7 @@ Create a file, e.g. `~/.tailpipe/config/aws.tpc`, with a `connection` and `parti > ```hcl > partition "aws_cloudtrail_log" "flaws" { > source "file" { -> paths = ["/Users/dboeke/flaws/flaws_cloudtrail_logs"] -> file_layout = "%{DATA}.json.gz" + paths = ["/Users/dboeke/flaws/flaws_cloudtrail_logs"] > } >} >``` @@ -84,21 +83,21 @@ tailpipe collect aws_cloudtrail_log ``` -Tailpipe will download the files from the source, decompress and parse them, and add the data to the Tailpipe database in the [standard hive file structure](/docs/reference/glossary#hive). +Tailpipe will download the files from the source, decompress and parse them, and add the data to the Tailpipe database in the [standard hive file structure](/docs/manage/hive). ![](/learn/collection.png) -To see the table that was created: - -```bash -$ tailpipe table list -NAME PLUGIN LOCAL SIZE FILES ROWS -aws_cloudtrail_log hub.tailpipe.io/plugins/turbot/aws@latest 42 MB 2 160,581 -``` ## Query your logs -Tailpipe provides an interactive SQL shell for analyzing your collected data. Run `tailpipe query` to start the query shell. +Tailpipe provides an interactive SQL shell for analyzing your collected data. Run `tailpipe query` to start the query shell. To see the table that was created: + +```bash +$ tailpipe query +> .inspect +Table Plugin +aws_cloudtrail_log aws@0.1.0 +``` You can count the records in the table: diff --git a/docs/manage/collection.md b/docs/manage/collection.md index a69b07f..ba414e3 100644 --- a/docs/manage/collection.md +++ b/docs/manage/collection.md @@ -26,7 +26,7 @@ Collect a specific partition. tailpipe collect aws_cloudtrail_log.dev ``` -See [/docs/reference/cli/collect](/docs/reference/cli/collect) for more examples. +See [collect](/docs/reference/cli/collect) for more examples. The collection process always writes to a local [workspace](/docs/manage/workspace), and does so on a per-partition basis. While you may specify multiple partitions on the command line, `partition` is the unit of collection. @@ -51,7 +51,7 @@ tailpipe collect aws_cloudtrail_log.test --from T-180d tailpipe collect aws_cloudtrail_log.test --from 2024-01-01 ``` -- Subsequent collection runs occur chronologically resuming from the last collection by default, so there are no time gaps while the data is being collected. +Subsequent collection runs occur chronologically resuming from the last collection by default, so there are no time gaps while the data is being collected.