qryn

/ˈkwɪr..ɪŋ/

LogQL for ClickHouse, and beyond

qryn is a polyglot LogQL API built on top of ClickHouse with native support for popular data ingestion formats

• Built in Explore UI and LogQL CLI for querying and extracting data
• Native Grafana [^3] and LogQL APIs for querying, processing, ingesting, tracing and alerting [^2]
• Powerful pipeline to dynamically search, filter and extract data from logs, events, traces and beyond
• Ingestion and PUSH APIs transparently compatible with LogQL, PromQL, InfluxDB, Elastic and more
• Ready to use with Agents such as Promtail, Grafana-Agent, Vector, Logstash, Telegraf and many others
• Cloud native, stateless and compact design
  

:octocat: Get started using our Documentation or consult the Wiki :bulb:

⚠️ Existing user and confused? The project has been renamed to qryn (/ˈkwɪr..ɪŋ/) 👍

Project Background

qryn implements a complete LogQL API buffered by a fast bulking LRU sitting on top of ClickHouse tables and relying on its columnar search and insert performance alongside solid distribution and clustering capabilities for stored data. qryn does not parse or index incoming logs, but rather groups log streams using the same label system as Prometheus. [^2]

:fire: LogQL: Supported Features

qryn implements a broad range of LogQL Queries to provide transparent compatibility with the Loki API
The Grafana Loki datasource can be used to natively query logs and display extracted timeseries

:tada: No plugins needed

• Log Stream Selector
• Line Filter Expression
• Label Filter Expression
• Parser Expression
• Log Range Aggregations
• Aggregation operators
• Unwrap Expression.
• Line Format Expression

:fire: Follow our examples to get started

:fuelpump: Log Streams

qryn supports input via Push API using JSON or Protobuf and it is compatible with Promtail and any other LogQL compatible agent. On top of that, qryn also accepts and converts log and metric inserts using Influx, Elastic, Tempo and other common API formats.

Our preferred companion for parsing and shipping log streams to qryn is paStash with extensive interpolation capabilities to create tags and trim any log fat. Sending JSON formatted logs is suggested when dealing with metrics.

:fire: CliQL: Experimental 2.0 Features

qryn implements custom query functions for ClickHouse timeseries extraction, allowing direct access to any existing table

Timeseries

Convert columns to tagged timeseries using the emulated LogQL 2.0 query format

<aggr-op> by (<labels,>) (<function>(<metric>[range_in_seconds])) from <database>.<table> where <optional condition>

Examples

avg by (source_ip) (rate(mos[60])) from my_database.my_table

sum by (ruri_user, from_user) (rate(duration[300])) from my_database.my_table where duration > 10

ClickHouse

Convert columns to tagged timeseries using the experimental clickhouse function

Example

clickhouse({ 
  db="my_database", 
  table="my_table", 
  tag="source_ip", 
  metric="avg(mos)", 
  where="mos > 0", 
  interval="60" 
})

Query Options

Setup

Check out the Wiki for detailed instructions or choose a quick method:

:busstop: GIT (Manual)

Clone this repository, install with npmand run using nodejs 14.x (or higher)

npm install
CLICKHOUSE_SERVER="my.clickhouse.server" CLICKHOUSE_AUTH="default:password" CLICKHOUSE_DB="qryn" node qryn.js

:busstop: NPM

Install qryn as global package on your system using npm

sudo npm install -g qryn
cd $(dirname $(readlink -f `which qryn`)) \
  && CLICKHOUSE_SERVER="my.clickhouse.server" CLICKHOUSE_AUTH="default:password" CLICKHOUSE_DB="qryn" qryn

:busstop: PM2

sudo npm install -g qryn pm2
cd $(dirname $(readlink -f `which qryn`)) \
  && CLICKHOUSE_SERVER="my.clickhouse.server" CLICKHOUSE_AUTH="default:password" CLICKHOUSE_DB="qryn" pm2 start qryn
pm2 save
pm2 startup

:busstop: Docker

For a fully working demo, check the docker-compose example

Logging

The project uses pino for logging and by default outputs JSON'ified log lines. If you want to see "pretty" log lines you can start qryn with npm run pretty

Configuration

The following ENV Variables can be used to control qryn parameters and backend settings.

Contributors

Disclaimer

©️ QXIP BV, released under the GNU Affero General Public License v3.0. See LICENSE for details.

[^1]: qryn is not affiliated or endorsed by Grafana Labs or ClickHouse Inc. All rights belong to their respective owners.

[^2]: qryn is a 100% clear-room api implementation and does not fork, use or derivate from Grafana Loki code or concepts.

[^3]: Grafana®, Loki™ and Tempo® are a Trademark of Raintank, Grafana Labs. ClickHouse® is a trademark of ClickHouse Inc. Prometheus is a trademark of The Linux Foundation.