Skip to content

Commit

Permalink
Merge pull request #98 from metrico/joel-feat-split-view
Browse files Browse the repository at this point in the history
**Split View and Multiple Queries Feature:**

 - Split View Mode
 - Multiple Queries
 -  Query Name Edition and Details Popup
 - Data View (Window) sizes: normal, minimize, max size
 - Auto step (resolution) calculation for charts
 - Full size charts
 - Mobile view: 
   - panels in tabs
   - query options popup
  • Loading branch information
jacovinus authored Sep 7, 2022
2 parents 97b147b + 40362bc commit efc541e
Show file tree
Hide file tree
Showing 164 changed files with 41,986 additions and 38,083 deletions.
28 changes: 23 additions & 5 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src='https://user-images.githubusercontent.com/1423657/147935343-598c7dfd-1412-4bad-9ac6-636994810443.png' style="margin-left:-10px" width=220>

# :eye: cLoki View
# :eye: qryn View

### Build Instructions

Expand All @@ -12,18 +12,36 @@
~/$ npm install
```

##### build (dist):
##### serve (development mode):

```bash
~/$ npm start
```

will serve the UI on ``http://localhost:8080``

##### Build (dist):


```bash
~/$ npm run build
```
##### start (development mode):
#### *Serve (dist):*

1 - Install serve utility

```bash
~/$ npm start
~/$ npm i -g serve
```

will serve the UI on ``http://localhost:8080``
2 - Serve

```bash
~/$ serve -s build
```

will serve by default the UI on ``http://localhost:3000``


#### API Endpoint

Expand Down
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# :eye: qryn view

qryn-view is a smart and minimal LOgQL API data explorer developed in React/JS and designed for [qryn](https://cloki.org)
*qryn-view* is a smart and minimal LOgQL API data explorer developed in React/JS and designed for [qryn](https://cloki.org)

<img src="https://user-images.githubusercontent.com/1423657/152640509-82d7704a-4e9a-4a2b-9b7e-1819984c7581.png"/><img src="https://user-images.githubusercontent.com/1423657/155608224-8654694b-b999-4781-994a-5a87e39dfddf.png" /><img src="https://user-images.githubusercontent.com/1423657/182931606-4bffa314-1aef-4712-8229-716e43e4efc3.png" />

Expand All @@ -15,15 +15,18 @@ qryn-view is a smart and minimal LOgQL API data explorer developed in React/JS a
- Label Browser
- Display Logs & Charts
- Timerange Selector
- Split data views
- Multi query execution
- Query History
- Mobile View
- Copy Link
- Embeddable Results
- 100% Client-Side


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

Use the [public client](https://view.cloki.org) _(no data goes through the server)_ or [build](BUILD.md) and run your own instance
_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:

Expand All @@ -35,23 +38,35 @@ Use the [public client](https://view.cloki.org) _(no data goes through the serve
```bash
~/$ HOST=localhost PORT=8080 API_URL=http://cloki-host:3100 npm start
```

------------
##### URL Parameters
cLoki-view can be controlled through URL parameters
_cLoki-view can be controlled through URL parameters__

| param | description | |
| param | description | default |
|-------|-------------|---------|
| `apiUrl` | _LogQL API URL_ | http://localhost:3100 |
| `query` | _LogQL query_ | |
| `from` | _timestamp Ns_ | |
| `to` | _timestamp Ns_ | |
| `limit` | _query limit_ | |
| `step` | _query step_ | |
| `start` | _timestamp Ns_ | now |
| `stop` | _timestamp Ns_ | |
| `step` | _query step_ | 5 |
| `isEmbed` | _embed mode_ | false |
| `theme` | _application theme_ | dark |
| `left` | _left panel queries details_ | |
| `right` | _right panel queries details_ | |


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

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

- *id*: query ID
- *idRef* Title for a query
- *expr* query expression
- *limit* query limit

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


### 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)
Expand All @@ -60,5 +75,5 @@ Consult the [qryn Wiki](https://github.com/metrico/qryn/wiki/LogQL-Supported-Que
- (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 is part of the cLoki project, licensed under the AGPLv3 LICENSE by QXIP BV
[^2]: qryn-view is part of the qryn project, licensed under the AGPLv3 LICENSE by QXIP BV

Loading

0 comments on commit efc541e

Please sign in to comment.