Skip to content

Commit

Permalink
add workspace activity docs
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Oct 24, 2024
1 parent 7fdc712 commit 1a898a5
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 36 deletions.
51 changes: 15 additions & 36 deletions docs/workspaces/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,36 @@ sidebar_label: Activity

# Activity

The **Activity** tab provides visibility into the events that occur in your
Turbot Pipes environment.
<!--
The **Activity** tab for your workspace tab provides visibility into the all events that occur in your workspace.

## Audit Log

The **Audit Log** provides a log of API activity associated with your user,
organization, or workspace, including _who_ did _what_ and _when_.
The **Audit Log** provides a log of API activity associated with your workspace including _who_ did _what_ and _when_.

- To view the audit log for your workspace, click **Audit Log** on the
**Activity** page for the workspace.
- To view the audit log for your user or organization, click **Audit Log** on
the **Settings** page for the user or organization.
To view the audit log for your workspace, navigate to your workspace and then to the **Activity** tab. From the left-hand menu, select **Audit Log**.

<img src="/images/docs/pipes/cloud_audit_log.png" width="400pt"/>
![](/images/docs/pipes/workspace_audit_log.png)
<br />

## DB Logs

Turbot Pipes provides a log of the queries that have been run against your
workspace. To view the query logs, go to the **Activity** tab for your
workspace, then select **DB Log** from the menu on the left.
## Processes

<img src="/images/docs/pipes/cloud_db_log.png" width="400pt"/>
<br />

## Processes
Many Turbot Pipes APIs perform tasks asynchronously. These tasks include Steampipe and Powerpipe scheduled snapshots, Flowpipe trigger and pipeline executions, one-time requests (install a mod into a workspace), and recurring system tasks (update the workspace container image and plugins every week). Steampipe **Processes** provide visibility into these activities.

Many Turbot Pipes APIs perform tasks asynchronously. These tasks include
one-time requests (install a mod into a workspace), recurring system tasks
(update the workspace container image and plugins every week), and
user-scheduled activities (create a snapshot of the AWS CIS v1.5.0 Benchmark
every day). Steampipe **Processes** provide visibility into these activities.
To view the processes for your workspace, navigate to your workspace and then to the **Activity** tab. From the left-hand menu, select **Processes**.

To view your processes, navigate to either your own identity or workspace
**Activity** tab and then to the **Processes** left-nav. Here you'll find a list
of processes with a link to the detail for each.
You can view the status of all running and completed processes in your workspace.

<img src="/images/docs/pipes/cloud-processes.png" width="400pt"/>
<br />

If you click into a process in the list, you'll see the status, which user
initiated it and where applicable, a link to the pipeline for it.
![](/images/docs/pipes/workspace_process_list.png)

<img src="/images/docs/pipes/cloud-process-detail.png" width="400pt"/>
<br />
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).

You'll also see detailed logs, with expandable and copyable data where
available.

<img src="/images/docs/pipes/cloud-process-logs.png" width="400pt"/>
<br />
![](/images/docs/pipes/workspace_process_list_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/process_detail.png)
Binary file added images/process_detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/workspace_audit_log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/workspace_process_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/workspace_process_list_filtered.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1a898a5

Please sign in to comment.