Improvement: Add owner_node on resource and resourcegroup for mscluster #1395

webalexeu · 2024-01-25T15:01:07Z

Hello,

This PR will add owner_node label on resource and resourcegroup metrics for mscluster
(It has been tested)

Let me know if you need additionnal details or some code adjustements

Thank you,
Alex

webalexeu · 2024-02-03T09:05:19Z

Hello reviewers @jkroepke @breed808,

Can you please have a look at this PR ?

Thank you,
Alex

jkroepke · 2024-02-03T09:50:45Z

Hi @webalexeu

I have this PR on my list, however I'm currently limited in PR review, since a destroyed my laptop weeks ago.

webalexeu · 2024-02-03T10:03:12Z

Hi @webalexeu

I have this PR on my list, however I'm currently limited in PR review, since a destroyed my laptop weeks ago.

Do you want to have an output before and after the change ?

I can also provide the compiled version as well if it can help you

jkroepke · 2024-02-04T19:21:08Z

If you have a screenshot from the owner inside the sql system + the output from the metrics, it would help a lot. I dont have any mscluster expericence.

webalexeu · 2024-02-04T21:06:10Z

If you have a screenshot from the owner inside the sql system + the output from the metrics, it would help a lot. I dont have any mscluster expericence.

This is the output of the metrics and the cmdlet output of the cluster associated
(To keep output short, only the state but owner_node is defined on every metrics generated for both collectors)

windows_mscluster_resource_state gauge

windows_mscluster_resource_state{name="Cluster IP DC1",owner_group="Cluster",owner_node="node2",type="IP Address"} 3
windows_mscluster_resource_state{name="Cluster IP DC2",owner_group="Cluster",owner_node="node2",type="IP Address"} 3
windows_mscluster_resource_state{name="Cluster IP DC3",owner_group="Cluster",owner_node="node2",type="IP Address"} 2
windows_mscluster_resource_state{name="Cluster VIP",owner_group="Cluster",owner_node="node2",type="Network Name"} 2
windows_mscluster_resource_state{name="sql1",owner_group="sql1",owner_node="node2",type="SQL Server Availability Group"} 2
windows_mscluster_resource_state{name="sql1_ip_dc1",owner_group="sql1",owner_node="node2",type="IP Address"} 3
windows_mscluster_resource_state{name="sql1_ip_dc2",owner_group="sql1",owner_node="node2",type="IP Address"} 2
windows_mscluster_resource_state{name="sql1_ip_dc3",owner_group="sql1",owner_node="node2",type="IP Address"} 3
windows_mscluster_resource_state{name="sql1_sql1-ag1",owner_group="sql1",owner_node="node2",type="Network Name"} 2

Get-ClusterResource | Select Name,OwnerGroup,OwnerNode,ResourceType,State | ft
Name           OwnerGroup OwnerNode ResourceType                    State
----           ---------- --------- ------------                    -----
Cluster IP DC3 Cluster    node2     IP Address                    Offline
Cluster IP DC1 Cluster    node2     IP Address                    Offline
Cluster IP DC2 Cluster    node2     IP Address                     Online
Cluster VIP    Cluster    node2     Network Name                   Online
sql1           sql1       node2     SQL Server Availability Group  Online
sql1_ip_dc1    sql1       node2     IP Address                    Offline
sql1_ip_dc2    sql1       node2     IP Address                     Online
sql1_ip_dc3    sql1       node2     IP Address                    Offline
sql1_sql1-ag1  sql1       node2     Network Name                   Online

windows_mscluster_resourcegroup_state gauge

windows_mscluster_resourcegroup_state{name="Available Storage",owner_node="node2"} 1
windows_mscluster_resourcegroup_state{name="Cluster",owner_node="node2"} 0
windows_mscluster_resourcegroup_state{name="sql1",owner_node="node2"} 0

Get-ClusterGroup
Name              OwnerNode   State
----              ---------   -----
Available Storage node2     Offline
Cluster           node2      Online
sql1              node2      Online

jkroepke · 2024-02-04T21:28:28Z

I see, the owner node is something what could be changes from time to time, right?

Reading https://prometheus.io/docs/practices/naming/#labels

