https://github.com/kubesphere/monitoring-dashboard
Custom Metrics Monitoring Dashboard for Apps on KubeSphere
https://github.com/kubesphere/monitoring-dashboard
Last synced: 2 months ago
JSON representation
Custom Metrics Monitoring Dashboard for Apps on KubeSphere
- Host: GitHub
- URL: https://github.com/kubesphere/monitoring-dashboard
- Owner: kubesphere
- License: apache-2.0
- Created: 2020-03-26T08:50:13.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T02:18:36.000Z (over 2 years ago)
- Last Synced: 2024-04-13T21:43:11.143Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 11.4 MB
- Stars: 16
- Watchers: 5
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KubeSphere Monitoring Dashboard
The project is inspired by [Grafana](http://grafana.com/) but with significant difference in data persistence, multitenancy supports and dashboard template sharing to fit KubeSphere's context. It is not a replacement to Grafana. It requires KubeSphere backend and frontend to work.
This repo is aimed at KubeSphere developers who want to understand dashboard data model, concepts and usage and how to contribute, as the custom monitoring feature is introduced as of v3.0.
## Table of contents
- [KubeSphere Monitoring Dashboard](#kubesphere-monitoring-dashboard)
- [Table of contents](#table-of-contents)
- [Get Started](#get-started)
- [Prerequisites](#prerequisites)
- [Quick Start](#quick-start)
- [Concept and Design](#concept-and-design)
- [Data Model](#data-model)
- [Metadata](#metadata)
- [Panels](#panels)
- [Templatings](#templatings)
- [Data Source](#data-source)
- [Multi-tenancy](#multi-tenancy)
- [Dashboard Template](#dashboard-template)
- [Manual](#manual)
- [annotations](#annotations)
- [Query](#query)
- [Panels](#panels-1)
- [Chart](#chart)
- [Legend](#legend)
- [Time Range](#time-range)
- [Variables](#variables)
- [converter tool](#converter-tool)
- [Usage](#usage)
- [Integration with kubesphere backend](#integration-with-kubesphere-backend)
- [Development](#development)
- [APIs](#apis)
- [Backend](#backend)
- [Frontend](#frontend)
- [Contributing](#contributing)
- [Dashboard Gallery](#dashboard-gallery)
## Get Started
## Prerequisites
- Kubernetes v17.0+
- KubeSphere v3.0+
## Quick Start
TODO(@FeynmanZhou)
The stack making these possible includes KubeSphere backend, console and custom resources for dashboards.
- [KubeSphere Backend](https://github.com/kubesphere/kubesphere): proxies metrics query, ensures data isolation over namespaces.
- [KubeSphere Console](https://github.com/kubesphere/console): renders the dashboard with data and charts.
- CustomResourceDefinition for Dashboard: defines dashboard data model.
## Concept and Design
### Data Model
Dashboards are backed by the custom resource definition (CRD) **`Dashboard`**. It is compromised of three components: metadata, panels and templatings. Below is an example:
```yaml
apiVersion: monitoring.kubesphere.io/v1alpha1
kind: Dashboard
metadata:
name: mysql-overview
namespace: default
spec:
title: MySQL Overview
description: MySQL dashboard for the mysql exporter
time:
from: now-1h
to: now
datasource: prometheus
panels:
- type: singlestat
title": Instance Up
targets:
- expr: mysql_up{release="$release"}
instant: "true"
- type: graph
title: mysql disk reads vs writes
targets:
- expr": irate(mysql_global_status_innodb_data_reads{release="$release"}[10m])
legendFormat": reads
- expr": irate(mysql_global_status_innodb_data_writes{release="$release"}[10m])
legendFormat": write
templatings:
- name: release
query: label_values(mysql_up,release)
type: query
sort: 0
```
Or you can use apiversion `monitoring.kubesphere.io/v1alpha2`, more fields are supported.
```yaml
apiVersion: monitoring.kubesphere.io/v1alpha2
kind: Dashboard
metadata:
name: mysql-overview-rev5
namespace: default
spec:
annotations:
- datasource: -- Grafana --
enable: true
iconColor: '#e0752d'
name: PMM Annotations
tags:
- pmm_annotation
type: tags
auto_refresh: 1m
editable: true
panels:
- colors:
- rgba(245, 54, 54, 0.9)
- rgba(237, 129, 40, 0.89)
- rgba(50, 172, 45, 0.97)
datasource: ${DS_PROMETHEUS}
decimals: 1
description: |-
**MySQL Uptime**
The amount of time since the last restart of the MySQL server process.
format: s
gauge:
maxValue: 100
thresholdMarkers: true
height: 125px
id: 12
targets:
- expr: mysql_global_status_uptime
refId: 1
step: 1m
title: MySQL Uptime
type: singlestat
valueName: current
templatings:
- default: $__auto_interval_interval
label: Interval
name: interval
type: interval
values:
- $__auto_interval_interval
- 1s
- 5s
- 1m
- 5m
- 1h
- 6h
- 1d
- datasource: ${DS_PROMETHEUS}
label: Host
name: host
request: label_values(mysql_up, instance)
type: query
time:
from: now-12h
to: now
timezone: browser
title: MySQL Overview
```
The two versions can be compatible with each other while applying the newly CustomResourceDefinition lacated at `config/crd/bases`.
#### Metadata
|Name|Desc|
|---|---|
|`spec.title`|dashboard title|
|`spec.description`|dashboard description|
|`spec.time`|time range for display. see [Time Range](#time-range) for more info|
|`spec.datasource`|data source to query, defaults to Prometheus|
|`spec.annotations`|annotations for the grafana templates|
#### Panels
The `spec.panels` defines a collection of panels. Panels are build blocks of a dashboard. Currently supported panels are row, singlestat, graph and table. See [Query](#query) and [Panels](#panels) for more info.
#### Templatings
The `spec.templatings` defines a collection of variables. It is convenient to use variables in query expressions. See [Variable](#variable) for more info.
> Note that the data model is heavily inspired by [Grafana JSON model](https://grafana.com/docs/grafana/latest/reference/dashboard/) to gain compatibility. However, to adapt it to KubeSphere's context, we may bring in new fields and break changes.
### Data Source
Note: we currently only support Prometheus as data source.
### Multi-tenancy
Metrics data should be isolated across namespaces, which means namespace members can only view metrics in the namespace they belong to. This is implemented in the phase of [querying](#query). Any user-written expression will be mutated to make sure no query outside the scope of the namespace.
Take the datasource Prometheus for example, KubeSphere backend will add a namespace matcher, i.e. `{namespace=}`, to each query.
### Dashboard Template
Dashboard is represented by a custom resource object. Select templates from [contrib/gallery](contrib/gallery), and run the following command to import:
```
kubectl apply --namespace -f contrib/gallery/
```
You can also open source your template and contribute to Dashboard Gallery. Templates in Dashboard Gallery will be shipped with KubeSphere.
## Manual
### annotations
Now we support annotations in version v1alpha2. Refers to `api/v1alpha2/annotations`, the merged structure definition inspired by [the grafana sdk](https://pkg.go.dev/github.com/grafana-tools/sdk#Annotation) makes a simplified definition.
### Query
Except for the panel `row` , and the `text` panel in version v1alpha2, each panel accepts at least one data source query. It allows you to input query expressions and fetch metrics data.
You can use placeholders in queries. See [Variables](#variables) for more information.
### Panels
#### Chart
We currently support three types of panels in version v1alpha1:
- Row
- Singlestat
- Graph
And, support other types as following in version v1alpha2:
- bargauge
- table
- text
#### Legend
### Time Range
Time range specifies current dashboard time for display. The following are examples in use.
|Example|From|To|
|--|--|--|
|Last 5 minutes|now-5m|now|
|Today|now-1d|now|
|This week|now-1w|now|
|Last month|now-2M|now-1M|
### Variables
|Query|Desc|
|--|--|
|label_values(metric, label)|Returns a list of label values for the label in the specified metric.|
## converter tool
we support a converter tool located at `tools/converter/dashboard_converter.go` can be used for importing dashboards from Grafana dashboard templates.
### Usage
```
Usage of converter:
-inputPath string
a input path for the converter to look for jobs (default "./manifests/inputs")
-isClusterCrd
a flag that defines whether build the cluster dashboard resource or not
-name string
name of the dashboard resource (default "your file name")
-namespace string
namespace of the dashboard resource (default "default")
-outputPath string
a output path for the converter to store manifests (default "./manifests/outputs")
```
if we want to convert a dashboard json template to a k8s manifest, you can use make cmdline like this below:
```
make convert -isClusterCrd=$(IS_CLUSTER_CRD) -namespace=$(NAMESPACE) -inputPath=$(INPUT) -outputPath=$(OUTPUT)
```
or:
```
go run ./cmd/converter -isClusterCrd=$(IS_CLUSTER_CRD) -namespace=$(NAMESPACE) -inputPath=$(INPUT) -outputPath=$(OUTPUT) -name=$(Name)
```
### Integration with kubesphere backend
In addition to the command line above, the method `ConvertToDashboard` located at `tools/converter/dashboard_converter.go` can read bytes from Grafana dashboard templates, and convert to a `Dashboard` model, therefore the frontend developers can make visual presentations as needed.
## Development
### APIs
For dashboard APIs, see [docs/crd.md](docs/crd.md)
The project is built with kubebuilder v2.3.0.
### Backend
If you find some fields should be included in the CRD, edit [api package](https://github.com/kubesphere/monitoring-dashboard/tree/master/api/) and regenerate the project by `make`. Kubebuilder is the tool we are using.
If you find bugs or want to add new APIs, implement new datasources to KubeSphere, read KubeSphere [developer guides](https://github.com/kubesphere/community/tree/master/developer-guide/concepts-and-designs) for monitoring.
### Frontend
@TODO(justahole)
## Contributing
### Dashboard Gallery
If you want to share your dashboard templates, you can submit dashboard template yaml files to gallery folder with an elaborate readme. Outstanding templates will be selected to ship with KubeSphere future releases.