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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cdk8s-grafana-0.1.599.tar.gz
Algorithm Hash digest
SHA256 0cc2be6bce1f4898522430395baa3f14fdc3ba6529b3d9baff11103233c5977a
MD5 272852b2491d4ac1e8253f298b99db0d
BLAKE2b-256 9dc727e07bef5741e4f100fe85d218732acaa489a5403de0e0e30cfc357e79ba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdk8s_grafana-0.1.599-py3-none-any.whl
Algorithm Hash digest
SHA256 a1feb3cb4218c6f51f1fdc210811e39e128e5bd7d6694b4e58454020cc9b7ee0
MD5 be7a2e0880d8896ee93353ae3fb9c45c
BLAKE2b-256 c0df5f136d67c04c8c4866ef786db3f402cb359093c5ba1b09af94a59a5c38ef

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