Skip to content

Commit

Permalink
Merge pull request #283 from Surax98/openapi_doc
Browse files Browse the repository at this point in the history
Added monitoring documentation and how to enable it on VK side
  • Loading branch information
dciangot authored Aug 8, 2024
2 parents 74cf939 + 039bae7 commit 52347d3
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/docs/tutorial-admins/06-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ The following table is a list of spans generated by the VK:

## Installation

:::warning
To Enable tracing for the Virtual Kubelet, you have to set the Environment Variable ```ENABLE_TRACING``` to 1
:::

A requirement for the monitoring system is to have Helm installed in your Kubernetes cluster or in your local machine. If you don't have Helm installed, you can follow the instructions in the following link: https://helm.sh/docs/intro/install/

This helm chart requires a NGINX Ingress Controller to be installed in the cluster in order to expose the services and access them from outside the cluster.
Expand All @@ -87,8 +91,11 @@ kubectl create namespace interlink-mon
helm upgrade --install helm-vk-monitoring-release interlink-monitoring-stack/ -n interlink-mon --debug
```

5. Access Grafana dashboard through the domain you defined in the `values.yaml` file with the credentials you defined in the `values.yaml` file.
5. Deploy (or re-deploy) your Virtual Kubelet stack setting the ```TELEMETRY_ENDPOINT``` Environment Variable to your actual endpoint.
If not set, it defaults to ```localhost:4317```. Remember to enable the monitoring by also setting ```ENABLE_TRACING``` to 1.

6. Access Grafana dashboard through the domain you defined in the `values.yaml` file with the credentials you defined in the `values.yaml` file.

The following image shows the Grafana dashboard:

![Grafana Dashboard](./img/dashboard.png)
![Grafana Dashboard](./img/dashboard.png)

0 comments on commit 52347d3

Please sign in to comment.