Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit f10a35c

Browse files
nerpaulaansoboleva
andauthored
DOC-153/oasis-metrics (#1079)
* generated output of oasisctl * described monitoring and metrics * fix typos * Update monitoring-metrics.md * Update monitoring-metrics.md Co-authored-by: ansoboleva <93702078+ansoboleva@users.noreply.github.com>
1 parent 50311a7 commit f10a35c

15 files changed

+257
-0
lines changed

_data/oasis.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
href: deployments.html
1616
- text: My Account
1717
href: my-account.html
18+
- text: Monitoring & Metrics
19+
href: monitoring-metrics.html
1820
- text: Security and Access Control
1921
href: access-control.html
2022
- text: Backups
@@ -163,6 +165,16 @@
163165
href: oasisctl-delete-project.html
164166
- text: Delete Role
165167
href: oasisctl-delete-role.html
168+
- text: Disable
169+
href: oasisctl-disable.html
170+
children:
171+
- text: Disable Scheduled Root Password Rotation
172+
href: oasisctl-disable-scheduled-root-password-rotation.html
173+
- text: Enable
174+
href: oasisctl-enable.html
175+
children:
176+
- text: Enable Scheduled Root Password Rotation
177+
href: oasisctl-enable-scheduled-root-password-rotation.html
166178
- text: Generate Docs
167179
href: oasisctl-generate-docs.html
168180
- text: Get
479 KB
Loading
291 KB
Loading
740 KB
Loading

oasis/monitoring-metrics.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
layout: default
3+
description: How to use metrics
4+
title: Monitoring in ArangoDB Oasis
5+
---
6+
# Monitoring & Metrics
7+
8+
ArangoDB Oasis provides metrics for each deployment in a
9+
[Prometheus](https://prometheus.io/){:target="_blank"}
10+
compatible format.
11+
You can use these metrics to gather detailed insights into the current
12+
and previous states of your deployment.
13+
Once metrics are collected by Prometheus, you can inspect them using tools
14+
such as [Grafana](https://grafana.com/oss/grafana/){:target="_blank"}.
15+
16+
To get started, select an existing deployment from within a project and
17+
open the **Monitoring** tab.
18+
19+
![Oasis Monitoring tab](images/oasis-monitoring-tab.png)
20+
21+
![Oasis Connect Metrics Section](images/oasis-connect-metrics-section.png)
22+
23+
## Metrics tokens
24+
25+
The **Metrics tokens** section allows you to create a new metrics token,
26+
which is required for connecting to Prometheus.
27+
28+
1. To create a metrics token, click **New metrics token**.
29+
2. For **Name**, enter a name for the metrics token.
30+
3. Optionally, you can also enter a **Short description**.
31+
4. Select the **Lifetime** of the metrics token.
32+
5. Click **Create**.
33+
34+
![Oasis Metrics Tokens](images/oasis-metrics-token.png)
35+
36+
## How to connect Prometheus
37+
38+
1. In the **Metrics** section, click **Connect Prometheus**.
39+
2. Create the `prometheus.yml` file with the following content:
40+
41+
```yml
42+
global:
43+
scrape_interval: 60s
44+
scrape_configs:
45+
- job_name: 'deployment'
46+
bearer_token: '<fill-your-metrics-token-here>'
47+
scheme: 'https'
48+
static_configs:
49+
- targets: ['6775e7d48152.arangodb.cloud:8829']
50+
tls_config:
51+
insecure_skip_verify: true
52+
```
53+
3. Start Prometheus with the following command:
54+
55+
```dockerfile
56+
docker run -d \
57+
-p 9090:9090 -p 3000:3000 --name prometheus \
58+
-v $(pwd)/prometheus.yml:/etc/prometheus/prometheus.yml:ro \
59+
prom/prometheus
60+
```
61+
{% hint 'info' %}
62+
This command also opens a port 3000 for Grafana. In a production environment,
63+
this is not needed and not recommended to have it open.
64+
{% endhint %}
65+
66+
## How to connect Grafana
67+
68+
1. Start Grafana with the following command:
69+
70+
```dockerfile
71+
docker run -d \
72+
--network container:prometheus \
73+
grafana/grafana
74+
```
75+
2. Go to `localhost:3000` and log in with the following credentials:
76+
- For username, enter *admin*.
77+
- For password, enter *admin*.
78+
79+
{% hint 'tip' %}
80+
After the initial login, make sure to change your password.
81+
{% endhint %}
82+
83+
3. To add a data source, click **Add your first data source** and then do the following:
84+
- Select **Prometheus**.
85+
- For **HTTP URL**, enter `http://localhost:9090`.
86+
- Click **Save & Test**.
87+
4. To add a dashboard, open the menu and click **Create** and then **Import**.
88+
5. Download the [Grafana dashboard for ArangoDB Oasis](https://github.com/arangodb-managed/grafana-dashboards){:target="_blank"}.
89+
6. Copy the contents of the `main.json` file into the **Import via panel json** field in Grafana.
90+
7. Click **Load**.

oasis/oasisctl-clone-deployment-backup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ oasisctl clone deployment backup [flags]
2222
-b, --backup-id string Clone a deployment from a backup using the backup's ID.
2323
-h, --help help for backup
2424
-o, --organization-id string Identifier of the organization to create the clone in
25+
-p, --project-id string An optional identifier of the project to create the clone in
2526
-r, --region-id string An optionally defined region in which the new deployment should be created in.
2627
```
2728

oasis/oasisctl-create-backup-policy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ oasisctl create backup policy [flags]
2727
-h, --help help for policy
2828
--hours int32 Hours part of the time of day (0-23)
2929
--minutes int32 Minutes part of the time of day (0-59)
30+
--minutes-offset int32 Schedule should run with specific minutes offset (0-59)
3031
--monday If set, a backup will be created on Mondays
3132
--name string Name of the deployment
3233
--paused The policy is paused

oasis/oasisctl-create-private-endpoint-service.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ oasisctl create private endpoint service [flags]
1919

2020
```
2121
--alternate-dns-name strings DNS names used for the deployment in the private network
22+
--aws-principal strings List of AWS Principals from which a Private Endpoint can be created (Format: <AccountID>[/Role/<RoleName>|/User/<UserName>])
2223
--azure-client-subscription-id strings List of Azure subscription IDs from which a Private Endpoint can be created
2324
-d, --deployment-id string Identifier of the deployment that the private endpoint service is connected to
2425
--description string Description of the private endpoint service
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: default
3+
description: Description of the oasisctl disable scheduled-root-password-rotation command
4+
title: Oasisctl Disable Scheduled-Root-Password-Rotation
5+
---
6+
# Oasisctl Disable Scheduled-root-password-rotation
7+
8+
Disable scheduled root password rotation
9+
10+
## Synopsis
11+
12+
Disable scheduled root password rotation
13+
14+
```
15+
oasisctl disable scheduled-root-password-rotation [flags]
16+
```
17+
18+
## Options
19+
20+
```
21+
-d, --deployment-id string Identifier of the deployment
22+
-h, --help help for scheduled-root-password-rotation
23+
-o, --organization-id string Identifier of the organization
24+
-p, --project-id string Identifier of the project
25+
```
26+
27+
## Options inherited from parent commands
28+
29+
```
30+
--endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com")
31+
--format string Output format (table|json) (default "table")
32+
--token string Token used to authenticate at ArangoDB Oasis
33+
```
34+
35+
## See also
36+
37+
* [oasisctl disable](oasisctl-disable.html) - Disable some settings related to deployment
38+

oasis/oasisctl-disable.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: default
3+
description: Description of the oasisctl disable command
4+
title: Oasisctl Disable
5+
---
6+
# Oasisctl Disable
7+
8+
Disable some settings related to deployment
9+
10+
## Synopsis
11+
12+
Disable some settings related to deployment
13+
14+
```
15+
oasisctl disable [flags]
16+
```
17+
18+
## Options
19+
20+
```
21+
-h, --help help for disable
22+
```
23+
24+
## Options inherited from parent commands
25+
26+
```
27+
--endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com")
28+
--format string Output format (table|json) (default "table")
29+
--token string Token used to authenticate at ArangoDB Oasis
30+
```
31+
32+
## See also
33+
34+
* [oasisctl](oasisctl-options.html) - ArangoDB Oasis
35+
* [oasisctl disable scheduled-root-password-rotation](oasisctl-disable-scheduled-root-password-rotation.html) - Disable scheduled root password rotation
36+

0 commit comments

Comments
 (0)