Skip to content

Latest commit

 

History

History
151 lines (111 loc) · 5.08 KB

README.md

File metadata and controls

151 lines (111 loc) · 5.08 KB

Turbot Pipes Plugin for Tailpipe

Tailpipe is an open-source CLI tool that allows you to collect logs and query them with SQL.

Turbot Pipes is an intelligence, automation & security platform built specifically for DevOps.

The Turbot Pipes Plugin for Tailpipe allows you to collect and query Pipes logs using SQL to track activity, monitor trends, detect anomalies, and more!

Collect and query logs: image

Getting Started

Install Tailpipe from the downloads page:

# MacOS
brew install turbot/tap/tailpipe
# Linux or Windows (WSL)
sudo /bin/sh -c "$(curl -fsSL https://tailpipe.io/install/tailpipe.sh)"

Install the plugin:

tailpipe plugin install pipes

Configure your connection credentials, table partition, and data source (examples):

vi ~/.tailpipe/config/pipes.tpc
connection "pipes" "pipes_organization" {
  token      = "tpt_pipestoken"
  org_handle = "org_handle_name"
}

partition "pipes_audit_log" "my_logs" {
  source "pipes_audit_log" {
    connection = connection.pipes.pipes_organization
  }
}

Download, enrich, and save logs from your source (examples):

tailpipe collect pipes_audit_log

Enter interactive query mode:

tailpipe query

Run a query:

select
  action_type,
  target_handle,
  count(*) as event_count
from
  pipes_audit_log
group by
  action_type,
  target_handle
order by
  event_count desc;
+---------------------------------------+-----------------------+-------------+
| action_type                           | target_handle         | event_count |
+---------------------------------------+-----------------------+-------------+
| workspace.snapshot.create             | pipelingsscaletesting | 343         |
| workspace.schema.create               | smoketestv11925       | 8           |
| workspace.snapshot.create             | smoketestv11925       | 7           |
| pipeline.create                       | smoketestv11925       | 5           |
| pipeline.command.run                  | smoketestv11925       | 2           |
| workspace.mod.variable.setting.create | smoketestv11925       | 2           |
| workspace.mod.install                 | smoketestv11925       | 2           |
| workspace.snapshot.create             | smoketestv11923       | 2           |
| workspace.aggregator.create           | smoketestv11925       | 1           |
| workspace.delete                      | smoketestv11922       | 1           |
| workspace.snapshot.create             | smoketestv11922       | 1           |
| workspace.create                      | smoketestv11925       | 1           |
| datatank.table.create                 | smoketestv11925       | 1           |
| datatank.create                       | smoketestv11925       | 1           |
+---------------------------------------+-----------------------+-------------+

Developing

Prerequisites:

Clone:

git clone https://github.com/turbot/tailpipe-plugin-pipes.git
cd tailpipe-plugin-pipes

After making your local changes, build the plugin, which automatically installs the new version to your ~/.tailpipe/plugins directory:

make

Re-collect your data:

tailpipe collect pipes_audit_log

Try it!

tailpipe query
> .inspect pipes_audit_log

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!

Tailpipe 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 #tailpipe on Slack →

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