Skip to content

Latest commit

 

History

History
134 lines (93 loc) · 5.17 KB

README.md

File metadata and controls

134 lines (93 loc) · 5.17 KB

image

New Relic plugin for Steampipe

Use SQL to instantly query New Relic Alerts, Events, Dashboards and more. Open source CLI. No DB required.

Quick start

Install

Download and install the latest New Relic plugin:

steampipe plugin install newrelic

Configure your credentials and config file.

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

connection "newrelic" {
  plugin = "newrelic"

  # Authentication information
  api_key = "NRAK-XX0X0XX00XXXX0000XXXXXXXXX0X"
  region = "us"
}

or through environment variables:

export NEW_RELIC_API_KEY=NRAK-XX0X0XX00XXXX0000XXXXXXXXX0X
export NEW_RELIC_REGION=us

Run steampipe:

steampipe query

List APM Applications on your New Relic account:

select
  id,
  name,
  error_rate,
  health_status,
  response_time
from
  newrelic_apm_application;
+-----------+------+------------+---------------+---------------+
| id        | name | error_rate | health_status | response_time |
+-----------+------+------------+---------------+---------------+
| 511153982 | test | 0          | gray          | 0             |
+-----------+------+------------+---------------+---------------+

Engines

This plugin is available for the following engines:

Engine Description
Steampipe The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
Postgres FDW Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
SQLite Extension Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
Export Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
Turbot Pipes Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.

Developing

Prerequisites:

Clone:

git clone https://github.com/turbot/steampipe-plugin-newrelic.git
cd steampipe-plugin-newrelic

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

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/newrelic.spc

Try it!

steampipe query
> .inspect newrelic

Further reading:

Open Source & Contributing

This repository is published under the Apache 2.0 (source code) and CC BY-NC-ND (docs) licenses. Please see our code of conduct. We look forward to collaborating with you!

Steampipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #steampipe on Slack →

Want to help but don't know where to start? Pick up one of the help wanted issues: