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

Uploaded Source

Built Distribution

cdk8s_grafana-0.1.403-py3-none-any.whl (326.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cdk8s-grafana-0.1.403.tar.gz
  • Upload date:
  • Size: 328.1 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.403.tar.gz
Algorithm Hash digest
SHA256 4321cb7abcb4e05501f4f500ae515cf11935b765742ceaa4fa8fdb5d2f57d5cd
MD5 57458fea243e2e968e1e64cc429c447a
BLAKE2b-256 137b5a7ddb7e26c31aa3503c8a2b3c4cba9dd2d096633243ba5f9951975e3af6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdk8s_grafana-0.1.403-py3-none-any.whl
Algorithm Hash digest
SHA256 3e01fa8d9952187fec34eb3bb80b5b3bca948192c9660c32d5e0824dfe5b3c77
MD5 24534976c0c3467b68a6ca78d4282c3b
BLAKE2b-256 53058e44353fa61608bdf0d5920430c1c372197664bda52de8c58c3c42e8fe6f

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