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

Uploaded Source

Built Distribution

cdk8s_grafana-0.1.469-py3-none-any.whl (324.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cdk8s-grafana-0.1.469.tar.gz
Algorithm Hash digest
SHA256 63e490bd102732b532ac3662f70735d7205d91b2788615d60ead6e05f65023a8
MD5 d10babc860c22feb8bce0caaf6c1471e
BLAKE2b-256 d069b5d33a0b1684b30f76232796414ebdcf86946ccc66e3fcb4473d6d237684

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdk8s_grafana-0.1.469-py3-none-any.whl
Algorithm Hash digest
SHA256 e9d905696950eab89de8152cfbcb512fda4df7368af08b862f17aa3c3aa8ddd7
MD5 598b5ef0c1d61e577f5e88234ef251d3
BLAKE2b-256 61a7a6ee8ed79ddc00e1904c201471c160a1cc0bec170cfb055a9bebf1ea65bc

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