Skip to content

Commit

Permalink
docs: fix image links in public readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hagen1778 committed Jan 30, 2025
1 parent 2b51260 commit 61d6d07
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 16 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## tip

* BUGFIX: fix image links in public readme.

## v0.14.2

* BUGFIX: fix issue with plugin signature.
Expand Down
22 changes: 6 additions & 16 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The VictoriaLogs Grafana plugin allows Grafana to query, visualize,
and interact with [VictoriaLogs](https://docs.victoriametrics.com/victorialogs),
a high-performance log storage and processing system.

![dashboard.png](https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/dashboard.png)
<img alt="Grafana Dashboard Screenshot" src="https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/dashboard.png?raw=true">

## Capabilities

Expand Down Expand Up @@ -32,19 +32,10 @@ Provisioning of Grafana plugin requires creating [datasource config file](http:/
```yaml
apiVersion: 1
datasources:
# <string, required> Name of the VictoriaLogs datasource
# displayed in Grafana panels and queries.
- name: VictoriaLogs
# <string, required> Sets the data source type.
type: victoriametrics-logs-datasource
# <string, required> Sets the access mode, either
# proxy or direct (Server or Browser in the UI).
access: proxy
# <string> Sets URL for sending queries to VictoriaLogs server.
# see https://docs.victoriametrics.com/victorialogs/querying/
url: http://victorialogs:9428
# <string> Sets the pre-selected datasource for new panels.
# You can set only one default data source per organization.
isDefault: true
```
Expand All @@ -56,27 +47,26 @@ Queries can be built using raw LogsQL or via QueryBuilder.
See panels examples at [VictoriaMetrics playground](https://play-grafana.victoriametrics.com/d/be5zidev72m80f/k8s-logs-demo)
and LogsQL examples [here](https://docs.victoriametrics.com/victorialogs/logsql-examples/).
### Logs panel
For using [Logs panel](https://grafana.com/docs/grafana/latest/panels-visualizations/visualizations/logs/)
switch to `Raw Logs` query type:

![panel_logs.png](https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_logs.png)
<img alt="Logs panel" src="https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_logs.png?raw=true">

### Time series panel

For using [Time series panel](https://grafana.com/docs/grafana/latest/panels-visualizations/visualizations/time-series/)
switch to `Range` query type:

![panel_time_series.png](https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_time_series.png)
<img alt="Time series panel" src="https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_time_series.png?raw=true">

### Stats panel

For using [Stats panel](https://grafana.com/docs/grafana/latest/panels-visualizations/visualizations/stat/)
switch to `Instant` query type:

![panel_stat.png](https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_stat.png)
<img alt="Stats panel" src="https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_stat.png?raw=true">

For enabling background visualization switch to `Range` query type.

Expand All @@ -85,11 +75,11 @@ For enabling background visualization switch to `Range` query type.
For using [Table panel](https://grafana.com/docs/grafana/latest/panels-visualizations/visualizations/table/)
switch to `Raw Logs` query type:

![panel_table.png](https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_table.png)
<img alt="Table panel" src="https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_table.png?raw=true">

And apply `Transformations` by labels:

![panel_table_transformation.png](https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_table_transformation.png)
<img alt="Transformations" src="https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/panel_table_transformation.png?raw=true">

## License

Expand Down

0 comments on commit 61d6d07

Please sign in to comment.