Skip to content

Commit

Permalink
add activity docs for workspaces, developer account, org, and tenant
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Oct 24, 2024
1 parent 1a898a5 commit a52f338
Show file tree
Hide file tree
Showing 13 changed files with 50 additions and 110 deletions.
52 changes: 16 additions & 36 deletions docs/accounts/developer/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,39 @@ sidebar_label: Activity

# Activity

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

## 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 developer account 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 developer account, navigate to your developer account 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/developer_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 one-time requests (install a mod into a workspace), and recurring system tasks (update the workspace container image and plugins every week). **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 developer account, navigate to your developer account 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 developer account.

<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/developer_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/developer_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)
-->
52 changes: 16 additions & 36 deletions docs/accounts/org/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,39 @@ sidebar_label: Activity

# Activity

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

## 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 organization 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 organization, navigate to your organization 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/org_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 one-time requests (install a mod into a workspace), and recurring system tasks (update the workspace container image and plugins every week). **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 organization, navigate to your organization 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 organization.

<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/org_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/org_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)
-->
52 changes: 16 additions & 36 deletions docs/accounts/tenant/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,39 @@ sidebar_label: Activity

# Activity

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

## 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 tenant 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 tenant, navigate to your tenant, then click the double arrow button from the navigation at the top of the page and select **Tenant Settings** from the dropdown. Go to the **Activity** tab for your tenant and select **Audit Log** from the left-hand menu.

<img src="/images/docs/pipes/cloud_audit_log.png" width="400pt"/>
![](/images/docs/pipes/tenant_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 one-time requests (install a mod into a workspace), and recurring system tasks (update the workspace container image and plugins every week). **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 audit log for your tenant, navigate to your tenant, then click the double arrow button from the navigation at the top of the page and select **Tenant Settings** from the dropdown. Go to the **Activity** tab for your tenant and select **Processes** from the left-hand menu.

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 tenant.

<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/tenant_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/tenant_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)
-->
4 changes: 2 additions & 2 deletions docs/workspaces/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Activity

# Activity

The **Activity** tab for your workspace tab provides visibility into the all events that occur in your workspace.
The **Activity** tab for your workspace tab provides visibility into all events that occur in your workspace.

## Audit Log

Expand All @@ -20,7 +20,7 @@ To view the audit log for your workspace, navigate to your workspace and then to
## 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 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). **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**.

Expand Down
Binary file added images/developer_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/developer_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/developer_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.
Binary file added images/org_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/org_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/org_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.
Binary file added images/tenant_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/tenant_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/tenant_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 a52f338

Please sign in to comment.