diff --git a/.gitbook.yaml b/.gitbook.yaml index 07df570f3..9d9f03784 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -402,7 +402,7 @@ redirects: modules-1/observability/logs/tutorials/set-up-logs-with-aidbox-project: modules/observability/logs/tutorials/set-up-logs-with-aidbox-project.md modules-1/observability/metrics/monitoring/aidbox-metrics-server: modules/observability/metrics/monitoring/use-aidbox-metrics-server.md modules-1/observability/metrics/monitoring/how-to-export-metrics-to-the-otel-collector: modules/observability/metrics/monitoring/how-to-export-metrics-to-the-otel-collector.md - modules-1/observability/metrics/monitoring/set-up-grafana-integration: modules/observability/metrics/monitoring/set-up-grafana-integration.md + modules-1/observability/metrics/monitoring/set-up-grafana-integration: deprecated/deprecated/other/monitoring/set-up-grafana-integration.md modules-1/observability/metrics/monitoring/use-aidbox-metrics-server: modules/observability/metrics/monitoring/use-aidbox-metrics-server.md modules-1/observability/metrics/technical-reference/opentelemetry-metrics: modules/observability/metrics/technical-reference/opentelemetry-metrics.md modules-1/observability/metrics/technical-reference/otel-metrics-exporter-parameters: modules/observability/metrics/technical-reference/otel-metrics-exporter-parameters.md diff --git a/docs/.gitbook/assets/AidBoxMetricsDashboard.png b/docs/.gitbook/assets/AidBoxMetricsDashboard.png new file mode 100644 index 000000000..d8c74a6e7 Binary files /dev/null and b/docs/.gitbook/assets/AidBoxMetricsDashboard.png differ diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index f58acb77b..924742995 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -305,7 +305,7 @@ * [How-to guides](modules/observability/metrics/monitoring/README.md) * [How to export metrics to the OTEL collector](modules/observability/metrics/monitoring/how-to-export-metrics-to-the-otel-collector.md) * [Use Aidbox Metrics Server](modules/observability/metrics/monitoring/use-aidbox-metrics-server.md) - * [Set-up Grafana integration](modules/observability/metrics/monitoring/set-up-grafana-integration.md) + * [Set-up Grafana integration (deprecated)](deprecated/deprecated/other/monitoring/set-up-grafana-integration.md) * [Technical reference](modules/observability/metrics/technical-reference/README.md) * [OpenTelemetry Metrics](modules/observability/metrics/technical-reference/opentelemetry-metrics.md) * [OTEL metrics exporter parameters](modules/observability/metrics/technical-reference/otel-metrics-exporter-parameters.md) diff --git a/docs/deployment-and-maintenance/deploy-aidbox/run-aidbox-in-kubernetes/deploy-production-ready-aidbox-to-kubernetes.md b/docs/deployment-and-maintenance/deploy-aidbox/run-aidbox-in-kubernetes/deploy-production-ready-aidbox-to-kubernetes.md index 822d58283..36ee6696a 100644 --- a/docs/deployment-and-maintenance/deploy-aidbox/run-aidbox-in-kubernetes/deploy-production-ready-aidbox-to-kubernetes.md +++ b/docs/deployment-and-maintenance/deploy-aidbox/run-aidbox-in-kubernetes/deploy-production-ready-aidbox-to-kubernetes.md @@ -518,10 +518,6 @@ scrape_configs: * [Thanos](https://thanos.io/) — highly available Prometheus setup with long-term storage capabilities. * [Grafana Mimir](https://grafana.com/oss/mimir/) — highly available, multi-tenant, long-term storage for Prometheus. -### Export the Aidbox Grafana dashboard - -Aidbox metrics has integration with Grafana, which can generate dashboards and upload them to Grafana — [Grafana Integration](../../../modules/observability/metrics/monitoring/set-up-grafana-integration.md) - ### Additional monitoring System monitoring: diff --git a/docs/modules/observability/metrics/monitoring/set-up-grafana-integration.md b/docs/deprecated/deprecated/other/monitoring/set-up-grafana-integration.md similarity index 96% rename from docs/modules/observability/metrics/monitoring/set-up-grafana-integration.md rename to docs/deprecated/deprecated/other/monitoring/set-up-grafana-integration.md index 43161f27c..ab116ee45 100644 --- a/docs/modules/observability/metrics/monitoring/set-up-grafana-integration.md +++ b/docs/deprecated/deprecated/other/monitoring/set-up-grafana-integration.md @@ -4,7 +4,11 @@ description: >- upload them to Grafana --- -# Set-up Grafana integration +# Set-up Grafana integration (deprecated) + +{% hint style="warning" %} +Grafana integration is deprecated since 2601. +{% endhint %} Before setting up Grafana integration, ensure you have set up the Aidbox Metrics Server. Check the guide below on how to do it. diff --git a/docs/modules/observability/getting-started/run-aidbox-with-opentelemetry-locally.md b/docs/modules/observability/getting-started/run-aidbox-with-opentelemetry-locally.md index 2ea20a293..34a5234a4 100644 --- a/docs/modules/observability/getting-started/run-aidbox-with-opentelemetry-locally.md +++ b/docs/modules/observability/getting-started/run-aidbox-with-opentelemetry-locally.md @@ -66,13 +66,9 @@ Then go to [Discover](http://localhost:5602/app/discover) page (Menu → Discove ### 4. Discover Aidbox metrics with Grafana -Grafana should be available on [http://localhost:3001](http://localhost:3001) address, login with `admin`/`password` credentials. +To visualize Aidbox metrics, import the [Aidbox Metrics Dashboard](https://grafana.com/grafana/dashboards/$id) from Grafana Dashboards. Navigate to `Dashboards` and click `New` -> `Import`. Enter the dashboard ID `$id` and click `Load`. Then select the Prometheus data source and click `Import`. -
Grafana login page

Grafana LogIn

- -Navigate to `Dashboards->Aidbox Dashboards->Aidbox Dashboard` to see the dashboard. You probably need to wait for a while until the data is collected. - -
Grafana dashboard showing Aidbox metrics and performance data

Grafana Dashboard

+
Grafana dashboard showing Aidbox metrics and performance data

Aidbox Metrics Dashboard

### 5. Discover Aidbox traces with Zipkin diff --git a/docs/reference/all-settings.md b/docs/reference/all-settings.md index 4d9024109..f904b7c4e 100644 --- a/docs/reference/all-settings.md +++ b/docs/reference/all-settings.md @@ -2166,6 +2166,10 @@ Custom index format string. The default value is 'aidbox-logs'-yyyy-MM-dd. ### Grafana +{% hint style="warning" %} +Grafana integration is deprecated since 2601. +{% endhint %} + Grafana settings #### Grafana URL for metrics dashboards @@ -2611,4 +2615,4 @@ BOX_ZEN_PROJECT_FTR_PULL_SYNC: false Block Aidbox start until FTR index is loaded into Aidbox DB. -
Details
IDzen-project.ftr.pull.sync
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_FTR_PULL_SYNC
Deprecated environment variablesBOX_FEATURES_FTR_PULL_SYNC
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart
\ No newline at end of file +
Details
IDzen-project.ftr.pull.sync
TypeBool
Default valuefalse
Environment variableBOX_ZEN_PROJECT_FTR_PULL_SYNC
Deprecated environment variablesBOX_FEATURES_FTR_PULL_SYNC
Sensitivefalse — value will be visible in plaintext in Admin UI
Set viaAdmin UI → Settings
Environment variables
Hot reloadfalse — setting requires system restart