steampipe plugin install ocisteampipe plugin install oci

Table: oci_queue_queue - Query OCI Queue Service Queues using SQL

The Oracle Cloud Infrastructure (OCI) Queue Service is a fully managed, scalable, and durable messaging service for asynchronous communication among microservices, distributed systems, and serverless applications. It allows you to send, store, and receive messages between software components at any volume, without losing messages or requiring other services to be always available. OCI Queue Service is built on OCI Streaming and provides a simple, RESTful API for messaging.

Table Usage Guide

The oci_queue_queue table provides insights into the queues within the OCI Queue Service. As a systems engineer, you can explore queue-specific details through this table, including queue type, retention period, and associated metadata. This table is particularly useful for managing and monitoring the performance and health of your queues, ensuring efficient communication between your microservices and applications.

Examples

Basic info

Explore which queues are active and their associated details to better manage and monitor your Oracle Cloud Infrastructure (OCI) resources. This can help you maintain an efficient and organized OCI environment.

select
  display_name,
  id,
  lifecycle_state as state,
  lifecycle_state
from
  oci_queue_queue;

select
  display_name,
  id,
  lifecycle_state as state,
  lifecycle_state
from
  oci_queue_queue;

List queues not in the active state

Determine the areas in which queues are not actively functioning. This can be useful for identifying potential bottlenecks or interruptions in data flow.

select
  display_name,
  id,
  lifecycle_state as state
from
  oci_queue_queue
where
  lifecycle_state <> 'ACTIVE';

select
  display_name,
  id,
  lifecycle_state as state
from
  oci_queue_queue
where
  lifecycle_state <> 'ACTIVE';

List queues that are not encrypted

Discover the segments that are not encrypted in your system. This query is useful for identifying potential security risks and ensuring that all queues in your system are properly protected.

select
  display_name,
  id,
  lifecycle_state as state,
  compartment_id,
  region
from
  oci_queue_queue
where
  custom_encryption_key_id is null;

select
  display_name,
  id,
  lifecycle_state as state,
  compartment_id,
  region
from
  oci_queue_queue
where
  custom_encryption_key_id is null;

Get details of each queue

Explore the characteristics of each queue, such as retention and visibility duration, to manage and optimize your queue configurations effectively. This allows you to understand queue behaviors, identify potential bottlenecks, and implement necessary adjustments for improved performance.

select
  display_name,
  retention_in_seconds,
  visibility_in_seconds,
  timeout_in_seconds,
  messages_endpoint,
  dead_letter_queue_delivery_count,
  defined_tags,
  id
from
  oci_queue_queue;

select
  display_name,
  retention_in_seconds,
  visibility_in_seconds,
  timeout_in_seconds,
  messages_endpoint,
  dead_letter_queue_delivery_count,
  defined_tags,
  id
from
  oci_queue_queue;

Schema for oci_queue_queue

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form, e.g. connection_name.
compartment_id	text	=	The OCID of the compartment in Tenant in which the resource is located.
custom_encryption_key_id	bigint		ID of the custom master encryption key which will be used to encrypt messages content.
dead_letter_queue_delivery_count	bigint		The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
defined_tags	jsonb		Defined tags for resource. Defined tags are set up in your tenancy by an administrator. Only users granted permission to work with the defined tags can apply them to resources.
display_name	text	=	The name of the queue.
freeform_tags	jsonb		Free-form tags for resource. This tags can be applied by any user with permissions on the resource.
id	text	=	The OCID of the queue.
lifecycle_details	text		A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycle_state	text	=	The current state of the Queue.
messages_endpoint	text		The endpoint to use to get or put messages in the queue.
region	text		The OCI region in which the resource is located.
retention_in_seconds	bigint		The retention period of the messages in the queue, in seconds.
tags	jsonb		A map of tags for the resource.
tenant_id	text		The OCID of the Tenant in which the resource is located.
tenant_name	text		The name of the Tenant in which the resource is located.
time_created	timestamp with time zone		The date and time the queue was created.
time_updated	timestamp with time zone		The date and time the queue was last modified.
timeout_in_seconds	bigint		The default polling timeout of the messages in the queue, in seconds.
title	text		Title of the resource.
visibility_in_seconds	bigint		The default visibility of the messages consumed from the queue.

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)" -- oci

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

steampipe_export_oci --config '<your_config>' oci_queue_queue