Solace PubSub+ Cloud plugin for Steampipe

Use SQL to query configurations, consumers, events and more from Solace.

• Get started →
• Documentation: Table definitions & examples
• Community: Slack Channel
• Get involved: Issues

Overview

The goal is to retrieve information on Solace PubSub+ Cloud resources via SQL queries using Solace plugin for Steampipe.

Steampipe is an open-source framework for querying, analyzing, and working with data from various sources. It provides a unified and declarative way to interact with disparate data sources, such as databases, cloud providers, and APIs, using SQL syntax.

Plugins are what Steampipe uses to define the schema for remote resources. The Solace plugin for Steampipe defines which tables are available and performs API calls to query those resources.

Quick start

Install

Download and install the latest Solace plugin:

steampipe plugin install SolaceLabs/solace

Configure your credentials and config file.

Configure your account details in ~/.steampipe/config/solace.spc:

connection "solace" {
  plugin = "SolaceLabs/solace"

  # Autentication information
  api_token = "XXXXXXXXX"

  api_url = "https://api.solace.cloud/"
}

Or through environment variables:

export SOLACE_API_TOKEN=XXXXXXXXX
export SOLACE_API_URL=https://api.solace.cloud/

Run steampipe:

steampipe query

List application domains:

select
  id,
  name,
  stats
from
  solace_application_domain;

+-------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| id          | name                                | stats                                                                                                             |
+-------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| n8xj0k6rx5i | AcmeRetail - Enterprise Governance  | {"applicationCount":0,"enumCount":3,"eventApiCount":1,"eventApiProductCount":0,"eventCount":2,"schemaCount":2}    |
| sfxq3pd8xcw | AcmeRetail - SAP S/4                | {"applicationCount":1,"enumCount":2,"eventApiCount":1,"eventApiProductCount":1,"eventCount":8,"schemaCount":26}   |
| dux1k1p9xsg | AcmeRetail - CRM                    | {"applicationCount":1,"enumCount":0,"eventApiCount":0,"eventApiProductCount":0,"eventCount":3,"schemaCount":1}    |
| u2x73phaxbj | AcmeRetail - Human Relationships    | {"applicationCount":2,"enumCount":2,"eventApiCount":0,"eventApiProductCount":0,"eventCount":3,"schemaCount":5}    |
| 9nxoj6yfxm3 | AcmeRetail - Store Operations       | {"applicationCount":6,"enumCount":3,"eventApiCount":1,"eventApiProductCount":0,"eventCount":2,"schemaCount":2}    |
| 4tx0jilaxt2 | AcmeRetail - Supply Chain           | {"applicationCount":2,"enumCount":3,"eventApiCount":1,"eventApiProductCount":0,"eventCount":2,"schemaCount":2}    |
| 72x10oegx7u | AcmeRetail - Facilities             | {"applicationCount":1,"enumCount":4,"eventApiCount":1,"eventApiProductCount":1,"eventCount":2,"schemaCount":2}    |
+-------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------------+

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone https://github.com/SolaceLabs/steampipe-plugin-solace.git
cd steampipe-plugin-solace

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

mkdir -p ~/.steampipe/config
cp config/* ~/.steampipe/config
vi ~/.steampipe/config/solace.spc

Check the status of pluging

steampipe plugin list

This should give you information on the installed plugins

+---------------------------------------------------+---------+-------------+
| Installed Plugin                                  | Version | Connections |
+---------------------------------------------------+---------+-------------+
| hub.steampipe.io/plugins/SolaceLabs/solace@latest | local   | solace      |
+---------------------------------------------------+---------+-------------+

Try it!

steampipe query
> .inspect solace

Further reading:

• Writing plugins
• Writing your first table

Resources

This is not an officially supported Solace product.

For more information try these resources:

• Ask the Solace Community
• The Solace Developer Portal website at: https://solace.dev

Contributing

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

help wanted issues:

• Steampipe
• Solace Plugin

Authors

See the list of contributors who participated in this project.

License

See the LICENSE file for details.