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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cdk8s-grafana-0.1.425.tar.gz
Algorithm Hash digest
SHA256 975df5c8e644b9e8e24e345d584e7eea0d372e19d784d081cc5a6da1206a076f
MD5 cf67a4e1850bd07eebac11c7db474e92
BLAKE2b-256 f95d45361291327e13412dbf9dcf2157fa2653a4b38710c99ea64b531bef2055

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdk8s_grafana-0.1.425-py3-none-any.whl
Algorithm Hash digest
SHA256 067b4f973af71be0cbe2ce8ddd95de5b46fbdce004b930e4bfb7073cd14ffe47
MD5 a889eb527d05570122bed99e7e3eea12
BLAKE2b-256 468a42bae58c59267a7618b7c004ed5a58dc5fb6948c449d8541426556735b80

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