Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix images, add inspect #33

Merged
merged 1 commit into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/learn.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ 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).

![](/images/docs/learn/collection.png)
![](/learn/collection.png)

To see the table that was created:

Expand Down
64 changes: 59 additions & 5 deletions docs/query/query-shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You can exit the query shell by pressing `Ctrl+d` on a blank line, or using the
### Autocomplete
The query shell includes an autocomplete feature that will suggest words as you type. Type `.` (period). Notice that the autocomplete appears with a list of the [Tailpipe meta-commands](/docs/reference/dot-commands/overview) commands that start with `.`:

![](/images/docs/shell/metacommands.png)
![](/shell/metacommands.png)

As you continue to type, the autocomplete will continue to narrow down the list of tables to only those that match.

Expand Down Expand Up @@ -70,10 +70,64 @@ The query shell supports standard emacs-style key bindings:

Tailpipe **tables** provide an interface for querying log data using standard SQL. Tailpipe tables do not actually *store* data, they query the DuckDB views created over Parquet files collected by `tailpipe collect`. The details are hidden from you though - *you just query them like any other table!*

### Tables
In the query shell, use `.inspect` to view tables.

TBD
```bash
> .inspect
Table Plugin
aws_cloudtrail_log aws@local
```

Select a table to view its columns.

### Columns
```bash
> .inspect aws_cloudtrail_log
Column Type
additional_event_data json
api_version varchar
aws_region varchar
edge_device_details json
error_code varchar
error_message varchar
event_category varchar
event_id varchar
event_name varchar
event_source varchar
event_time timestamp
event_type varchar
event_version varchar
management_event boolean
read_only boolean
recipient_account_id varchar
request_id varchar
request_parameters json
resources json
response_elements json
service_event_details json
session_credential_from_console varchar
shared_event_id varchar
source_ip_address varchar
tls_details struct
tp_akas varchar[]
tp_date date
tp_destination_ip varchar
tp_domains varchar[]
tp_emails varchar[]
tp_id varchar
tp_index varchar
tp_ingest_timestamp timestamp
tp_ips varchar[]
tp_partition varchar
tp_source_ip varchar
tp_source_location varchar
tp_source_name varchar
tp_source_type varchar
tp_table varchar
tp_tags varchar[]
tp_timestamp timestamp
tp_usernames varchar[]
user_agent varchar
user_identity struct
vpc_endpoint_id varchar
```

TBD
2 changes: 1 addition & 1 deletion docs/query/visualization.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ title: Visualization

Tailpipe works with [Powerpipe](https://powerpipe.io) which enables you to visualize query results. You can view and interactively explore [benchmarks](https://powerpipe.io/docs/powerpipe-hcl/benchmark), which bundle sets of [detections](https://powerpipe.io/powerpipe-hcl/detection) that look for patterns in logs:

![](/images/docs/query/row-level-filtering-1.png)
![](/query/row-level-filtering-1.png)

Binary file modified images/shell/metacommands.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.