diff --git a/docs/sidebar.json b/docs/sidebar.json index 39bd6e6..0df7757 100644 --- a/docs/sidebar.json +++ b/docs/sidebar.json @@ -68,7 +68,8 @@ "items": [ "using/powerpipe/dashboards", "using/powerpipe/snapshots", - "using/powerpipe/mods" + "using/powerpipe/mods", + "using/powerpipe/activity" ] }, { @@ -78,7 +79,8 @@ "items": [ "using/flowpipe/pipelines", "using/flowpipe/triggers", - "using/flowpipe/mods" + "using/flowpipe/mods", + "using/flowpipe/executions" ] } ] diff --git a/docs/using/flowpipe/executions.md b/docs/using/flowpipe/executions.md new file mode 100644 index 0000000..594ab3a --- /dev/null +++ b/docs/using/flowpipe/executions.md @@ -0,0 +1,22 @@ +--- +title: Executions +sidebar_label: Executions +--- + +# Executions + +The **Executions** tab provides visibility into the Flowpipe pipeline and triggers executions. You can view the status of running and completed processes and view the logs. + +To view your activity, navigate to your workspace. From the **Pipes** tab, select **Flowpipe**, then go to the **Executions** tab. + +![](/images/docs/pipes/flowpipe/flowpipe_executions_list.png) + +You can filter the list of processes using a query filter. Click the **Query** dropdown to select a pre-defined filter, or enter your own using the [Pipes query filter syntax](/pipes/docs/reference/query-filter#syntax). + + +![](/images/docs/pipes/flowpipe/flowpipe_executions_filtered.png) + + +Click on a process to view the detail. The process detail displays the status, which user initiated it the full detailed logs, with expandable and copyable data where available. + +![](/images/docs/pipes/flowpipe/flowpipe_executions_detail.png) diff --git a/docs/using/powerpipe/activity.md b/docs/using/powerpipe/activity.md new file mode 100644 index 0000000..7c0e244 --- /dev/null +++ b/docs/using/powerpipe/activity.md @@ -0,0 +1,22 @@ +--- +title: Activity +sidebar_label: Activity +--- + +# Activity + +The Powerpipe **Activity** tab provides visibility into the Powerpipe scheduled snapshot processes. You can view the status of running and completed processes and view the logs. + +To view your activity, navigate to your workspace. From the **Pipes** tab, select **Powerpipe**, then go to the **Activity** tab. + +![](/images/docs/pipes/powerpipe/powerpipe_activity.png) + +You can filter the list of processes using a query filter. Click the **Query** dropdown to select a pre-defined filter, or enter your own using the [Pipes query filter syntax](/pipes/docs/reference/query-filter#syntax). + + +![](/images/docs/pipes/powerpipe/powerpipe_activity_filtered.png) + + +Click on a process to view the detail. The process detail displays the status, which user initiated it the full detailed logs, with expandable and copyable data where available. + +![](/images/docs/pipes/powerpipe/powerpipe_process_log.png) diff --git a/docs/using/powerpipe/dashboards.md b/docs/using/powerpipe/dashboards.md index ca36001..e6a5572 100644 --- a/docs/using/powerpipe/dashboards.md +++ b/docs/using/powerpipe/dashboards.md @@ -12,7 +12,7 @@ workspace, the [Dashboards](https://powerpipe.io/docs/run/dashboard) and filter by name / tag etc. -Navigate to your workspace, then the the **Pipes** tab, and choose **Dashbaords**. +Navigate to your workspace, then from the **Pipes** tab choose **Powerpipe**. ![](/images/docs/pipes/gs_dashboard_list.png) diff --git a/docs/using/powerpipe/snapshots.md b/docs/using/powerpipe/snapshots.md index 7cab143..2f0ceed 100644 --- a/docs/using/powerpipe/snapshots.md +++ b/docs/using/powerpipe/snapshots.md @@ -20,6 +20,10 @@ The **Snapshots** tab lists all the snapshots in the workspace, including the sn ![](/images/docs/pipes/powerpipe/powerpipe_snapshots_list.png) + +You can filter the list of snapshots using a query filter. Click the **Query** dropdown to select a pre-defined filter, or enter your own using the [Pipes query filter syntax](/pipes/docs/reference/query-filter#syntax). + + Click on a snapshot title to [view or edit it](#editing-snapshots). diff --git a/docs/using/steampipe/aggregators.md b/docs/using/steampipe/aggregators.md index 0fee1c2..8130477 100644 --- a/docs/using/steampipe/aggregators.md +++ b/docs/using/steampipe/aggregators.md @@ -19,7 +19,11 @@ To manage the aggregators for your workspace, navigate to your workspace, then s ![](/images/docs/pipes/steampipe/steampipe_aggregators_list.png) -You will see a list of aggregators for the workspace. Click on an aggregator to view it. The **Connections** tab will list the connections that are currently included in the aggregator. You can change the handle or the included connections of the aggregator from the **Settings** tab. +You will see a list of aggregators for the workspace. + +You can filter the list of aggregators using a query filter. Click the **Query** dropdown to select a pre-defined filter, or enter your own using the [Pipes query filter syntax](/pipes/docs/reference/query-filter#syntax). + +Click on an aggregator to view it. The **Connections** tab will list the connections that are currently included in the aggregator. You can change the handle or the included connections of the aggregator from the **Settings** tab.
diff --git a/docs/using/steampipe/index.md b/docs/using/steampipe/index.md index 1879190..0af12d8 100644 --- a/docs/using/steampipe/index.md +++ b/docs/using/steampipe/index.md @@ -16,7 +16,6 @@ You can accelerate your queries with a Datatank. With Datatank, you can proactiv - ## Steampipe Database Search Path Your workspace includes a Steampipe database, and this database may include many schemas. When querying the database, any unqualified table names are resolved using the schema [search path](https://steampipe.io/docs/guides/search-path). Mods are written using unqualified names, which allows you to target specific [datatanks](/pipes/docs/using/steampipe/datatank), [connections](/pipes/docs/using/steampipe/connections), and [aggregators](/pipes/docs/using/steampipe/aggregators). Pipes is opinionated on the search path, because *usually* you want to use a table from the datatank if it exists, otherwise an aggregator if one exists, otherwise a connection. @@ -74,7 +73,9 @@ You can also **Wake Up** (enable), **Sleep** (disable) or **Reboot** your worksp | `deleted` | The workspace has been deleted. - +## Query Log + +Turbot Pipes provides a log of the queries that have been run against your +Steampipe workspace database. You can view the query logs from the Steampipe **Advanced** tab for your workspace. Navigate to your workspace, and from the **Pipes** tab select **Steampipe**. From the Steampipe **Advanced** tab, select **Query Log** from the left hand menu. + +![](/images/docs/pipes/steampipe/steampipe_query_log.png) diff --git a/docs/using/steampipe/snapshots.md b/docs/using/steampipe/snapshots.md index c438a1d..913376f 100644 --- a/docs/using/steampipe/snapshots.md +++ b/docs/using/steampipe/snapshots.md @@ -19,6 +19,10 @@ The **Snapshots** tab lists all the query snapshots in the workspace, including ![](/images/docs/pipes/steampipe/steampipe_snapshot_list.png) + +You can filter the list of snapshots using a query filter. Click the **Query** dropdown to select a pre-defined filter, or enter your own using the [Pipes query filter syntax](/pipes/docs/reference/query-filter#syntax). + + Click on a snapshot title to [view or edit it](#editing-snapshots). diff --git a/images/flowpipe/flowpipe_executions_detail.png b/images/flowpipe/flowpipe_executions_detail.png new file mode 100644 index 0000000..f1f8c47 Binary files /dev/null and b/images/flowpipe/flowpipe_executions_detail.png differ diff --git a/images/flowpipe/flowpipe_executions_filtered.png b/images/flowpipe/flowpipe_executions_filtered.png new file mode 100644 index 0000000..f10a72e Binary files /dev/null and b/images/flowpipe/flowpipe_executions_filtered.png differ diff --git a/images/flowpipe/flowpipe_executions_list.png b/images/flowpipe/flowpipe_executions_list.png new file mode 100644 index 0000000..28fef28 Binary files /dev/null and b/images/flowpipe/flowpipe_executions_list.png differ diff --git a/images/powerpipe/powerpipe_activity.png b/images/powerpipe/powerpipe_activity.png new file mode 100644 index 0000000..6619396 Binary files /dev/null and b/images/powerpipe/powerpipe_activity.png differ diff --git a/images/powerpipe/powerpipe_activity_filtered.png b/images/powerpipe/powerpipe_activity_filtered.png new file mode 100644 index 0000000..2f28464 Binary files /dev/null and b/images/powerpipe/powerpipe_activity_filtered.png differ diff --git a/images/powerpipe/powerpipe_process_log.png b/images/powerpipe/powerpipe_process_log.png new file mode 100644 index 0000000..05ec393 Binary files /dev/null and b/images/powerpipe/powerpipe_process_log.png differ diff --git a/images/steampipe/steampipe_query_log.png b/images/steampipe/steampipe_query_log.png new file mode 100644 index 0000000..7f01aa8 Binary files /dev/null and b/images/steampipe/steampipe_query_log.png differ