steampipe plugin install pipes

Table: pipes_workspace_process - Query Pipes Workspace Processes using SQL

Pipes allows users to create, manage, and monitor workspace processes. It provides a centralized platform for managing all workspace processes, including their status, workspace ID, workspace name, and more. Pipes helps users stay informed about the health and performance of their workspace processes and take appropriate actions when needed.

Table Usage Guide

The pipes_workspace_process table offers a comprehensive view of Pipes Workspace Processes. As a DevOps engineer, you can use this table to explore detailed information about each workspace process, including its status, workspace ID, workspace name, and more. Utilize it to monitor the health and performance of your workspace processes and take appropriate actions when needed.

Important Notes

  • This table supports optional quals. Queries with optional quals in the where clause are optimised to use Turbot Pipes filters.

  • Optional quals are supported for the following columns:

    • created_at
    • id
    • identity_handle
    • identity_id
    • pipeline_id
    • query_where - Allows use of query filters. For a list of supported columns for workspace proceses, please see Supported APIs and Columns. Please note that any query filter passed into the query_where qual will be combined with other optional quals.
    • state
    • type
    • updated_at
    • workspace_handle
    • workspace_id

Examples

Basic info

Explore the processes within a workspace to understand their types, states, and creation dates. This can be useful for monitoring the health and activity of your pipelines over time.

select
id,
identity_handle,
workspace_handle,
pipeline_id,
type,
state,
created_at
from
pipes_workspace_process;
select
id,
identity_handle,
workspace_handle,
pipeline_id,
type,
state,
created_at
from
pipes_workspace_process;

List processes for a pipeline

Explore the various processes associated with a specific pipeline in your workspace. This can be beneficial in assessing the state and type of these processes, and understanding when they were created.

select
id,
identity_handle,
workspace_handle,
pipeline_id,
type,
state,
created_at
from
pipes_workspace_process
where
pipeline_id = 'pipe_cfcgiefm1tumv1dis7lg';
select
id,
identity_handle,
workspace_handle,
pipeline_id,
type,
state,
created_at
from
pipes_workspace_process
where
pipeline_id = 'pipe_cfcgiefm1tumv1dis7lg';

List running processes for a pipeline

Explore which processes are currently running for a specific pipeline to manage resources and troubleshoot potential issues efficiently. This helps in maintaining the smooth operation of workflows and identifying any bottlenecks swiftly.

select
id,
identity_handle,
workspace_handle,
pipeline_id,
type,
state,
created_at
from
pipes_workspace_process
where
pipeline_id = 'pipe_cfcgiefm1tumv1dis7lg'
and state = 'running';
select
id,
identity_handle,
workspace_handle,
pipeline_id,
type,
state,
created_at
from
pipes_workspace_process
where
pipeline_id = 'pipe_cfcgiefm1tumv1dis7lg'
and state = 'running';

List running processes for a pipeline using query filter

Explore the status of active processes within a specific pipeline. This query is useful for monitoring the ongoing operations and tracking their progress in real-time.

select
id,
identity_handle,
workspace_handle,
pipeline_id,
type,
state,
created_at
from
pipes_workspace_process
where
query_where = 'pipeline_id = ''pipe_cfcgiefm1tumv1dis7lg'' and state = ''running''';
select
id,
identity_handle,
workspace_handle,
pipeline_id,
type,
state,
created_at
from
pipes_workspace_process
where
pipeline_id = 'pipe_cfcgiefm1tumv1dis7lg'
and state = 'running';

Schema for pipes_workspace_process

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
created_attimestamp with time zone>, >=, =, <, <=The time when the process was created.
created_byjsonbInformation about the user who created the process.
created_by_idtextThe unique identifier of the user who created the process.
idtext=, !=The unique identifier for the process.
identity_handletext=The handle of the identity.
identity_idtext=The unique identifier of the identity to which the process belongs to.
identity_typetextThe type of identity, can be org/user.
pipeline_idtext=, !=The unique identifier for the pipeline if a process is for a pipeline run/execution.
query_wheretext=The query where expression to filter workspace processes.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
statetext=, !=The current state of the process.
typetext=, !=The type of action executed by the process.
updated_attimestamp with time zone>, >=, =, <, <=The time when the process was last updated.
updated_byjsonbInformation about the user who last updated the process.
updated_by_idtextThe unique identifier of the user who last updated the process.
user_idtext=, !=, ~~, ~~*, !~~, !~~*The unique identifier for the user.
version_idbigintThe current version ID for the process.
workspace_handletext=The handle of the workspace.
workspace_idtext=The unique identifier of the workspace to which the process belongs to.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- pipes

You can pass the configuration to the command with the --config argument:

steampipe_export_pipes --config '<your_config>' pipes_workspace_process