Skip to main content

Grafana construct for cdk8s.

Project description

cdk8s-grafana

View on Construct Hub

cdk8s-grafana is a library that lets you easily define a Grafana service for your kubernetes cluster along with associated dashboards and datasources, using a high level API.

Usage

To apply the resources generated by this construct, the Grafana operator must be installed on your cluster. See https://operatorhub.io/operator/grafana-operator for full installation instructions.

The following will define a Grafana cluster connected to a Prometheus datasource:

import { Grafana } from 'cdk8s-grafana';

// inside your chart:
const grafana = new Grafana(this, 'my-grafana', {
  defaultDataSource: {
    name: 'Prometheus',
    type: 'prometheus',
    access: 'proxy',
    url: 'http://prometheus-service:9090',
  }
});

Basic aspects of a dashboard can be customized:

const github = grafana.addDatasource('github', ...);
const dashboard = grafana.addDashboard('my-dashboard', {
  title: 'My Dashboard',
  refreshRate: Duration.seconds(10),
  timeRange: Duration.hours(6), // show metrics from now-6h to now
  plugins: [
    {
      name: 'grafana-piechart-panel',
      version: '1.3.6',
    }
  ],
});

Note: the kubernetes grafana operator only supports one Grafana instance per namespace (see https://github.com/grafana-operator/grafana-operator/issues/174). This may require specifying namespaces explicitly, e.g.:

const devGrafana = new Grafana(this, 'my-grafana', {
  namespace: 'dev',
});
const prodGrafana = new Grafana(this, 'my-grafana', {
  namespace: 'prod',
});

The grafana operator must be installed in each namespace for the resources in that namespace to be recognized.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk8s-grafana-0.1.382.tar.gz (328.0 kB view details)

Uploaded Source

Built Distribution

cdk8s_grafana-0.1.382-py3-none-any.whl (326.1 kB view details)

Uploaded Python 3

File details

Details for the file cdk8s-grafana-0.1.382.tar.gz.

File metadata

  • Download URL: cdk8s-grafana-0.1.382.tar.gz
  • Upload date:
  • Size: 328.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for cdk8s-grafana-0.1.382.tar.gz
Algorithm Hash digest
SHA256 54f9a4db7dbac7f1f7ab827d16ae2b4cd2a5e9edf8bd088a6cd6d272db8bcc54
MD5 8065b9249d9f95ce5276aea4c8d2ae23
BLAKE2b-256 59473df6bc161356ea2ffee89aa7ce48f43c3182c20a93774a42ee6747b7e6f5

See more details on using hashes here.

File details

Details for the file cdk8s_grafana-0.1.382-py3-none-any.whl.

File metadata

File hashes

Hashes for cdk8s_grafana-0.1.382-py3-none-any.whl
Algorithm Hash digest
SHA256 bd6801e8255f7e07ca98131d2cbd268f4d087f45c58ce14772bf0dcf73fba07c
MD5 6b7921e5f13f3d1956dcf7baff991e70
BLAKE2b-256 43bd801fe7a6daf535cf18e93220019ace09bf2f1ae296f9afd67116edb32708

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page