steampipe plugin install updownsteampipe plugin install updown

updown.io + Steampipe

Steampipe is an open-source zero-ETL engine to instantly query cloud APIs using SQL.

updown is an online service that checks your website's status by periodically sending an HTTP request to the URL of your choice. It then notifies you by email or sms when your website is not responding correctly.

For example:

select
  url,
  uptime,
  down,
  down_since
from
  updown_check

+----------------------+--------+-------+------------+
| url                  | uptime | down  | down_since |
+----------------------+--------+-------+------------+
| https://steampipe.io | 100    | false | <null>     |
| https://turbot.com   | 100    | false | <null>     |
+----------------------+--------+-------+------------+

Documentation

Table definitions & examples →

Get started

Install

Download and install the latest updown.io plugin:

steampipe plugin install updown

Credentials

Item	Description
Credentials	Create an API Key.
Permissions	Use a `Read-only` key.
Radius	Each connection represents a single updown.io account.
Resolution	1. `api_key` in Steampipe config. 2. `UPDOWN_API_KEY` environment variable.

Configuration

Installing the latest updown plugin will create a config file (~/.steampipe/config/updown.spc) with a single connection named updown:

connection "updown" {
  plugin     = "updown"
  api_key    = "9m_kAcfuTlW_JCrvoMYK6g"
}

Postgres FDW

This plugin is available as a native Postgres FDW. Unlike Steampipe CLI, which ships with an embedded Postgres server instance, the Postgres FDW can be installed in any supported Postgres database version.

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

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

The installer will prompt you for the plugin name and version, download and install the appropriate files for your OS, system architecture, and Postgres version.

To configure the Postgres FDW, you will create an extension, foreign server, and schema and import the foreign schema.

CREATE EXTENSION IF NOT EXISTS steampipe_postgres_updown;
CREATE SERVER steampipe_updown FOREIGN DATA WRAPPER steampipe_postgres_updown OPTIONS (config '<your_config>');
CREATE SCHEMA updown;
IMPORT FOREIGN SCHEMA updown FROM SERVER steampipe_updown INTO updown;

SQLite Extension

This plugin is available as a SQLite Extension, making the tables available as SQLite virtual tables.

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

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

The installer will prompt you for the plugin name, version, and destination directory. It will then determine the OS and system architecture, and it will download and install the appropriate package.

To configure the SQLite extension, load the extension module and then run the steampipe_configure_updown function to configure it with plugin-specific options.

$ sqlite3
sqlite> .load ./steampipe_sqlite_extension_updown.so
sqlite> select steampipe_configure_updown('<your_config>');

Export

This plugin is available as a standalone Export 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)" -- updown

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

steampipe_export_updown --config '<your_config>' <table_name>