Skip to content

Commit

Permalink
remove notes, add env-vars to sidebar
Browse files Browse the repository at this point in the history
  • Loading branch information
judell committed Jan 29, 2025
1 parent 8de76b7 commit d7e0ac1
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 27 deletions.
5 changes: 0 additions & 5 deletions docs/manage/source.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,5 @@ partition "aws_cloudtrail_log" "test" {

Standard source types, like `aws_s3_bucket` and `file`, have an HCL shape that is consistent across all the partitions, and a standard set of arguments.

>[!NOTE]
> is this still true, given file_layout?
However the *interpretation* of the arguments, and the *behavior* of the source, is plugin-dependent. For instance, the `aws_s3_source` for the `aws_cloudtrail_log` table makes Cloudtrail-specific assumptions about the key prefix structure and file names.



3 changes: 0 additions & 3 deletions docs/query/batch-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: Batch Queries
---

>[!NOTE]
> cloned from tailpipe, with minor variation. how much is applicable?
# Batch Queries

Tailpipe queries can provide valuable insight into your logs, and the interactive client is a powerful tool for ad hoc queries and exploration. Often, however, you will write a query that you will want to re-run in the future, either manually or perhaps as a cron job. Tailpipe allows you to save your query to a file, and pass the file into the `tailpipe query` command.
Expand Down
8 changes: 0 additions & 8 deletions docs/reference/cli/compact.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,4 @@ tailpipe compact aws_cloudtrail_log.prod --from 1/1/2024 --from 2/1/2024
tailpipe compact aws_cloudtrail_log.prod --from T-7d
```

Compact the metadata:

>[!NOTE]
> in scope?
```hcl
tailpipe compact --metadata
```

5 changes: 1 addition & 4 deletions docs/reference/env-vars/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ Tailpipe supports environment variables to allow you to change its default behav

Note that plugins may also support environment variables, but these are plugin-specific - refer to your plugin's documentation on the [Tailpipe Hub](https://hub.tailpipe.io/) for details.

>[!NOTE]
>What else will there be?
## Tailpipe Environment Variables


Expand All @@ -19,7 +16,7 @@ Note that plugins may also support environment variables, but these are plugin-s
| [TAILPIPE_INSTALL_DIR](reference/env-vars/tailpipe_install_dir)| `~/.tailpipe` | The directory in which the Steampipe database, plugins, and supporting files can be found.
| [TAILPIPE_LOG_LEVEL](reference/env-vars/tailpipe_log) | `warn` | Set the logging output level.
| [TAILPIPE_MEMORY_MAX_MB](reference/env-vars/tailpipe_memory_max_mb)| `1024` | Set a soft memory limit for the `tailpipe` process.
|[TAILPIPE_PLUGIN_MEMORY_MAX_MB](reference/env-vars/tailpipe_plugin_memory_max_mb)| `1024` | Set a default memory soft limit for each plugin process.
| [TAILPIPE_QUERY_TIMEOUT](reference/env-vars/tailpipe_query_timeout) | `240` for detections, unlimited in all other cases. | Set the amount of time to wait for a query to complete before
| [TAILPIPE_UPDATE_CHECK](reference/env-vars/tailpipe_update_check)| `true` | Enable/disable automatic update checking.
| [TAILPIPE_WORKSPACE](reference/env-vars/tailpipe_workspace) | `default` | Set the Tailpipe workspace.
|[TAILPIPE_PLUGIN_MEMORY_MAX_MB](reference/env-vars/tailpipe_plugin_memory_max_mb)| `1024` | Set a default memory soft limit for each plugin process.
3 changes: 0 additions & 3 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ A collection is a tree of Parquet files in the standard hive format. It is creat

A collection may result in storage of multiple Parquet files for a given day. Tailpipe can compact those into a single file for the day. This happens automatically when you run `tailpipe collect`.

>[!NOTE]
> why would i ever need to run tailpipe compact?
## Benchmark

A benchmark bundles a set of detections, and/or sub-benchmarks, into a single unit.
Expand Down
8 changes: 7 additions & 1 deletion docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,13 @@
"id": "env-vars",
"link": "reference/env-vars",
"items": [
"reference/env-vars/tailpipe_log_level"
"reference/env-vars/tailpipe_install_dir",
"reference/env-vars/tailpipe_log_level",
"reference/env-vars/tailpipe_memory_max_mb",
"reference/env-vars/tailpipe_plugin_memory_max_mb",
"reference/env-vars/tailpipe_query_timeout",
"reference/env-vars/tailpipe_update_check",
"reference/env-vars/tailpipe_workspace"
]
},
{
Expand Down
3 changes: 0 additions & 3 deletions docs/sql/querying-struct.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@ typeof(user_identity) = STRUCT("type" VARCHAR, principal_id VARCHAR, arn VARCHAR
...
```

>[!NOTE]
> if .inspect is available, that'll be the preferred way to observe the type
DuckDB doesn't have a `struct_keys` function analogous to `json_keys` but you can list the keys of STRUCT by casting to JSON

```sql
Expand Down

0 comments on commit d7e0ac1

Please sign in to comment.