Skip to content

Commit 19c8f4d

Browse files
committed
Added note about plugin not being maintained and modified first section to give clarity, as earlier things seemed cluttered
1 parent ed12dca commit 19c8f4d

File tree

1 file changed

+45
-5
lines changed

1 file changed

+45
-5
lines changed

docs/operator-guide/grafana_plugin.md

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,52 @@
1-
# Grafana plugin
1+
---
2+
title: OpenObserve Grafana Plugin
3+
weight: 4450
4+
description: OpenObserve Plugin to be in Grafana
5+
---
6+
# OpenObserve Grafana Plugin
7+
8+
## What is Grafana?
9+
10+
Grafana is a popular open-source dashboarding and visualization platform. Originally designed for time series data, it has evolved into a comprehensive tool that can pull data from multiple sources and create unified dashboards for logs, metrics, and traces. It's widely used for monitoring and observability across organizations.
11+
12+
## Do You Need Grafana with OpenObserve?
13+
14+
**Short Answer: No, but you might want it.**
15+
16+
OpenObserve comes with a powerful built-in GUI that handles all your visualization needs, including:
17+
18+
- [Logs analysis and search](../features/logs.md)
19+
- [Metrics monitoring](../features/metrics.md)
20+
- [Distributed tracing](../features/distributed-tracing.md)
21+
- [Frontend monitoring](../features/frontend.md)
22+
- [Interactive dashboards](../user-guide/dashboards/dashboards-in-openobserve.md)
23+
- [Alerting and notifications](../user-guide/alerts/alerts.md)
24+
25+
**When to Use the Grafana Plugin:**
26+
27+
You should consider using OpenObserve's Grafana plugin if you:
28+
29+
1. **Already use Grafana** for other monitoring needs (e.g., Prometheus metrics)
30+
2. **Have existing Grafana dashboards** you want to keep
31+
3. **Need to consolidate** OpenObserve data with other data sources in a single Grafana instance
32+
33+
## What the Plugin Enables
34+
35+
With the OpenObserve Grafana plugin, you can:
36+
37+
- **Visualize OpenObserve data** directly in your existing Grafana dashboards
38+
- **Use Grafana Explore** to perform ad-hoc queries on logs and metrics from OpenObserve
39+
- **Combine OpenObserve data** with data from other sources in unified dashboards
40+
- **Use OpenObserve as a Prometheus data source** for metrics visualization
241

3-
Grafana is a dashboarding and graphing application, initially built for time series data, but has evolved into a tool that can pull data from multiple sources and visualize it in a single dashboard for logs and traces too. It is a popular tool for monitoring and observability.
42+
!!! warning "Plugin Maintenance Status"
43+
Please note that this Grafana plugin is not actively maintained or regularly updated. While it may work with current versions of Grafana and OpenObserve, compatibility and functionality are not guaranteed. We recommend testing thoroughly in your environment before deploying to production. For the most reliable experience, consider using OpenObserve's built-in visualization capabilities.
444

5-
You **`DO NOT`** need grafana for visualizing logs and metrics data from OpenObserve by maintaining one more app. OpenObserve has a very advanced GUI for that, which you can use for logs, metrics, traces, front end monitoring, dashboards and alerting. You could however use grafana if you are already using it for some of your needs e.g. monitoring metrics using prometheus and are comfortable using it and don't want to change. In this case you can use OpenObserve grafana plugin to visualize logs and metrics data from OpenObserve in your grafana dashboard. You can also use grafana explore tool to query adhoc logs and metrics data from OpenObserve. You could also use OpenObserve as a prometheus source in grafana and use grafana to visualize metrics data from OpenObserve.
45+
## Getting Started
646

7-
Below are the steps to install and configure the plugin. We will provide guide on how to set up grafana in a kubernetes environment. You can adapt these steps to set up grafana in a non-kubernetes environment.
47+
The following guide will walk you through installing and configuring the plugin in a Kubernetes environment. The steps can be adapted for non-Kubernetes deployments.
848

9-
If you are already familiar with grafana plugin installation, you can download the plugin from [here](https://zincsearch-releases.s3.us-west-2.amazonaws.com/zo_gp/zo_gp.tar.gz) and get started or follow the below steps.
49+
**Quick Start:** If you are already familiar with grafana plugin installation, you can download the plugin from [here](https://zincsearch-releases.s3.us-west-2.amazonaws.com/zo_gp/zo_gp.tar.gz) and get started. Feel free to skip the configuration section, you can directly jump [here](#using-grafana-plugin)
1050

1151
## Install Grafana
1252

0 commit comments

Comments
 (0)