alekseyberegov / caps-holder

CAPS HOLDER

Keeping CAPS in the right place

░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░▒▒░░░░░░░░░░░░░░░░░░░░▒▒░░░░░░░░░░░░▒▒░░░░░░▒▒░░░░░░░░░░░░░░░░░░░░▒▒░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████████████▒▒██████████░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██              ██▒▒▒▒▒▒██████░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██                ████▒▒▒▒▒▒▒▒████░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██        ▒▒          ████▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██      ▒▒▒▒▒▒          ██▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██      ▒▒▒▒▒▒          ██▒▒▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██    ▒▒▒▒▒▒▒▒▒▒        ██▒▒▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██          ▒▒            ██▒▒▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░████▒▒██                      ██▒▒▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░████▒▒▒▒▒▒▒▒████                  ██▒▒▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██████          ████▒▒████████░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░██████████████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░████░░░░░░████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██▒▒▒▒▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░██▒▒▒▒▒▒▒▒██░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░▒▒░░░░░░▒▒░░▒▒░░░░░░░░▒▒░░░░░░████████░░░░░░▒▒░░░░░░▒▒░░▒▒░░░░░░░░▒▒░░░░░░▒▒░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
▒▒░░░░░░▒▒░░░░▒▒▒▒░░▒▒▒▒░░░░░░▒▒░░▒▒▒▒▒▒▒▒▒▒▒▒░░░░░░▒▒░░░░▒▒▒▒░░▒▒▒▒░░▒▒░░▒▒░░░░▒▒▒▒░░▒▒

Quick start

1. Install dependencies

   make init

2. Start a tunnel to CATS service

   ./tunnel_cats.sh -u <your_name>@dev.clicktripz.com

3. From another terminal window run CATS interrogator

   ./runit.sh

4. Use SQL to analyze data

   ./caps_stats.sh 
   

Using runit.sh

Usage:
  runit.sh [OPTIONS]

Run CAPS spider/scraper/CATS interrogator

Options:
  -c, --config string       specify config for scraping
  -e, --endpoint string     specify CATS endpoint
  -l, --loglevel string     set log level (default: DEBUG)
  -d, --debug               set debug mode for CATS
  -s, --settings            show default settings
  -h, --help                show help

Using tunnel_cats.sh

Usage:
  tunnel_cats.sh [OPTIONS]

Setup a SSH channel to CATS service

Options:
  -u, --user string       specify <user>@<host> to log in as on the remote machine
  -s, --service hostname  the hostname of CATS service (default: prod-ds-cats.cubaneddie.k8s.clicktripz.io)
  -p, --port number       the local port for the SSH tunnel (default: 8888)
  -k, --key filename      specify a file from which the identity for public key authentication is read (default: ~/.ssh/id_rsa)
  -h, --help              show help