CAUTION: Remember that every unique combination of key-value label pairs represents a new time series, which can dramatically increase the amount of data stored. Do not use labels to store dimensions with high cardinality (many different label values), such as user IDs, email addresses, or other unbounded sets of values.

It's an sub-optimal use-case for an label value.

I can see, that owner node is attached to each metric. Is it sufficient to have the label only on windows_mscluster_resource_state and windows_mscluster_resourcegroup_state?

The label could be attach to results via operator, e.g.:

metric + on(name) group_left(owner_node) windows_mscluster_resource_state * 0

I'm aware that owner_group is attached everywhere, too. Thats also something, was is not strictly nessesary.

webalexeu · 2024-02-04T21:35:40Z

Indeed, OwnerNode will change on every failover of ressources within the cluster

There is no need indeed to have that label on every metrics and have it on state should be enough

I will update then my PR

Thanks for the review

Signed-off-by: Dinifarb <andreas.vogt89@bluewin.ch> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

…rsFlag Signed-off-by: Dinifarb <andreas.vogt89@bluewin.ch> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Bumps [github.com/prometheus/common](https://github.com/prometheus/common) from 0.45.0 to 0.46.0. - [Release notes](https://github.com/prometheus/common/releases) - [Commits](prometheus/common@v0.45.0...v0.46.0) --- updated-dependencies: - dependency-name: github.com/prometheus/common dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Bumps [github.com/containerd/containerd](https://github.com/containerd/containerd) from 1.7.0 to 1.7.11. - [Release notes](https://github.com/containerd/containerd/releases) - [Changelog](https://github.com/containerd/containerd/blob/main/RELEASES.md) - [Commits](containerd/containerd@v1.7.0...v1.7.11) --- updated-dependencies: - dependency-name: github.com/containerd/containerd dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Signed-off-by: dinifarb <andreas.vogt89@bluewin.ch> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Bumps [github.com/yusufpapurcu/wmi](https://github.com/yusufpapurcu/wmi) from 1.2.3 to 1.2.4. - [Release notes](https://github.com/yusufpapurcu/wmi/releases) - [Commits](yusufpapurcu/wmi@v1.2.3...v1.2.4) --- updated-dependencies: - dependency-name: github.com/yusufpapurcu/wmi dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Microsoft currently support Windows Server 2016 or newer, and Windows 10 and Windows 11 (21HR or later). Dropping support for end-of-life Windows Server versions will reduce maintenance overhead for project maintainers. Signed-off-by: Ben Reedy <breed808@breed808.com> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Co-authored-by: Jan-Otto Kröpke <github@jkroepke.de> Signed-off-by: Ben Reedy <breed808@users.noreply.github.com> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Bumps [golang.org/x/sys](https://github.com/golang/sys) from 0.16.0 to 0.17.0. - [Commits](golang/sys@v0.16.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/sys dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

jkroepke · 2024-02-16T14:37:21Z

I convert the PR to draft, please let me know, when you finished

webalexeu · 2024-02-16T15:16:27Z

Hello @jkroepke ,
I've review the PR based on our discussion
Finally, I've generate new metrics for owner node and not new labels
So based on the previous example, here is the new metrics generated:

HELP windows_mscluster_resource_owner_node The node hosting the resource. 0: Not hosted; 1: Hosted
TYPE windows_mscluster_resource_owner_node gauge

windows_mscluster_resource_owner_node{name="Cluster IP DC1",owner_group="Cluster",node_name="node1",type="IP Address"} 1
windows_mscluster_resource_owner_node{name="Cluster IP DC1",owner_group="Cluster",node_name="node2",type="IP Address"} 0
windows_mscluster_resource_owner_node{name="Cluster IP DC2",owner_group="Cluster",node_name="node1",type="IP Address"} 1
windows_mscluster_resource_owner_node{name="Cluster IP DC2",owner_group="Cluster",node_name="node2",type="IP Address"} 0
windows_mscluster_resource_owner_node{name="Cluster IP DC3",owner_group="Cluster",node_name="node1",type="IP Address"} 1
windows_mscluster_resource_owner_node{name="Cluster IP DC3",owner_group="Cluster",node_name="node2",type="IP Address"} 0
windows_mscluster_resource_owner_node{name="Cluster VIP",owner_group="Cluster",node_name="node1",type="Network Name"} 1
windows_mscluster_resource_owner_node{name="Cluster VIP",owner_group="Cluster",node_name="node2",type="Network Name"} 0
windows_mscluster_resource_owner_node{name="sql1",owner_group="sql1",node_name="node1",type="SQL Server Availability Group"} 0
windows_mscluster_resource_owner_node{name="sql1",owner_group="sql1",node_name="node2",type="SQL Server Availability Group"} 1
windows_mscluster_resource_owner_node{name="sql1_ip_dc1",owner_group="sql1",node_name="node1",type="IP Address"} 0
windows_mscluster_resource_owner_node{name="sql1_ip_dc1",owner_group="sql1",node_name="node2",type="IP Address"} 1
windows_mscluster_resource_owner_node{name="sql1_ip_dc2",owner_group="sql1",node_name="node1",type="IP Address"} 0
windows_mscluster_resource_owner_node{name="sql1_ip_dc2",owner_group="sql1",node_name="node2",type="IP Address"} 1
windows_mscluster_resource_owner_node{name="sql1_ip_dc3",owner_group="sql1",node_name="node1",type="IP Address"} 0
windows_mscluster_resource_owner_node{name="sql1_ip_dc3",owner_group="sql1",node_name="node2",type="IP Address"} 1
windows_mscluster_resource_owner_node{name="sql1_sql1-ag1",owner_group="sql1",node_name="node1",type="Network Name"} 0
windows_mscluster_resource_owner_node{name="sql1_sql1-ag1",owner_group="sql1",node_name="node2",type="Network Name"} 1

Get-ClusterResource | Select Name,OwnerGroup,OwnerNode,ResourceType,State | ft
Name           OwnerGroup OwnerNode ResourceType                    State
----           ---------- --------- ------------                    -----
Cluster IP DC3 Cluster    node1     IP Address                    Offline
Cluster IP DC1 Cluster    node1     IP Address                    Offline
Cluster IP DC2 Cluster    node1     IP Address                     Online
Cluster VIP    Cluster    node1     Network Name                   Online
sql1           sql1       node2     SQL Server Availability Group  Online
sql1_ip_dc1    sql1       node2     IP Address                    Offline
sql1_ip_dc2    sql1       node2     IP Address                     Online
sql1_ip_dc3    sql1       node2     IP Address                    Offline
sql1_sql1-ag1  sql1       node2     Network Name                   Online

HELP windows_mscluster_resourcegroup_owner_node The node hosting the resource group. 0: Not hosted; 1: Hosted
TYPE windows_mscluster_resourcegroup_owner_node gauge

windows_mscluster_resourcegroup_owner_node{name="Available Storage",node_name="node1"} 0
windows_mscluster_resourcegroup_owner_node{name="Available Storage",node_name="node2"} 1
windows_mscluster_resourcegroup_owner_node{name="Cluster",node_name="node1"} 1
windows_mscluster_resourcegroup_owner_node{name="Cluster",node_name="node2"} 0
windows_mscluster_resourcegroup_owner_node{name="sql1",node_name="node1"} 0
windows_mscluster_resourcegroup_owner_node{name="sql1",node_name="node2"} 1

Get-ClusterGroup
Name              OwnerNode   State
----              ---------   -----
Available Storage node2     Offline
Cluster           node1      Online
sql1              node2      Online

Let me know if you want additionnal details or some code review

Thank you

jkroepke · 2024-02-16T15:29:39Z

@webalexeu It looks good to me here.

You last post explains the feature well. Could you please copy the content to the docs docs/collector.mscluster_resource.md? It explains it really well!

webalexeu · 2024-02-16T20:01:38Z

@webalexeu It looks good to me here.

You last post explains the feature well. Could you please copy the content to the docs docs/collector.mscluster_resource.md? It explains it really well!

I already put example and useful queries

Under which section do you want me to put it ?

jkroepke

LGTM 👍

webalexeu · 2024-05-05T14:00:31Z

Hello @jkroepke ,

Any idea when you will release a new version of the exporter ?

Have a nice weekend,
Alex

webalexeu requested a review from a team as a code owner January 25, 2024 15:01

webalexeu force-pushed the feat/add_owner_node branch from ae958ef to 22f6f24 Compare January 25, 2024 15:12

webalexeu force-pushed the feat/add_owner_node branch from 40ae7e1 to 282a240 Compare February 16, 2024 07:44

DiniFarb and others added 15 commits February 16, 2024 08:54

fix:(prometheus-community#1382): rename TEXTFILE_DIR to TEXTFILE_DIRS

d07845c

Signed-off-by: Dinifarb <andreas.vogt89@bluewin.ch> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

fix:(prometheus-community#1382): update TextfileDirFlag to TextfileDi…

e2ceb0d

…rsFlag Signed-off-by: Dinifarb <andreas.vogt89@bluewin.ch> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Add owner_node on resource and resourcegroup for mscluster

6ca67f7

Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Add examples

eab8729

Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Create dedicated metric for owner_node

9b55683

Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Adapat documentation based on new metric

5ef7c1f

Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

fix(prometheus-community#1390): global kingpin instead of app var

941019e

Signed-off-by: dinifarb <andreas.vogt89@bluewin.ch> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Update README.md

143ab22

Co-authored-by: Jan-Otto Kröpke <github@jkroepke.de> Signed-off-by: Ben Reedy <breed808@users.noreply.github.com> Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Add owner_node on resource and resourcegroup for mscluster

233470c

Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

Create dedicated metric for owner_node

8d1d552

Signed-off-by: Alexandre JARDON <28548335+webalexeu@users.noreply.github.com>

webalexeu force-pushed the feat/add_owner_node branch from 77adae9 to 8d1d552 Compare February 16, 2024 07:56

Merge branch 'prometheus-community:master' into feat/add_owner_node

7f7239f

jkroepke marked this pull request as draft February 16, 2024 14:37

webalexeu marked this pull request as ready for review February 16, 2024 15:17

Merge branch 'master' into feat/add_owner_node

fdf6f33

jkroepke approved these changes Apr 21, 2024

View reviewed changes

jkroepke merged commit b1c272a into prometheus-community:master Apr 21, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvement: Add owner_node on resource and resourcegroup for mscluster #1395

Improvement: Add owner_node on resource and resourcegroup for mscluster #1395

webalexeu commented Jan 25, 2024 •

edited

webalexeu commented Feb 3, 2024 •

edited

jkroepke commented Feb 3, 2024

webalexeu commented Feb 3, 2024

jkroepke commented Feb 4, 2024

webalexeu commented Feb 4, 2024 •

edited

windows_mscluster_resource_state gauge

windows_mscluster_resourcegroup_state gauge

jkroepke commented Feb 4, 2024 •

edited

webalexeu commented Feb 4, 2024

jkroepke commented Feb 16, 2024

webalexeu commented Feb 16, 2024 •

edited

jkroepke commented Feb 16, 2024

webalexeu commented Feb 16, 2024

jkroepke left a comment

webalexeu commented May 5, 2024

Improvement: Add owner_node on resource and resourcegroup for mscluster #1395

Improvement: Add owner_node on resource and resourcegroup for mscluster #1395

Conversation

webalexeu commented Jan 25, 2024 • edited

webalexeu commented Feb 3, 2024 • edited

jkroepke commented Feb 3, 2024

webalexeu commented Feb 3, 2024

jkroepke commented Feb 4, 2024

webalexeu commented Feb 4, 2024 • edited

windows_mscluster_resource_state gauge

windows_mscluster_resourcegroup_state gauge

jkroepke commented Feb 4, 2024 • edited

webalexeu commented Feb 4, 2024

jkroepke commented Feb 16, 2024

webalexeu commented Feb 16, 2024 • edited

jkroepke commented Feb 16, 2024

webalexeu commented Feb 16, 2024

jkroepke left a comment

Choose a reason for hiding this comment

webalexeu commented May 5, 2024

webalexeu commented Jan 25, 2024 •

edited

webalexeu commented Feb 3, 2024 •

edited

webalexeu commented Feb 4, 2024 •

edited

jkroepke commented Feb 4, 2024 •

edited

webalexeu commented Feb 16, 2024 •

edited