This is an automated email from the ASF dual-hosted git repository.
yuteng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new 3082d30e29 [YUNIKORN-2749] Place all observability related doc in same
directory (#465)
3082d30e29 is described below
commit 3082d30e29e25e410d3319625a82e31952a0d651
Author: mean-world <[email protected]>
AuthorDate: Mon Aug 26 19:42:56 2024 +0800
[YUNIKORN-2749] Place all observability related doc in same directory (#465)
* [YUNIKORN-2749] Place all observability related doc in same directory
* [YUNIKORN-2749] Place all observability related doc in same directory
---
docs/get_started/get_started.md | 2 +-
docs/user_guide/{ => observability}/loki.md | 16 ++++++-------
docs/user_guide/{ => observability}/prometheus.md | 18 +++++++-------
sidebars.js | 29 ++++++++++++++---------
4 files changed, 36 insertions(+), 29 deletions(-)
diff --git a/docs/get_started/get_started.md b/docs/get_started/get_started.md
index 0198a0ccc6..1f3dd11940 100644
--- a/docs/get_started/get_started.md
+++ b/docs/get_started/get_started.md
@@ -101,4 +101,4 @@ YuniKorn UI provides a centralised view for cluster
resource capacity, utilizati
Besides, YuniKorn also exposes its scheduling metrics via Prometheus.
-If you want to monitor the YuniKorn core services by using Prometheus and
Grafana, you can find our step-by-step tutorial
[here](../user_guide/prometheus.md).
+If you want to monitor the YuniKorn core services by using Prometheus and
Grafana, you can find our step-by-step tutorial
[here](../user_guide/observability/prometheus.md).
diff --git a/docs/user_guide/loki.md b/docs/user_guide/observability/loki.md
similarity index 91%
rename from docs/user_guide/loki.md
rename to docs/user_guide/observability/loki.md
index 682cfce44d..7f65d714a5 100644
--- a/docs/user_guide/loki.md
+++ b/docs/user_guide/observability/loki.md
@@ -37,7 +37,7 @@ helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
helm upgrade --install grafana grafana/grafana -n meta --create-namespace
```
-
+
## Install Loki
1. Create the `binary.yaml` file
@@ -120,7 +120,7 @@ bloomGateway:
```
helm upgrade --install loki grafana/loki -n meta -f binary.yaml
```
-
+
:::info[Troubleshoot]
@@ -142,7 +142,7 @@ config:
```
helm upgrade --install promtail grafana/promtail -f promtail.yaml
```
-
+
## Grafana settings to connect to Loki
### 1. Access the Grafana Web UI
@@ -155,15 +155,15 @@ After running port forwarding, you can access Grafana's
web interface by [localh
In grafana, adding a loki data source with url and http headers allows grafana
to fetch logs.
#### set URL field `http://loki-gateway`
-
+
#### In order to fetch logs from promtail which tenantID is user, set HTTP
headers field X-Scope-OrgId with user.
-
+
## Loki log result
1. Set tracking target
-
+
2. bar chart
-
+
3. INFO log
-
+
diff --git a/docs/user_guide/prometheus.md
b/docs/user_guide/observability/prometheus.md
similarity index 90%
rename from docs/user_guide/prometheus.md
rename to docs/user_guide/observability/prometheus.md
index 8d7fb13781..a80a07cc87 100644
--- a/docs/user_guide/prometheus.md
+++ b/docs/user_guide/observability/prometheus.md
@@ -26,7 +26,7 @@ YuniKorn exposes its scheduling metrics via Prometheus. Thus,
we need to set up
We will provide two methods for building Prometheus: either running it locally
or using Helm to deploy it in your cluster. Additionally, in the Helm version,
we will explain how to integrate it with Grafana and provide generic Grafana
Dashboards for monitoring Yunikorn's metrics and observing the changes over
time.
-If you don't know what metric can be used, you can use [REST
API](../api/scheduler.md#metrics).
+If you don't know what metric can be used, you can use [REST
API](../../api/scheduler.md#metrics).
## Run Prometheus locally
@@ -75,13 +75,13 @@ kubectl port-forward svc/yunikorn-service 9080:9080 -n
yunikorn
./prometheus --config.file=prometheus.yml
```
-
+
### 5. Access the Prometheus UI
You should be able to browse to a status page at
[localhost:9090](http://localhost:9090/). Give it a couple of seconds to
collect data about itself from its own HTTP metrics endpoint.
-
+
You can also verify that Prometheus is serving metrics by navigating to its
metrics endpoint:[localhost:9090/metrics](http://localhost:9090/metrics)
@@ -146,7 +146,7 @@ After running port-forward, you can enter
[localhost:9090](http://localhost:9090
We can search yunikorn keyword to find the mointor target in targets page, and
check the status.
-
+
## Access Grafana Dashboard
@@ -158,7 +158,7 @@ kubectl port-forward -n prometheus svc/prometheus-grafana
7070:80
After running port-forward, you can enter
[localhost:7070](http://localhost:7070) to access grafana, and in the login
page, enter account:`admin` ,password:`prom-operator`.
-
+
### Download JSON files for Yunikorn Dashboard
@@ -166,16 +166,16 @@ A dashboard consists of multiple panels that are
organized and arranged in rows.
We provide a sample dashboard JSON file. To access it, you can navigate to the
`/deployments/grafana-dashboard` directory in the Yunikorn-k8shim repository.
-You can refer to the [REST API](../api/scheduler.md#metrics) to build your own
custom Dashboard.
+You can refer to the [REST API](../../api/scheduler.md#metrics) to build your
own custom Dashboard.
### Import the JSON files in the Dashboard
Once you access the Dashboard page, you can proceed to import the provided
JSON file.
-
+
-
+
Once the import is complete, you will be able to locate Yunikorn's Dashboard
on the page. From there, you can regularly monitor the status of Yunikorn.
-
+
diff --git a/sidebars.js b/sidebars.js
index 21b61d310a..e5787abf29 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -34,8 +34,6 @@ module.exports = {
'user_guide/resource_quota_management',
'user_guide/gang_scheduling',
'user_guide/labels_and_annotations_in_yunikorn',
- 'user_guide/prometheus',
- 'user_guide/loki',
'user_guide/use_cases',
'user_guide/event_system',
{
@@ -53,6 +51,23 @@ module.exports = {
'user_guide/workloads/run_ray_service',
],
},
+ {
+ type: 'category',
+ label: 'Observability',
+ items: [
+ 'user_guide/observability/prometheus',
+ 'user_guide/observability/loki',
+ {
+ type: 'category',
+ label: 'Metrics for Prometheus',
+ items: [
+ 'metrics/scheduler',
+ 'metrics/runtime',
+ 'metrics/queue',
+ ]
+ },
+ ],
+ },
{
type: 'category',
label: 'REST APIs',
@@ -62,15 +77,7 @@ module.exports = {
'api/system'
]
},
- {
- type: 'category',
- label: 'Metrics for Prometheus',
- items: [
- 'metrics/scheduler',
- 'metrics/runtime',
- 'metrics/queue',
- ]
- },
+
'user_guide/troubleshooting'
],
'Developer Guide': [
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
