diff --git a/site/content/3.10/arangograph/monitoring-and-metrics.md b/site/content/3.10/arangograph/monitoring-and-metrics.md index c9c77bc52a..c4f9135444 100644 --- a/site/content/3.10/arangograph/monitoring-and-metrics.md +++ b/site/content/3.10/arangograph/monitoring-and-metrics.md @@ -3,25 +3,75 @@ title: Monitoring & Metrics in ArangoGraph menuTitle: Monitoring & Metrics weight: 40 description: >- - How to use metrics in ArangoGraph + ArangoGraph provides various built-in tools and integrations to help you + monitor your deployment archetype: default --- -The ArangoGraph Insights Platform provides metrics for each deployment in a -[Prometheus](https://prometheus.io/) -compatible format. -You can use these metrics to gather detailed insights into the current -and previous states of your deployment. -Once metrics are collected by Prometheus, you can inspect them using tools -such as [Grafana](https://grafana.com/oss/grafana/). +The ArangoGraph Insights Platform provides integrated charts, metrics, and logs +to help you monitor your deployment. This allows you to track your deployment's +performance, resource utilization, and its overall status. + +The key features include: +- **Built-in monitoring**: Get immediate access to monitoring capabilities for + your deployments without any additional setup. +- **Chart-based metrics representation**: Visualize the usage of the DB-Servers + and Coordinators over a selected timeframe. +- **Integration with Prometheus and Grafana**: Connect your metrics to Prometheus + and Grafana for in-depth visualization and analysis. To get started, select an existing deployment from within a project and click **Monitoring** in the navigation. ![ArangoGraph Monitoring tab](../../images/arangograph-monitoring-tab.png) +## Built-in monitoring and metrics + +### In the **Servers** section + +The **Servers** section offers an overview of the DB-Servers, Coordinators, +and Agents used in your deployment. It provides essential details such as each +server's ID and type, the running ArangoDB version, as well as their memory, +CPU, and disk usage. + +In case you need to perform a restart on a server, you can do so by using the +**Gracefully restart this server** action button. This shuts down all services +normally, allowing ongoing operations to finish gracefully before the restart +occurs. + +Additionally, you can access detailed logs via the **Logs** button. This allows +you to apply filters to obtain logs from all server types or select specific ones +(i.e. only Coordinators or only DB-Servers) within a timeframe. To download the +logs, click the **Save** button. + +![ArangoGraph Monitoring Servers](../../images/arangograph-monitoring-servers.png) + +### In the **Metrics** section + +The **Metrics** section displays a chart-based representation depicting the +resource utilization of DB-Servers and Coordinators within a specified timeframe. + +You can select one or more DB-Servers and choose **CPU**, **Memory**, or **Disk** +to visualize their respective usage. The search box enables you to easily find +a server by its ID, particularly useful when having a large number of servers +or when needing to quickly find a particular one among many. + +Similarly, you can repeat the process for Coordinators to see the **CPU** and +**Memory** usage. + +![Arangograph Monitoring Metrics Chart](../../images/arangograph-monitoring-metrics-chart.png) + +## Connect with Prometheus and Grafana + +The ArangoGraph Insights Platform provides metrics for each deployment in a +[Prometheus](https://prometheus.io/)-compatible format. +You can use these metrics to gather detailed insights into the current +and previous states of your deployment. +Once metrics are collected by Prometheus, you can inspect them using tools +such as [Grafana](https://grafana.com/oss/grafana/). + ![ArangoGraph Connect Metrics Section](../../images/arangograph-connect-metrics-section.png) -## Metrics tokens +### Metrics tokens The **Metrics tokens** section allows you to create a new metrics token, which is required for connecting to Prometheus. @@ -34,7 +84,7 @@ which is required for connecting to Prometheus. ![ArangoGraph Metrics Tokens](../../images/arangograph-metrics-token.png) -## How to connect Prometheus +### How to connect Prometheus 1. In the **Metrics** section, click **Connect Prometheus**. 2. Create the `prometheus.yml` file with the following content: @@ -62,7 +112,7 @@ which is required for connecting to Prometheus. this is not needed and not recommended to have it open. {{< /info >}} -## How to connect Grafana +### How to connect Grafana 1. Start Grafana with the following command: ```sh diff --git a/site/content/3.11/arangograph/monitoring-and-metrics.md b/site/content/3.11/arangograph/monitoring-and-metrics.md index c9c77bc52a..c4f9135444 100644 --- a/site/content/3.11/arangograph/monitoring-and-metrics.md +++ b/site/content/3.11/arangograph/monitoring-and-metrics.md @@ -3,25 +3,75 @@ title: Monitoring & Metrics in ArangoGraph menuTitle: Monitoring & Metrics weight: 40 description: >- - How to use metrics in ArangoGraph + ArangoGraph provides various built-in tools and integrations to help you + monitor your deployment archetype: default --- -The ArangoGraph Insights Platform provides metrics for each deployment in a -[Prometheus](https://prometheus.io/) -compatible format. -You can use these metrics to gather detailed insights into the current -and previous states of your deployment. -Once metrics are collected by Prometheus, you can inspect them using tools -such as [Grafana](https://grafana.com/oss/grafana/). +The ArangoGraph Insights Platform provides integrated charts, metrics, and logs +to help you monitor your deployment. This allows you to track your deployment's +performance, resource utilization, and its overall status. + +The key features include: +- **Built-in monitoring**: Get immediate access to monitoring capabilities for + your deployments without any additional setup. +- **Chart-based metrics representation**: Visualize the usage of the DB-Servers + and Coordinators over a selected timeframe. +- **Integration with Prometheus and Grafana**: Connect your metrics to Prometheus + and Grafana for in-depth visualization and analysis. To get started, select an existing deployment from within a project and click **Monitoring** in the navigation. ![ArangoGraph Monitoring tab](../../images/arangograph-monitoring-tab.png) +## Built-in monitoring and metrics + +### In the **Servers** section + +The **Servers** section offers an overview of the DB-Servers, Coordinators, +and Agents used in your deployment. It provides essential details such as each +server's ID and type, the running ArangoDB version, as well as their memory, +CPU, and disk usage. + +In case you need to perform a restart on a server, you can do so by using the +**Gracefully restart this server** action button. This shuts down all services +normally, allowing ongoing operations to finish gracefully before the restart +occurs. + +Additionally, you can access detailed logs via the **Logs** button. This allows +you to apply filters to obtain logs from all server types or select specific ones +(i.e. only Coordinators or only DB-Servers) within a timeframe. To download the +logs, click the **Save** button. + +![ArangoGraph Monitoring Servers](../../images/arangograph-monitoring-servers.png) + +### In the **Metrics** section + +The **Metrics** section displays a chart-based representation depicting the +resource utilization of DB-Servers and Coordinators within a specified timeframe. + +You can select one or more DB-Servers and choose **CPU**, **Memory**, or **Disk** +to visualize their respective usage. The search box enables you to easily find +a server by its ID, particularly useful when having a large number of servers +or when needing to quickly find a particular one among many. + +Similarly, you can repeat the process for Coordinators to see the **CPU** and +**Memory** usage. + +![Arangograph Monitoring Metrics Chart](../../images/arangograph-monitoring-metrics-chart.png) + +## Connect with Prometheus and Grafana + +The ArangoGraph Insights Platform provides metrics for each deployment in a +[Prometheus](https://prometheus.io/)-compatible format. +You can use these metrics to gather detailed insights into the current +and previous states of your deployment. +Once metrics are collected by Prometheus, you can inspect them using tools +such as [Grafana](https://grafana.com/oss/grafana/). + ![ArangoGraph Connect Metrics Section](../../images/arangograph-connect-metrics-section.png) -## Metrics tokens +### Metrics tokens The **Metrics tokens** section allows you to create a new metrics token, which is required for connecting to Prometheus. @@ -34,7 +84,7 @@ which is required for connecting to Prometheus. ![ArangoGraph Metrics Tokens](../../images/arangograph-metrics-token.png) -## How to connect Prometheus +### How to connect Prometheus 1. In the **Metrics** section, click **Connect Prometheus**. 2. Create the `prometheus.yml` file with the following content: @@ -62,7 +112,7 @@ which is required for connecting to Prometheus. this is not needed and not recommended to have it open. {{< /info >}} -## How to connect Grafana +### How to connect Grafana 1. Start Grafana with the following command: ```sh diff --git a/site/content/3.12/arangograph/monitoring-and-metrics.md b/site/content/3.12/arangograph/monitoring-and-metrics.md index c9c77bc52a..c4f9135444 100644 --- a/site/content/3.12/arangograph/monitoring-and-metrics.md +++ b/site/content/3.12/arangograph/monitoring-and-metrics.md @@ -3,25 +3,75 @@ title: Monitoring & Metrics in ArangoGraph menuTitle: Monitoring & Metrics weight: 40 description: >- - How to use metrics in ArangoGraph + ArangoGraph provides various built-in tools and integrations to help you + monitor your deployment archetype: default --- -The ArangoGraph Insights Platform provides metrics for each deployment in a -[Prometheus](https://prometheus.io/) -compatible format. -You can use these metrics to gather detailed insights into the current -and previous states of your deployment. -Once metrics are collected by Prometheus, you can inspect them using tools -such as [Grafana](https://grafana.com/oss/grafana/). +The ArangoGraph Insights Platform provides integrated charts, metrics, and logs +to help you monitor your deployment. This allows you to track your deployment's +performance, resource utilization, and its overall status. + +The key features include: +- **Built-in monitoring**: Get immediate access to monitoring capabilities for + your deployments without any additional setup. +- **Chart-based metrics representation**: Visualize the usage of the DB-Servers + and Coordinators over a selected timeframe. +- **Integration with Prometheus and Grafana**: Connect your metrics to Prometheus + and Grafana for in-depth visualization and analysis. To get started, select an existing deployment from within a project and click **Monitoring** in the navigation. ![ArangoGraph Monitoring tab](../../images/arangograph-monitoring-tab.png) +## Built-in monitoring and metrics + +### In the **Servers** section + +The **Servers** section offers an overview of the DB-Servers, Coordinators, +and Agents used in your deployment. It provides essential details such as each +server's ID and type, the running ArangoDB version, as well as their memory, +CPU, and disk usage. + +In case you need to perform a restart on a server, you can do so by using the +**Gracefully restart this server** action button. This shuts down all services +normally, allowing ongoing operations to finish gracefully before the restart +occurs. + +Additionally, you can access detailed logs via the **Logs** button. This allows +you to apply filters to obtain logs from all server types or select specific ones +(i.e. only Coordinators or only DB-Servers) within a timeframe. To download the +logs, click the **Save** button. + +![ArangoGraph Monitoring Servers](../../images/arangograph-monitoring-servers.png) + +### In the **Metrics** section + +The **Metrics** section displays a chart-based representation depicting the +resource utilization of DB-Servers and Coordinators within a specified timeframe. + +You can select one or more DB-Servers and choose **CPU**, **Memory**, or **Disk** +to visualize their respective usage. The search box enables you to easily find +a server by its ID, particularly useful when having a large number of servers +or when needing to quickly find a particular one among many. + +Similarly, you can repeat the process for Coordinators to see the **CPU** and +**Memory** usage. + +![Arangograph Monitoring Metrics Chart](../../images/arangograph-monitoring-metrics-chart.png) + +## Connect with Prometheus and Grafana + +The ArangoGraph Insights Platform provides metrics for each deployment in a +[Prometheus](https://prometheus.io/)-compatible format. +You can use these metrics to gather detailed insights into the current +and previous states of your deployment. +Once metrics are collected by Prometheus, you can inspect them using tools +such as [Grafana](https://grafana.com/oss/grafana/). + ![ArangoGraph Connect Metrics Section](../../images/arangograph-connect-metrics-section.png) -## Metrics tokens +### Metrics tokens The **Metrics tokens** section allows you to create a new metrics token, which is required for connecting to Prometheus. @@ -34,7 +84,7 @@ which is required for connecting to Prometheus. ![ArangoGraph Metrics Tokens](../../images/arangograph-metrics-token.png) -## How to connect Prometheus +### How to connect Prometheus 1. In the **Metrics** section, click **Connect Prometheus**. 2. Create the `prometheus.yml` file with the following content: @@ -62,7 +112,7 @@ which is required for connecting to Prometheus. this is not needed and not recommended to have it open. {{< /info >}} -## How to connect Grafana +### How to connect Grafana 1. Start Grafana with the following command: ```sh diff --git a/site/content/images/arangograph-monitoring-metrics-chart.png b/site/content/images/arangograph-monitoring-metrics-chart.png new file mode 100644 index 0000000000..cc79d0a33e Binary files /dev/null and b/site/content/images/arangograph-monitoring-metrics-chart.png differ diff --git a/site/content/images/arangograph-monitoring-servers.png b/site/content/images/arangograph-monitoring-servers.png new file mode 100644 index 0000000000..8ab2e2c8f3 Binary files /dev/null and b/site/content/images/arangograph-monitoring-servers.png differ diff --git a/site/content/images/arangograph-monitoring-tab.png b/site/content/images/arangograph-monitoring-tab.png index 6a4eb0912e..5217078846 100644 Binary files a/site/content/images/arangograph-monitoring-tab.png and b/site/content/images/arangograph-monitoring-tab.png differ