⚠️ Project is under development - features and apis are subject to change
Query Lookout is a small and simple tool designed to simplify and enhance the way you monitor and manage your database content. As data grows in complexity and volume, keeping a vigilant eye on changes becomes crucial. Query-Lookout allows you to define rules, alerting you to relevant modifications or data constellations in your database.
Want to see what has changed? Take a look at the Changelog
- Create a new lookout
- Define a display name
- Configure a cron expression how often it should run (details here)
- Define the SQL query that should be run
- Configure desired notification channels (in app notification is on by default)
- Define one or more rules that validate the result of the lookout
- Column that should be checked
- Row from which the value should be used (counting starts with
0) - Column type (text, int, float)
- Rule type (exact value, should be null, greater/less than, between)
- Expected value
reamde_demo.mp4
-
Rule-based Monitoring: Create customizable rules to monitor specific changes or data constellations in your database. Define conditions that matter most to you and receive timely alerts when those conditions are met.
-
Alert Notifications: Receive notifications in real-time through various channels, such as email, in app notifications or local notifications (more coming). Stay informed about important updates without the need to constantly check the database.
-
Easy Configuration: Set up rules effortlessly with an intuitive configuration interface. No need for complex queries or scripts – Query Lookout streamlines the process, making monitoring accessible to everyone.
-
Database Compatibility: Query Lookout supports a wide range of databases, ensuring flexibility and compatibility with popular database management systems.
-
Single Binary: Everything you need in one single binary - the core and web ui. Get up and running in a few steps - locally or whereever you want.
- Install query-lookout (details here)
- Create the configuration file
~/.qlookout(details here)- Important config is
data_source, which defines the connection string to your database
- Important config is
- Run
qlookout - Open http://localhost:63000/
- Enjoy
go install github.com/KarnerTh/qlookout@mainor via docker
docker run \
--network="" `# if you want to access another docker container` \
-v qlookout_data:/root `# if you want to persist your data` \
-e QL_DATA_SOURCE="" `# the datasource which you want to query` \
-p 63000:63000 `# port for the ui` \
-p 63001:63001 `# port for the core` \
ghcr.io/karnerth/qlookout:latest| Database | Example Connection-String |
|---|---|
| SQLite3 | sqlite3://your-file.db |
| PostgreSQL | postgresql://user:password@localhost:5432/yourDb |
| MySQL | mysql://root:password@tcp(127.0.0.1:3306)/yourDb |
| MSSQL | sqlserver://user:password@localhost:1433?database=yourDb |
# required
data_source The data source for the lookouts
# mail config
mail_from_address From which mail address the notifcation mails are sent
mail_to_address To which mail addresses notifcations are sent (multiple addresses separated by comma)
mail_smtp_host SMTP host
mail_smtp_port SMTP port
mail_username SMTP username
mail_password SMTP password
# optional
log_level Log level of the core (error, warn, info, debug)
database_file The file that is used for the internal sqlite database (defaults to `data.db` in your home directory)
base_url Base url of the application (e.g. for the notification deeplink)
The configs are loaded in that order (details can be found here)
- as environment variables with a
QL_prefix in ALL_CAPS - a yaml configuration file located in
~/.qlookout
log_level: INFO
database_file: "custom_file_name.db"
data_source: "sqlite3://data.db"
base_url: "https://karnerth.github.io/portfolio/"
mail_from_address: "test@works.at"
mail_to_address: "first@works.at,second@works.at"
mail_smtp_host: "localhost"
mail_smtp_port: "1025"
mail_username: "your@mail.net"
mail_password: "superSecret1"export QL_LOG_LEVEL="INFO"
export QL_DATABASE_FILE="custom_file_name.db"
export QL_DATA_SOURCE="sqlite3://data.db"
export QL_BASE_URL="https://karnerth.github.io/portfolio/"
export QL_MAIL_FROM_ADDRESS="test@works.at"
export QL_MAIL_TO_ADDRESS="first@works.at,second@works.at"
export QL_MAIL_SMTP_HOST="localhost"
export QL_MAIL_SMTP_PORT="1025"
export QL_MAIL_USERNAME="your@mail.net"
export QL_MAIL_PASSWORD="superSecret1"