Skip to content

vthiery/steampipe-plugin-incidentio

Repository files navigation

incident.io Plugin for Steampipe

Use SQL to query incidents, actions, alerts, escalations, schedules, custom fields, and more from incident.io.

Quick start

Install

Install the plugin with Steampipe:

steampipe plugin install ghcr.io/vthiery/incidentio

Configure

Copy the sample config and set your API key:

cp config/incidentio.spc ~/.steampipe/config/incidentio.spc

Edit ~/.steampipe/config/incidentio.spc:

connection "incidentio" {
  plugin  = "ghcr.io/vthiery/incidentio"

  # API key from your incident.io dashboard → Settings → API keys.
  # See https://docs.incident.io/api-reference/introduction for details.
  api_key = "YOUR_API_KEY"
}

Run a query

steampipe query

List all live incidents:

select
  id,
  reference,
  name,
  status_category,
  severity_name
from
  incidentio_incident
where
  status_category = 'live';
+-------------------------+----------+-------------------------------+-----------------+---------------+
| id                      | reference | name                         | status_category | severity_name |
+-------------------------+----------+-------------------------------+-----------------+---------------+
| 01FDAG4SAP5TYPT98WGR2N7 | INC-42   | Payments service degraded    | live            | SEV-2         |
| 01FDAG4SAP5TYPT98WGR2N8 | INC-43   | Login failures in EU region  | live            | SEV-1         |
+-------------------------+----------+-------------------------------+-----------------+---------------+

Tables

Table Description
incidentio_incident List and inspect incidents.
incidentio_action List action items tracked against incidents.
incidentio_severity List severity levels configured in your account.
incidentio_incident_type List incident types configured in your account.
incidentio_followups List follow-up items tracked against incidents.
incidentio_incident_updates List status updates posted on incidents.
incidentio_users List users in your incident.io account.
incidentio_alerts List alerts ingested from connected alert sources.
incidentio_incident_roles List incident role definitions (e.g. Incident Lead).
incidentio_incident_statuses List incident status definitions.
incidentio_custom_fields List custom field definitions configured in your account.
incidentio_escalations List escalations triggered in your account.

Development

Prerequisites

Build and Install

make install

Configure the plugin:

cp config/incidentio.spc ~/.steampipe/config/incidentio.spc
vi ~/.steampipe/config/incidentio.spc

Testing

Run a smoke query against every table:

make test

The test script (scripts/test_tables.sh) builds the plugin, queries each table, and reports pass/fail/skip (scope-restricted tables are skipped rather than failed).

Further reading

About

Steampipe plugin to access incident.io

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages