Skip to content

Latest commit

 

History

History
152 lines (107 loc) · 5.17 KB

README.md

File metadata and controls

152 lines (107 loc) · 5.17 KB

GitHub Plugin for Tailpipe

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

GitHub is a provider of Internet hosting for software development and version control using Git. It offers the distributed version control and source code management (SCM) functionality of Git, plus its own features.

The GitHub Plugin for Tailpipe allows you to collect and query GitHub 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 github

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

vi ~/.tailpipe/config/github.tpc
partition "github_audit_log" "my_logs" {
  source "file"  {
    paths = ["/Users/myuser/github_logs"]
  }
}

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

tailpipe collect github_audit_log

Enter interactive query mode:

tailpipe query

Run a query:

select
  action,
  count(*) as event_count
from
  github_audit_log
group by
  action
order by
  event_count desc;
+---------------------------------------+-------------+
| action                                | event_count |
+---------------------------------------+-------------+
| pull_request.create                   | 7913        |
| pull_request.merge                    | 5754        |
| issue_comment.update                  | 4292        |
| protected_branch.policy_override      | 3304        |
| packages.package_version_published    | 2983        |
| pull_request_review.submit            | 2674        |
| pull_request.close                    | 2200        |
| pull_request_review_comment.create    | 1875        |
| pull_request.create_review_request    | 1793        |
| repository_vulnerability_alert.create | 1644        |
+---------------------------------------+-------------+

Detections as Code with Powerpipe

Pre-built dashboards and detections for the GitHub plugin are available in Powerpipe mods, helping you monitor and analyze activity across your GitHub accounts.

For example, the GitHub Audit Logs Detections mod scans your CloudTrail logs for anomalies, such as an S3 bucket being made public or a change in your VPC network infrastructure.

Dashboards and detections are open source, allowing easy customization and collaboration.

To get started, choose a mod from the Powerpipe Hub.

image

Developing

Prerequisites:

Clone:

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

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 github_audit_log

Try it!

tailpipe query
> .inspect github_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: