Skip to content
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
72 changes: 61 additions & 11 deletions site/content/3.10/arangograph/monitoring-and-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down
72 changes: 61 additions & 11 deletions site/content/3.11/arangograph/monitoring-and-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down
72 changes: 61 additions & 11 deletions site/content/3.12/arangograph/monitoring-and-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/images/arangograph-monitoring-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.