mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-09-11 10:46:25 +03:00
docs: pre-built observability dashboards for Hasura EE
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9524 Co-authored-by: Shahidh K Muhammed <4124733+shahidhk@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> GitOrigin-RevId: f1df3abefb7f31b311907fd95026be5a167c6011
This commit is contained in:
parent
37db1aa777
commit
0dea43add9
@ -34,6 +34,15 @@ import Observability from '@site/static/icons/features/observability.svg';
|
||||
</VersionedLink>
|
||||
.
|
||||
</p>
|
||||
<p>
|
||||
For our Enterprise customers, we have a set of pre-built dashboards and alerting rules configured with thew Prometheus Grafana Jaeger
|
||||
stack, with which you can monitor and debug Hasura. These dashboards will be available soon and integrated with Hasura Cloud
|
||||
too. You can read more and explore these dashboards
|
||||
<VersionedLink to="/observability/pre-built-dashboards/">
|
||||
here
|
||||
</VersionedLink>
|
||||
.
|
||||
</p>
|
||||
<h4>Quick Links</h4>
|
||||
<ul>
|
||||
<li>
|
||||
@ -42,6 +51,9 @@ import Observability from '@site/static/icons/features/observability.svg';
|
||||
<li>
|
||||
<VersionedLink to="/observability/how-it-works">Learn how Observability works.</VersionedLink>
|
||||
</li>
|
||||
<li>
|
||||
<VersionedLink to="/observability/pre-built-dashboards">Pre-built dashboards.</VersionedLink>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<iframe
|
||||
|
58
docs/docs/observability/pre-built-dashboards.mdx
Normal file
58
docs/docs/observability/pre-built-dashboards.mdx
Normal file
@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
sidebar_label: Pre-built Dashboards
|
||||
title: 'Pre-built Dashboards'
|
||||
description: Pre-built observability dashboards and alerting rules using Prometheus, Grafana, Alert Manager, Jeager
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
- enterprise
|
||||
- observability
|
||||
- metrics
|
||||
- alerts
|
||||
- dashboards
|
||||
- prometheus
|
||||
- grafana
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
import ProductBadge from '@site/src/components/ProductBadge';
|
||||
|
||||
# Pre-built Dashboards
|
||||
|
||||
<ProductBadge self />
|
||||
|
||||
## Introduction
|
||||
|
||||
If you're running Hasura EE yourself, you have metrics available over a Prometheus endpoint, Traces available over
|
||||
OpenTelemetry and Logs available over stdout. We have set up a
|
||||
[repository](https://github.com/hasura/ee-observability-demo) where we have configured Hasura along with:
|
||||
|
||||
- Prometheus for metrics collector.
|
||||
- Jaeger for Traces collector.
|
||||
- Alert Manager and regular alert rules.
|
||||
- Node Exporter for system metrics.
|
||||
- Blackbox Exporter for HTTP health checks.
|
||||
- Grafana with a few sample dashboards.
|
||||
- Loki and Promtail for logging collector.
|
||||
- Hasura migrations, metadata examples and enterprise enabled services (Caching, Read Replicas, Data Connectors).
|
||||
|
||||
<Thumbnail src="/img/observability/grafana-overview-dashboard.png" alt="Hasura Overview Dashboard" />
|
||||
|
||||
The repository helps you quickly start and explore the latest observability feature updates, dashboards, and alert
|
||||
templates for monitoring in production.
|
||||
|
||||
## Get Started
|
||||
|
||||
Clone the repository to your local machine, copy the sample environment file `dotenv` to `.env`, and edit the enterprise
|
||||
license key (`HGE_EE_LICENSE_KEY`) and secrets. The demo uses [Docker Compose](https://docs.docker.com/compose/) to
|
||||
setup container services.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/hasura/ee-observability-demo.git
|
||||
cd ee-observability-demo
|
||||
cp dotenv .env
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Explore Grafana Dashboards on `http://localhost:3000`.
|
BIN
docs/static/img/observability/grafana-overview-dashboard.png
vendored
Normal file
BIN
docs/static/img/observability/grafana-overview-dashboard.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 130 KiB |
Loading…
Reference in New Issue
Block a user