Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openebs/monitoring

OpenEBS Monitoring add-on. A set of Grafana, Prometheus, and alert manager plugins.
https://github.com/openebs/monitoring

grafana-dashboard grafana-prometheus hacktoberfest jsonnet-mixins prometheus-monitoring-solution

Last synced: 5 days ago
JSON representation

OpenEBS Monitoring add-on. A set of Grafana, Prometheus, and alert manager plugins.

Host: GitHub
URL: https://github.com/openebs/monitoring
Owner: openebs
License: apache-2.0
Created: 2021-04-27T06:18:03.000Z (over 3 years ago)
Default Branch: develop
Last Pushed: 2024-11-06T06:05:51.000Z (8 days ago)
Last Synced: 2024-11-06T07:18:11.989Z (8 days ago)
Topics: grafana-dashboard, grafana-prometheus, hacktoberfest, jsonnet-mixins, prometheus-monitoring-solution
Language: Jsonnet
Homepage:
Size: 848 KB
Stars: 32
Watchers: 18
Forks: 20
Open Issues: 12
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Governance: GOVERNANCE.md

Awesome Lists containing this project

README

        # OpenEBS Monitoring add-on

[![Slack](https://img.shields.io/badge/chat-slack-ff1493.svg?style=flat-square)](https://kubernetes.slack.com/messages/openebs)

[![Community Meetings](https://img.shields.io/badge/Community-Meetings-blue)](https://us05web.zoom.us/j/87535654586?pwd=CigbXigJPn38USc6Vuzt7qSVFoO79X.1)

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9664/badge)](https://www.bestpractices.dev/projects/9664)

[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fmonitoring.svg?type=shield&issueType=license)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fmonitoring?ref=badge_shield&issueType=license)

A set of Grafana dashboards and Prometheus alerts for OpenEBS that can be installed as a [helm chart](./deploy/charts/) or imported as [jsonnet mixin](./jsonnet/).

## Status

**Beta**. This repository currently supports dashboards and alerts for `Mayastor`, `LocalPV LVM`, `LocalPV ZFS` OpenEBS storage engines.

This project is under active development and seeking [contributions from the community](#contributing).

## Install

### Using helm

Setup the monitoring helm repository.

```console

helm repo add monitoring https://openebs.github.io/monitoring/

helm repo update

```

You can then run `helm search repo monitoring` to see the charts.

Install the helm chart. 

```

helm install monitoring monitoring/monitoring --namespace openebs --create-namespace

```

The detailed chart documentation is available in [charts directory](/deploy/charts/README.md).

### Using kubectl

You can generate YAMLs and install using kubectl. See detailed steps at [./jsonnet](/jsonnet/README.md).

## Usage

### Accessing Grafana

```console

# Look at the Grafana pod and check that the pod is in running state

kubectl get pods -n [NAMESPACE] | grep -i grafana

# Note the public IP of any one of the nodes

kubectl get nodes -o wide

# Note the Grafana Service IP

kubectl get svc -n [NAMESPACE] | grep -i grafana

# Open browser and visit http://: 

#  (where  is the public IP address of your node, and  is Grafana Service Port)

#  Default Grafana login credentials- [username: admin, password: admin]

```

**NOTE:** If public IP is not available then you can access it via port-forwarding

```console

# Perform port-forwarding

# kubectl port-forward --namespace [NAMESPACE] pods/[grafana-pod-name] [grafrana-foward-port]:[grafana-cluster-port]

# Open browser and visit http://127.0.0.1:[grafana-forward-port]

# Default Grafana login credentials- [username: admin, password: admin]

```

## Contributing

OpenEBS welcomes your feedback and contributions in any form possible.

- Want to raise an issue or help with fixes and features?

    - See [open issues](https://github.com/openebs/monitoring/issues)

    - See [Project Roadmap](https://github.com/orgs/openebs/projects/41)

- See [contributing guide](./CONTRIBUTING.md)

## Community

- [Join OpenEBS community on Kubernetes Slack](https://kubernetes.slack.com)

  - Already signed up? Head to our discussions at [#openebs](https://kubernetes.slack.com/messages/openebs/)

  - Want to join our contributor community meetings, [check this out](https://github.com/openebs/openebs/blob/HEAD/community/README.md).

- Join our OpenEBS CNCF Mailing lists

  - For OpenEBS project updates, subscribe to [OpenEBS Announcements](https://lists.cncf.io/g/cncf-openebs-announcements)

  - For interacting with other OpenEBS users, subscribe to [OpenEBS Users](https://lists.cncf.io/g/cncf-openebs-users)

## Code of conduct

Participation in the OpenEBS community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/HEAD/code-of-conduct.md).

## License Compliance

[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fmonitoring.svg?type=large&issueType=license)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fmonitoring?ref=badge_large&issueType=license)