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.621.tar.gz (326.3 kB view details)

Uploaded Source

Built Distribution

cdk8s_grafana-0.1.621-py3-none-any.whl (324.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cdk8s-grafana-0.1.621.tar.gz
Algorithm Hash digest
SHA256 ccd039bdab8ad917267cc41b37f10a891dbf1ede90a7876bcf92474482719369
MD5 cc346969bf2e375c53024bb005964835
BLAKE2b-256 231104be009e79abd4c1936b56947c09ae1e0ec003d532472d505d11c975bdf4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdk8s_grafana-0.1.621-py3-none-any.whl
Algorithm Hash digest
SHA256 3c7a8ee0f1c4db6558608f201e10665f9e36c87cb600034e9b948ebd0b164b78
MD5 1596c688054e3a505af34720d5ddab12
BLAKE2b-256 223587c0f1dd80c70c80527e156eeb8a9612dda577bd5575882d9675de6646b6

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