Skip to content

Latest commit

 

History

History
executable file
·
111 lines (86 loc) · 3.69 KB

README.adoc

File metadata and controls

executable file
·
111 lines (86 loc) · 3.69 KB
Raw

inquest

A CLI tool, written in Rust, to execute networking-tests, like HTTP, database-queries or simple TCP connections from a host against other systems to troubleshoot outages.

ℹ️
 This is a learning project for Rust, so it might use language-features in regard to code-organisation, or language-features that would not be necessary for such a small tool.

Purpose

In an ideal world, all applications would properly monitor their dependencies and provide useful feedback in case of an outage. Usually that’s not the case.

Monitoring all systems from the outside can catch some but not all problems. It could be that a firewall appliance has been updated and suddenly communication between your application and the database is blocked but all other systems are still able to talk to the database.

Anything inquest can do, could also be done with scripting (Bash, Python, etc.) but then you will have to manage additional dependencies on your system. Bash will need nc, curl, database-clients and Python will need the interpreter as well as a dependency-management which can be quite troublesome. inquest ships everything included, which of course means that it supports what have been baked into it, so it is less generic.

⚠️
 unfortunately the Oracle client library still requires the ODPI-C runtime installed. I will try to find another way once the features are more stable. For now it works.

Usage

inquest can be used to run a set of probes configured with a simple and readable Hocon specification.

Sample Specification
# showcasing variable substitution in HOCON
httpbin = "https://httpbin.org"

probe-specification {

 my-service {

  http = [
      {
        url = ${httpbin}/get
      },
      {
        url = ${httpbin}/status/201
        status = 201
      }
    ]

  oracle = [{
      host = "my-oracle-host"
      host = ${?ORACLE_HOST} # use this when defined as env
      port = 1521 # can be omitted when 1521
      sid = "XE"
      user = "SYSTEM"
      password = "hX8AgBVOd/GvecheybpEPA==" # 'changeit'
      sql {
        query = "select * from V$SESSION_CONNECT_INFO"
      }
    }]

  postgres = [{
      host = "my-postgres-host"
      host = ${?POSTGRES_HOST} # # use this when defined as env
      port = 5432 # can be omitted when 5432
      user = "admin"
      password = "hX8AgBVOd/GvecheybpEPA==" # 'changeit'
      database = "test"
      sql {
        query = "SELECT (blks_hit*100/(blks_hit+blks_read))::numeric as hit_ratio FROM pg_stat_database WHERE datname='test';"
      }
    }]
 }
}
Run with a "default.conf" in the current folder
./inquest
Pass the specification not using the default
./inquest --config path/my-file.conf

Later on, it will be possible to execute probes ad-hoc without the need of a config-file.

Encryption

Passwords must be encrypted within the HOCON definition, and therefore inquest includes an encrypt subcommand. By default a internal encryption-key is used, but since this can easily be looked up in Github, you can pass in your own by using the --key option. Remember to also pass this key to inquest when running a test.

⚠️
 never mix passwords with the default and a custom key in one specification. 
./inquest encrypt --key RvzQW3MwrcDpPZl8rP3,=HsD1,wdgdew  "my password"
ℹ️
 you might want to delete the history after using a custom-key