@@ -3,25 +3,75 @@ title: Monitoring & Metrics in ArangoGraph
33menuTitle : Monitoring & Metrics
44weight : 40
55description : >-
6- How to use metrics in ArangoGraph
6+ ArangoGraph provides various built-in tools and integrations to help you
7+ monitor your deployment
78archetype : default
89---
9- The ArangoGraph Insights Platform provides metrics for each deployment in a
10- [ Prometheus] ( https://prometheus.io/ )
11- compatible format.
12- You can use these metrics to gather detailed insights into the current
13- and previous states of your deployment.
14- Once metrics are collected by Prometheus, you can inspect them using tools
15- such as [ Grafana] ( https://grafana.com/oss/grafana/ ) .
10+ The ArangoGraph Insights Platform provides integrated charts, metrics, and logs
11+ to help you monitor your deployment. This allows you to track your deployment's
12+ performance, resource utilization, and its overall status.
13+
14+ The key features include:
15+ - ** Built-in monitoring** : Get immediate access to monitoring capabilities for
16+ your deployments without any additional setup.
17+ - ** Chart-based metrics representation** : Visualize the usage of the DB-Servers
18+ and Coordinators over a selected timeframe.
19+ - ** Integration with Prometheus and Grafana** : Connect your metrics to Prometheus
20+ and Grafana for in-depth visualization and analysis.
1621
1722To get started, select an existing deployment from within a project and
1823click ** Monitoring** in the navigation.
1924
2025![ ArangoGraph Monitoring tab] ( ../../images/arangograph-monitoring-tab.png )
2126
27+ ## Built-in monitoring and metrics
28+
29+ ### In the ** Servers** section
30+
31+ The ** Servers** section offers an overview of the DB-Servers, Coordinators,
32+ and Agents used in your deployment. It provides essential details such as each
33+ server's ID and type, the running ArangoDB version, as well as their memory,
34+ CPU, and disk usage.
35+
36+ In case you need to perform a restart on a server, you can do so by using the
37+ ** Gracefully restart this server** action button. This shuts down all services
38+ normally, allowing ongoing operations to finish gracefully before the restart
39+ occurs.
40+
41+ Additionally, you can access detailed logs via the ** Logs** button. This allows
42+ you to apply filters to obtain logs from all server types or select specific ones
43+ (i.e. only Coordinators or only DB-Servers) within a timeframe. To download the
44+ logs, click the ** Save** button.
45+
46+ ![ ArangoGraph Monitoring Servers] ( ../../images/arangograph-monitoring-servers.png )
47+
48+ ### In the ** Metrics** section
49+
50+ The ** Metrics** section displays a chart-based representation depicting the
51+ resource utilization of DB-Servers and Coordinators within a specified timeframe.
52+
53+ You can select one or more DB-Servers and choose ** CPU** , ** Memory** , or ** Disk**
54+ to visualize their respective usage. The search box enables you to easily find
55+ a server by its ID, particularly useful when having a large number of servers
56+ or when needing to quickly find a particular one among many.
57+
58+ Similarly, you can repeat the process for Coordinators to see the ** CPU** and
59+ ** Memory** usage.
60+
61+ ![ Arangograph Monitoring Metrics Chart] ( ../../images/arangograph-monitoring-metrics-chart.png )
62+
63+ ## Connect with Prometheus and Grafana
64+
65+ The ArangoGraph Insights Platform provides metrics for each deployment in a
66+ [ Prometheus] ( https://prometheus.io/ ) -compatible format.
67+ You can use these metrics to gather detailed insights into the current
68+ and previous states of your deployment.
69+ Once metrics are collected by Prometheus, you can inspect them using tools
70+ such as [ Grafana] ( https://grafana.com/oss/grafana/ ) .
71+
2272![ ArangoGraph Connect Metrics Section] ( ../../images/arangograph-connect-metrics-section.png )
2373
24- ## Metrics tokens
74+ ### Metrics tokens
2575
2676The ** Metrics tokens** section allows you to create a new metrics token,
2777which is required for connecting to Prometheus.
@@ -34,7 +84,7 @@ which is required for connecting to Prometheus.
3484
3585![ ArangoGraph Metrics Tokens] ( ../../images/arangograph-metrics-token.png )
3686
37- ## How to connect Prometheus
87+ ### How to connect Prometheus
3888
39891 . In the ** Metrics** section, click ** Connect Prometheus** .
40902 . Create the ` prometheus.yml ` file with the following content:
@@ -62,7 +112,7 @@ which is required for connecting to Prometheus.
62112 this is not needed and not recommended to have it open.
63113 {{< /info >}}
64114
65- ## How to connect Grafana
115+ ### How to connect Grafana
66116
671171 . Start Grafana with the following command:
68118 ``` sh
0 commit comments