Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/metrico/qryn-view

qryn polyglot user interface to explore logs, metrics and traces :eye: Grafana Explore alternative compatible with Loki, Prometheus and Tempo
https://github.com/metrico/qryn-view

clickhouse cloki grafana-explore logql loki metrics opentelemetry prometheus promql qxip react tempo traces

Last synced: about 1 month ago
JSON representation

qryn polyglot user interface to explore logs, metrics and traces :eye: Grafana Explore alternative compatible with Loki, Prometheus and Tempo

Lists

README

        

[![Node.js CI](https://github.com/metrico/cloki-view/actions/workflows/ci-release.yml/badge.svg)](https://github.com/metrico/cloki-view/actions/workflows/ci-release.yml)
[![CodeQL](https://github.com/metrico/cloki-view/actions/workflows/codeql-scanner.yml/badge.svg)](https://github.com/metrico/cloki-view/actions/workflows/codeql-scanner.yml)

# :eye: qryn view

*qryn-view* is a smart and minimal LogQl, Metrics, Traces and Flux API data explorer developed in React/JS and designed for [qryn](https://qryn.dev)

![qryn-view-demo](https://user-images.githubusercontent.com/1423657/200136242-f4133229-ee7c-45e0-8228-8734cf56140a.gif)

### Features

**Data Sources Settings**
- URL, Headers
- Basic Auth
- Quick Setting (clone one setting for all datasources)
- Use for all (use current setting for all datasources)

**Browsers:**
- Logs
- Metrics
- Traces
- Flux (experimental)

**Display:**
- Logs & Charts
- Traces View
- Table view
- Link Logs with Traces
- Split data views
- Multi query execution
- Timerange Selector
- Query History
- Mobile View
- 100% Client-Side

------------
### Usage

**Local development:**

Clone Repo

```bash
git clone https://github.com/metrico/qryn-view
```

Install packages
```bash
pnpm install
```
---

**Local Build:**

Build local clone
```bash
pnpm run build
```
Install Serve (npm serve)
```bash
sudo npm i -g serve

serve -s ./packages/main/dist
```
---

**Releases**

check our [Qryn View Releases](https://github.com/metrico/qryn-view/releases)

---

_Use the [public client](https://view.cloki.org) _(no data goes through the server)_ or [build](BUILD.md) and run your own instance_

#### Environment Variables:

- ``HOST`` default: `` 0.0.0.0``

- ``PORT`` default: ``8080``

- ``API_URL`` default: ``http://localhost:3100``

##### Example
```bash
~/$ HOST=localhost PORT=8080 API_URL=http://qryn-host:3100 pnpm dev
```
------------

##### Available Routes

- qryn-view works under a hash router to make it flexible for static deployments and simpler to run over a single route.

Current available routes:

`/#/datasources` : Datasources settings

`/#/search` : Main search view

`/#/users` : users reserved route

`/#/plugins` : custom plugins

------------

##### URL Parameters

_qryn-view can be controlled globally through URL parameters__

| param | description | default |
|-------|-------------|---------|
| `start` | _timestamp Ns_ | now |
| `stop` | _timestamp Ns_ | |
| `isEmbed` | _embed mode_ | false |
| `theme` | _application theme_ | dark |
| `left` | _left panel queries details_ | |
| `right` | _right panel queries details_ | |

------------

#### Query Data (logql, metrics, traces, flux) inside left or right panel
_JSON stringifyed and URL encoded_

- *id*: - query ID
- *idRef* - Title for a query
- *expr* - query expression (neeeds to be URL encoded)
- *limit* - query limit
- *dataSourceType* - 'logs', 'metrics', 'traces', 'flux'.
- *dataSourceURL* - the datasource API URL.
- *dataSourceId* - Data Source Id inside Data Sources Setting

------------

### About qryn

Consult the [qryn Wiki](https://github.com/metrico/qryn/wiki/LogQL-Supported-Queries) for a detailed list of the project and its supported features, [changelog](https://github.com/metrico/qryn/wiki/Changelog) and [API functionality](https://github.com/metrico/qryn/wiki/HTTP-API)

### Acknowledgements
- (C) 2022 QXIP BV 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-view is part of the qryn project, licensed under the AGPLv3 LICENSE by QXIP BV