Merge pull request #3197 from catherineluse/windows-monitoring

Update docs on Monitoring V2 Windows support per Arvind's feedback
This commit is contained in:
Catherine Luse
2021-04-16 14:59:21 -07:00
committed by GitHub
2 changed files with 12 additions and 12 deletions
@@ -89,11 +89,11 @@ To configure Prometheus resources from the Rancher UI, click **Apps & Marketplac
_Available as of v2.5.8_
Monitoring v2 can now be deployed on Windows nodes.
When deployed onto an RKE1 Windows cluster, Monitoring V2 will now automatically deploy a [windows-exporter](https://github.com/prometheus-community/windows_exporter) DaemonSet and set up a ServiceMonitor to collect metrics from each of the deployed Pods. This will populate Prometheus with `windows_` metrics that are akin to the `node_` metrics exported by [node_exporter](https://github.com/prometheus/node_exporter) for Linux hosts.
To be able to fully deploy Monitoring V2 for Windows, all of your Windows hosts must have a minimum wins version of v0.1.0.
To be able to fully deploy Monitoring V2 for Windows, all of your Windows hosts must have a minimum [wins](https://github.com/rancher/wins) version of v0.1.0.
For more details on how to upgrade wins on existing Windows hosts, refer to the section on [Windows cluster support for Monitoring v2.](./windows-clusters)
For more details on how to upgrade wins on existing Windows hosts, refer to the section on [Windows cluster support for Monitoring V2.](./windows-clusters)
# Using Monitoring
@@ -1,28 +1,28 @@
---
title: Windows Cluster Support for Monitoring v2
title: Windows Cluster Support for Monitoring V2
shortTitle: Windows Clusters
weight: 5
---
_Available as of v2.5.8_
Starting at Monitoring V2 9.4.204 (used by default in Rancher 2.5.8), Monitoring v2 can now be deployed on a Windows cluster and will scrape metrics from Windows nodes using [windows_exporter](https://github.com/prometheus-community/windows_exporter) (a community project previously named `wmi_exporter` when deployed in Monitoring V1).
Starting at Monitoring V2 14.5.100 (used by default in Rancher 2.5.8), Monitoring V2 can now be deployed on a Windows cluster and will scrape metrics from Windows nodes using [prometheus-community/windows_exporter](https://github.com/prometheus-community/windows_exporter) (previously named `wmi_exporter`).
- [Comparison to Monitoring v1](#comparison-to-monitoring-v1)
- [Comparison to Monitoring V1](#comparison-to-monitoring-v1)
- [Cluster Requirements](#cluster-requirements)
- [Upgrading Existing Clusters to wins v0.1.0](#upgrading-existing-clusters-to-wins-v0-1-0)
# Comparison to Monitoring v1
# Comparison to Monitoring V1
Unlike Monitoring v1 for Windows, metrics collected by `windows_exporter` will be labeled as `windows_` instead of `wmi_` in accordance to a naming change from upstream from `wmi_exporter` to `windows_exporter`.
Unlike Monitoring V1 for Windows, metrics collected by `windows_exporter` will be labeled as `windows_` instead of `wmi_` in accordance to a naming change from upstream from `wmi_exporter` to `windows_exporter`.
In addition, Monitoring V2 for Windows will leverage a new feature in `wins` v0.1.0 to support scraping `windows_exporter` metrics from the Pod itself rather than from the Node. This means that users will no longer have to keep port 9796 open on each Windows host to allow Prometheus to scrape metrics.
In addition, Monitoring V2 for Windows will no longer require users to keep port 9796 open on Windows hosts since the host metrics will published directly onto a port exposed on the windows-exporter Pod. This feature was powered by recent changes made by `wins` v0.1.0 to support publishing ports exposed on the hostNetwork on Pods that use wins to run a privileged Windows binary as a host process.
# Cluster Requirements
Monitoring V2 for Windows can only scrape metrics from Windows hosts that have a minimum `wins` version of v0.1.0. To be able to fully deploy Monitoring V2 for Windows, all of your hosts must meet this requirement.
If you provision a fresh cluster in Rancher 2.5.8, your cluster should already meet this requirement.
If you provision a fresh RKE1 cluster in Rancher 2.5.8, your cluster should already meet this requirement.
### Upgrading Existing Clusters to wins v0.1.0
@@ -30,7 +30,7 @@ If the cluster was provisioned before Rancher 2.5.8 (even if the current Rancher
To facilitate this upgrade, Rancher 2.5.8 has released a brand new Helm chart called `rancher-wins-upgrader`.
> **Prerequisite:** Make sure Monitoring v1 for Windows is uninstalled.
> **Prerequisite:** Make sure Monitoring V1 for Windows is uninstalled.
1. Deploy `rancher-wins-upgrader` with the following override:
```yaml
@@ -52,6 +52,6 @@ To facilitate this upgrade, Rancher 2.5.8 has released a brand new Helm chart ca
enabled: false
```
**Result:** The hosts are ready for Monitoring v2 to be installed. You may choose to uninstall the `rancher-wins-upgrader` chart or keep it in your cluster to facilitate future upgrades.
**Result:** The hosts are ready for Monitoring V2 to be installed. You may choose to uninstall the `rancher-wins-upgrader` chart or keep it in your cluster to facilitate future upgrades.
For more information on how it can be used, please see the [README.md](https://github.com/rancher/wins/blob/master/charts/rancher-wins-upgrader/README.md) of the chart.