Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dashboard: release 3.0.0 #230

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased
## [3.0.0] - 2024-07-09
Grafana revisions:
- Tarantool 3:
- [Prometheus revision 1](https://grafana.com/api/dashboards/21474/revisions/1/download),
- [InfluxDB revision 1](https://grafana.com/api/dashboards/21484/revisions/1/download);
- Tarantool Cartridge and 1.10—2.x:
- [Prometheus revision 19](https://grafana.com/api/dashboards/13054/revisions/19/download),
- [InfluxDB revision 19](https://grafana.com/api/dashboards/12567/revisions/19/download);
- Tarantool Data Grid 2:
- [Prometheus revision 8](https://grafana.com/api/dashboards/16406/revisions/8/download),
- [InfluxDB revision 8](https://grafana.com/api/dashboards/16405/revisions/8/download).

### Added
- `cluster_tarantool3` panels section (`cluster` for Tarantool 3) (#224)
Expand All @@ -22,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
- Removed extra quotation mark for TDG jobs_average_panel query (#220)


## [2.1.1] - 2023-06-01
Grafana revisions: [InfluxDB revision 18](https://grafana.com/api/dashboards/12567/revisions/18/download), [Prometheus revision 18](https://grafana.com/api/dashboards/13054/revisions/18/download), [InfluxDB TDG revision 7](https://grafana.com/api/dashboards/16405/revisions/7/download), [Prometheus TDG revision 7](https://grafana.com/api/dashboards/16406/revisions/7/download).

Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ test-deps: build-deps
run-tests:
./tests.sh
./promtool test rules example_cluster/prometheus/test_alerts.yml
./promtool test rules example_cluster/prometheus/test_cartridge_alerts.yml

.PHONY: update-tests
update-tests:
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
Dashboard for Tarantool application and database server monitoring, based on [grafonnet](https://github.com/grafana/grafonnet-lib) library.

Our pages on Grafana Official & community built dashboards:
- Tarantool Cartridge and Tarantool 1.10—2.x applications:
- Tarantool 3:
- [Prometheus](https://grafana.com/grafana/dashboards/21474),
- [InfluxDB](https://grafana.com/grafana/dashboards/21484);
- Tarantool Cartridge and 1.10—2.x:
- [Prometheus](https://grafana.com/grafana/dashboards/13054),
- [InfluxDB](https://grafana.com/grafana/dashboards/12567);
- TDG
- Tarantool Data Grid 2:
- [Prometheus](https://grafana.com/grafana/dashboards/16406),
- [InfluxDB](https://grafana.com/grafana/dashboards/16405).

Expand Down Expand Up @@ -36,9 +39,9 @@ Refer to dashboard [documentation page](https://www.tarantool.io/en/doc/latest/b

2. To import a specific dashboard, choose one of the following options:

- paste the dashboard id (for example, ``13054`` for Prometheus Tarantool Cartridge dashboard), or
- paste the dashboard id (for example, ``21474`` for Prometheus Tarantool 3 dashboard), or
- paste a link to the dashboard (for example,
https://grafana.com/grafana/dashboards/13054 for Prometheus Tarantool Cartridge dashboard), or
https://grafana.com/grafana/dashboards/21474 for Prometheus Tarantool 3 dashboard), or
- paste the dashboard JSON file contents, or
- upload the dashboard JSON file.

Expand Down
9 changes: 7 additions & 2 deletions doc/monitoring/grafana_dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,15 @@ Tarantool Grafana dashboards are available as part of
:widths: 25 75
:header-rows: 0

* Tarantool Cartridge and Tarantool 1.10—2.x applications:
* Tarantool 3:
- `Prometheus <https://grafana.com/grafana/dashboards/21474>`_,
- `InfluxDB <https://grafana.com/grafana/dashboards/21484>`_;

* Tarantool Cartridge and Tarantool 1.10—2.x:
- `Prometheus <https://grafana.com/grafana/dashboards/13054>`_,
- `InfluxDB <https://grafana.com/grafana/dashboards/12567>`_;

* TDG:
* Tarantool Data Grid 2:
- `Prometheus <https://grafana.com/grafana/dashboards/16406>`_,
- `InfluxDB <https://grafana.com/grafana/dashboards/16405>`_.

Expand All @@ -28,6 +32,7 @@ package functionality.
Dashboard requires using ``metrics`` **0.15.0** or newer for complete experience;
``'alias'`` :ref:`global label <metrics-api_reference-labels>` must be set on each instance
to properly display panels (e.g. provided with ``cartridge.roles.metrics`` role).
Starting from Tarantool 2.11.1, ``metrics`` are a built-in part of Tarantool binary.

To support `CRUD <https://github.com/tarantool/crud>`_ statistics, install ``CRUD``
**0.11.1** or newer. Call ``crud.cfg`` on router to enable CRUD statistics collect
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.cartridge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ services:
- 9090:9090
volumes:
- ./example_cluster/prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
- ./example_cluster/prometheus/alerts.yml:/etc/prometheus/alerts.yml
- ./example_cluster/prometheus/alerts.yml:/etc/prometheus/cartridge_alerts.yml

grafana:
image: grafana/grafana:8.1.3
Expand Down
25 changes: 0 additions & 25 deletions example_cluster/prometheus/alerts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,31 +82,6 @@ groups:
You are likely to hit limit soon.
It is strongly recommended to increase memtx_memory or number of storages in case of sharded data."

# Warning for Cartridge warning issues.
- alert: CartridgeWarningIssues
expr: tnt_cartridge_issues{level="warning"} > 0
for: 1m
labels:
severity: warning
annotations:
summary: "Instance '{{ $labels.alias }}' ('{{ $labels.job }}') has 'warning'-level Cartridge issues"
description: "Instance '{{ $labels.alias }}' of job '{{ $labels.job }}' has 'warning'-level Cartridge issues.
Possible reasons: high replication lag, replication long idle,
failover or switchover issues, clock issues, memory fragmentation,
configuration issues, alien members."

# Alert for Cartridge critical issues.
- alert: CartridgeCriticalIssues
expr: tnt_cartridge_issues{level="critical"} > 0
for: 1m
labels:
severity: page
annotations:
summary: "Instance '{{ $labels.alias }}' ('{{ $labels.job }}') has 'critical'-level Cartridge issues"
description: "Instance '{{ $labels.alias }}' of job '{{ $labels.job }}' has 'critical'-level Cartridge issues.
Possible reasons: replication process critical fail,
running out of available memory."

# Alert for Tarantool replication high lag (both for masters and replicas).
- alert: HighReplicationLag
expr: tnt_replication_lag > 1
Expand Down
Loading
Loading