Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added quick grafana doc #132

Merged
merged 1 commit into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/imgs/grafana.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/tutorials/observability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Integrating Observability with K8sGPT

Enhance your Kubernetes observability by integrating Prometheus and Grafana with K8sGPT. Follow these steps to set up and visualize your cluster's insights:
## Prerequisites
- Prometheus: Install using Helm via Prometheus Community Helm Charts.
- Grafana Dashboard: Ensure Grafana is installed and accessible in your environment.

# Installation Steps

Install the K8sGPT Operator with observability features enabled:
```
helm install release k8sgpt/k8sgpt-operator -n k8sgpt-operator-system --create-namespace --set interplex.enabled=true --set grafanaDashboard.enabled=true --set serviceMonitor.enabled=true
```
This command:
- Creates a ServiceMonitor to integrate with Prometheus.
- Automatically configures and populates data into your Grafana dashboard.

Once set up, you can explore key metrics like:
- Results identified by K8sGPT.
- Operator workload details, providing insight into resource usage and efficiency.


_See example of a K8sGPT Grafana dashboard_

![Generate a token on the OpenAI website](../imgs/grafana.png)
Loading