From 33615c8b587f7591b81d6fd921267d72e8f0e6f3 Mon Sep 17 00:00:00 2001 From: Sam Storie Date: Sun, 9 Jan 2022 20:16:28 -0600 Subject: [PATCH] chore: updating the label list in the docs Signed-off-by: Sam Storie --- docs/collector.mscluster_cluster.md | 154 ++++++++++++++-------------- docs/collector.mscluster_network.md | 10 +- docs/collector.mscluster_node.md | 28 ++--- 3 files changed, 96 insertions(+), 96 deletions(-) diff --git a/docs/collector.mscluster_cluster.md b/docs/collector.mscluster_cluster.md index 957ee5a6..fd8b1717 100644 --- a/docs/collector.mscluster_cluster.md +++ b/docs/collector.mscluster_cluster.md @@ -16,83 +16,83 @@ None Name | Description | Type | Labels -----|-------------|------|------- -`AddEvictDelay` | Provides access to the cluster's AddEvictDelay property, which is the number a seconds that a new node is delayed after an eviction of another node. | guage | None -`AdminAccessPoint` | The type of the cluster administrative access point. | guage | None -`AutoAssignNodeSite` | Determines whether or not the cluster will attempt to automatically assign nodes to sites based on networks and Active Directory Site information. | guage | None -`AutoBalancerLevel` | Determines the level of aggressiveness of AutoBalancer. | guage | None -`AutoBalancerMode` | Determines whether or not the auto balancer is enabled. | guage | None -`BackupInProgress` | Indicates whether a backup is in progress. | guage | None -`BlockCacheSize` | CSV BlockCache Size in MB. | guage | None -`ClusSvcHangTimeout` | Controls how long the cluster network driver waits between Failover Cluster Service heartbeats before it determines that the Failover Cluster Service has stopped responding. | guage | None -`ClusSvcRegroupOpeningTimeout` | Controls how long a node will wait on other nodes in the opening stage before deciding that they failed. | guage | None -`ClusSvcRegroupPruningTimeout` | Controls how long the membership leader will wait to reach full connectivity between cluster nodes. | guage | None -`ClusSvcRegroupStageTimeout` | Controls how long a node will wait on other nodes in a membership stage before deciding that they failed. | guage | None -`ClusSvcRegroupTickInMilliseconds` | Controls how frequently the membership algorithm is sending periodic membership messages. | guage | None -`ClusterEnforcedAntiAffinity` | Enables or disables hard enforcement of group anti-affinity classes. | guage | None -`ClusterFunctionalLevel` | The functional level the cluster is currently running in. | guage | None -`ClusterGroupWaitDelay` | Maximum time in seconds that a group waits for its preferred node to come online during cluster startup before coming online on a different node. | guage | None -`ClusterLogLevel` | Controls the level of cluster logging. | guage | None -`ClusterLogSize` | Controls the maximum size of the cluster log files on each of the nodes. | guage | None -`ClusterUpgradeVersion` | Specifies the upgrade version the cluster is currently running in. | guage | None -`CrossSiteDelay` | Controls how long the cluster network driver waits in milliseconds between sending Cluster Service heartbeats across sites. | guage | None -`CrossSiteThreshold` | Controls how many Cluster Service heartbeats can be missed across sites before it determines that Cluster Service has stopped responding. | guage | None -`CrossSubnetDelay` | Controls how long the cluster network driver waits in milliseconds between sending Cluster Service heartbeats across subnets. | guage | None -`CrossSubnetThreshold` | Controls how many Cluster Service heartbeats can be missed across subnets before it determines that Cluster Service has stopped responding. | guage | None -`CsvBalancer` | Whether automatic balancing for CSV is enabled. | guage | None -`DatabaseReadWriteMode` | Sets the database read and write mode. | guage | None -`DefaultNetworkRole` | Provides access to the cluster's DefaultNetworkRole property. | guage | None -`DetectedCloudPlatform` | | guage | None -`DetectManagedEvents` | | guage | None -`DetectManagedEventsThreshold` | | guage | None -`DisableGroupPreferredOwnerRandomization` | | guage | None -`DrainOnShutdown` | Whether to drain the node when cluster service is being stopped. | guage | None -`DynamicQuorumEnabled` | Allows cluster service to adjust node weights as needed to increase availability. | guage | None -`EnableSharedVolumes` | Enables or disables cluster shared volumes on this cluster. | guage | None -`FixQuorum` | Provides access to the cluster's FixQuorum property, which specifies if the cluster is in a fix quorum state. | guage | None -`GracePeriodEnabled` | Whether the node grace period feature of this cluster is enabled. | guage | None -`GracePeriodTimeout` | The grace period timeout in milliseconds. | guage | None -`GroupDependencyTimeout` | The timeout after which a group will be brought online despite unsatisfied dependencies | guage | None -`HangRecoveryAction` | Controls the action to take if the user-mode processes have stopped responding. | guage | None -`IgnorePersistentStateOnStartup` | Provides access to the cluster's IgnorePersistentStateOnStartup property, which specifies whether the cluster will bring online groups that were online when the cluster was shut down. | guage | None -`LogResourceControls` | Controls the logging of resource controls. | guage | None -`LowerQuorumPriorityNodeId` | Specifies the Node ID that has a lower priority when voting for quorum is performed. If the quorum vote is split 50/50%, the specified node's vote would be ignored to break the tie. If this is not set then the cluster will pick a node at random to break the tie. | guage | None -`MaxNumberOfNodes` | Indicates the maximum number of nodes that may participate in the Cluster. | guage | None -`MessageBufferLength` | The maximum unacknowledged message count for GEM. | guage | None -`MinimumNeverPreemptPriority` | Groups with this priority or higher cannot be preempted. | guage | None -`MinimumPreemptorPriority` | Minimum priority a cluster group must have to be able to preempt another group. | guage | None -`NetftIPSecEnabled` | Whether IPSec is enabled for cluster internal traffic. | guage | None -`PlacementOptions` | Various option flags to modify default placement behavior. | guage | None -`PlumbAllCrossSubnetRoutes` | Plumbs all possible cross subnet routes to all nodes. | guage | None -`PreventQuorum` | Whether the cluster will ignore group persistent state on startup. | guage | None -`QuarantineDuration` | The quarantine period timeout in milliseconds. | guage | None -`QuarantineThreshold` | Number of node failures before it will be quarantined. | guage | None -`QuorumArbitrationTimeMax` | Controls the maximum time necessary to decide the Quorum owner node. | guage | None -`QuorumArbitrationTimeMin` | Controls the minimum time necessary to decide the Quorum owner node. | guage | None -`QuorumLogFileSize` | This property is obsolete. | guage | None -`QuorumTypeValue` | Get the current quorum type value. -1: Unknown; 1: Node; 2: FileShareWitness; 3: Storage; 4: None | guage | None -`RequestReplyTimeout` | Controls the request reply time-out period. | guage | None -`ResiliencyDefaultPeriod` | The default resiliency period, in seconds, for the cluster. | guage | None -`ResiliencyLevel` | The resiliency level for the cluster. | guage | None -`ResourceDllDeadlockPeriod` | This property is obsolete. | guage | None -`RootMemoryReserved` | Controls the amount of memory reserved for the parent partition on all cluster nodes. | guage | None -`RouteHistoryLength` | The history length for routes to help finding network issues. | guage | None -`S2DBusTypes` | Bus types for storage spaces direct. | guage | None -`S2DCacheDesiredState` | Desired state of the storage spaces direct cache. | guage | None -`S2DCacheFlashReservePercent` | Percentage of allocated flash space to utilize when caching. | guage | None -`S2DCachePageSizeKBytes` | Page size in KB used by S2D cache. | guage | None -`S2DEnabled` | Whether direct attached storage (DAS) is enabled. | guage | None -`S2DIOLatencyThreshold` | The I/O latency threshold for storage spaces direct. | guage | None -`S2DOptimizations` | Optimization flags for storage spaces direct. | guage | None -`SameSubnetDelay` | Controls how long the cluster network driver waits in milliseconds between sending Cluster Service heartbeats on the same subnet. | guage | None -`SameSubnetThreshold` | Controls how many Cluster Service heartbeats can be missed on the same subnet before it determines that Cluster Service has stopped responding. | guage | None -`SecurityLevel` | Controls the level of security that should apply to intracluster messages. 0: Clear Text; 1: Sign; 2: Encrypt | guage | None -`SecurityLevelForStorage` | | guage | None -`SharedVolumeVssWriterOperationTimeout` | CSV VSS Writer operation timeout in seconds. | guage | None -`ShutdownTimeoutInMinutes` | The maximum time in minutes allowed for cluster resources to come offline during cluster service shutdown. | guage | None -`UseClientAccessNetworksForSharedVolumes` | Whether the use of client access networks for cluster shared volumes feature of this cluster is enabled. 0: Disabled; 1: Enabled; 2: Auto | guage | None -`WitnessDatabaseWriteTimeout` | Controls the maximum time in seconds that a cluster database write to a witness can take before the write is abandoned. | guage | None -`WitnessDynamicWeight` | The weight of the configured witness. | guage | None -`WitnessRestartInterval` | Controls the witness restart interval. | guage | None +`AddEvictDelay` | Provides access to the cluster's AddEvictDelay property, which is the number a seconds that a new node is delayed after an eviction of another node. | guage | `name` +`AdminAccessPoint` | The type of the cluster administrative access point. | guage | `name` +`AutoAssignNodeSite` | Determines whether or not the cluster will attempt to automatically assign nodes to sites based on networks and Active Directory Site information. | guage | `name` +`AutoBalancerLevel` | Determines the level of aggressiveness of AutoBalancer. | guage | `name` +`AutoBalancerMode` | Determines whether or not the auto balancer is enabled. | guage | `name` +`BackupInProgress` | Indicates whether a backup is in progress. | guage | `name` +`BlockCacheSize` | CSV BlockCache Size in MB. | guage | `name` +`ClusSvcHangTimeout` | Controls how long the cluster network driver waits between Failover Cluster Service heartbeats before it determines that the Failover Cluster Service has stopped responding. | guage | `name` +`ClusSvcRegroupOpeningTimeout` | Controls how long a node will wait on other nodes in the opening stage before deciding that they failed. | guage | `name` +`ClusSvcRegroupPruningTimeout` | Controls how long the membership leader will wait to reach full connectivity between cluster nodes. | guage | `name` +`ClusSvcRegroupStageTimeout` | Controls how long a node will wait on other nodes in a membership stage before deciding that they failed. | guage | `name` +`ClusSvcRegroupTickInMilliseconds` | Controls how frequently the membership algorithm is sending periodic membership messages. | guage | `name` +`ClusterEnforcedAntiAffinity` | Enables or disables hard enforcement of group anti-affinity classes. | guage | `name` +`ClusterFunctionalLevel` | The functional level the cluster is currently running in. | guage | `name` +`ClusterGroupWaitDelay` | Maximum time in seconds that a group waits for its preferred node to come online during cluster startup before coming online on a different node. | guage | `name` +`ClusterLogLevel` | Controls the level of cluster logging. | guage | `name` +`ClusterLogSize` | Controls the maximum size of the cluster log files on each of the nodes. | guage | `name` +`ClusterUpgradeVersion` | Specifies the upgrade version the cluster is currently running in. | guage | `name` +`CrossSiteDelay` | Controls how long the cluster network driver waits in milliseconds between sending Cluster Service heartbeats across sites. | guage | `name` +`CrossSiteThreshold` | Controls how many Cluster Service heartbeats can be missed across sites before it determines that Cluster Service has stopped responding. | guage | `name` +`CrossSubnetDelay` | Controls how long the cluster network driver waits in milliseconds between sending Cluster Service heartbeats across subnets. | guage | `name` +`CrossSubnetThreshold` | Controls how many Cluster Service heartbeats can be missed across subnets before it determines that Cluster Service has stopped responding. | guage | `name` +`CsvBalancer` | Whether automatic balancing for CSV is enabled. | guage | `name` +`DatabaseReadWriteMode` | Sets the database read and write mode. | guage | `name` +`DefaultNetworkRole` | Provides access to the cluster's DefaultNetworkRole property. | guage | `name` +`DetectedCloudPlatform` | | guage | `name` +`DetectManagedEvents` | | guage | `name` +`DetectManagedEventsThreshold` | | guage | `name` +`DisableGroupPreferredOwnerRandomization` | | guage | `name` +`DrainOnShutdown` | Whether to drain the node when cluster service is being stopped. | guage | `name` +`DynamicQuorumEnabled` | Allows cluster service to adjust node weights as needed to increase availability. | guage | `name` +`EnableSharedVolumes` | Enables or disables cluster shared volumes on this cluster. | guage | `name` +`FixQuorum` | Provides access to the cluster's FixQuorum property, which specifies if the cluster is in a fix quorum state. | guage | `name` +`GracePeriodEnabled` | Whether the node grace period feature of this cluster is enabled. | guage | `name` +`GracePeriodTimeout` | The grace period timeout in milliseconds. | guage | `name` +`GroupDependencyTimeout` | The timeout after which a group will be brought online despite unsatisfied dependencies | guage | `name` +`HangRecoveryAction` | Controls the action to take if the user-mode processes have stopped responding. | guage | `name` +`IgnorePersistentStateOnStartup` | Provides access to the cluster's IgnorePersistentStateOnStartup property, which specifies whether the cluster will bring online groups that were online when the cluster was shut down. | guage | `name` +`LogResourceControls` | Controls the logging of resource controls. | guage | `name` +`LowerQuorumPriorityNodeId` | Specifies the Node ID that has a lower priority when voting for quorum is performed. If the quorum vote is split 50/50%, the specified node's vote would be ignored to break the tie. If this is not set then the cluster will pick a node at random to break the tie. | guage | `name` +`MaxNumberOfNodes` | Indicates the maximum number of nodes that may participate in the Cluster. | guage | `name` +`MessageBufferLength` | The maximum unacknowledged message count for GEM. | guage | `name` +`MinimumNeverPreemptPriority` | Groups with this priority or higher cannot be preempted. | guage | `name` +`MinimumPreemptorPriority` | Minimum priority a cluster group must have to be able to preempt another group. | guage | `name` +`NetftIPSecEnabled` | Whether IPSec is enabled for cluster internal traffic. | guage | `name` +`PlacementOptions` | Various option flags to modify default placement behavior. | guage | `name` +`PlumbAllCrossSubnetRoutes` | Plumbs all possible cross subnet routes to all nodes. | guage | `name` +`PreventQuorum` | Whether the cluster will ignore group persistent state on startup. | guage | `name` +`QuarantineDuration` | The quarantine period timeout in milliseconds. | guage | `name` +`QuarantineThreshold` | Number of node failures before it will be quarantined. | guage | `name` +`QuorumArbitrationTimeMax` | Controls the maximum time necessary to decide the Quorum owner node. | guage | `name` +`QuorumArbitrationTimeMin` | Controls the minimum time necessary to decide the Quorum owner node. | guage | `name` +`QuorumLogFileSize` | This property is obsolete. | guage | `name` +`QuorumTypeValue` | Get the current quorum type value. -1: Unknown; 1: Node; 2: FileShareWitness; 3: Storage; 4: None | guage | `name` +`RequestReplyTimeout` | Controls the request reply time-out period. | guage | `name` +`ResiliencyDefaultPeriod` | The default resiliency period, in seconds, for the cluster. | guage | `name` +`ResiliencyLevel` | The resiliency level for the cluster. | guage | `name` +`ResourceDllDeadlockPeriod` | This property is obsolete. | guage | `name` +`RootMemoryReserved` | Controls the amount of memory reserved for the parent partition on all cluster nodes. | guage | `name` +`RouteHistoryLength` | The history length for routes to help finding network issues. | guage | `name` +`S2DBusTypes` | Bus types for storage spaces direct. | guage | `name` +`S2DCacheDesiredState` | Desired state of the storage spaces direct cache. | guage | `name` +`S2DCacheFlashReservePercent` | Percentage of allocated flash space to utilize when caching. | guage | `name` +`S2DCachePageSizeKBytes` | Page size in KB used by S2D cache. | guage | `name` +`S2DEnabled` | Whether direct attached storage (DAS) is enabled. | guage | `name` +`S2DIOLatencyThreshold` | The I/O latency threshold for storage spaces direct. | guage | `name` +`S2DOptimizations` | Optimization flags for storage spaces direct. | guage | `name` +`SameSubnetDelay` | Controls how long the cluster network driver waits in milliseconds between sending Cluster Service heartbeats on the same subnet. | guage | `name` +`SameSubnetThreshold` | Controls how many Cluster Service heartbeats can be missed on the same subnet before it determines that Cluster Service has stopped responding. | guage | `name` +`SecurityLevel` | Controls the level of security that should apply to intracluster messages. 0: Clear Text; 1: Sign; 2: Encrypt | guage | `name` +`SecurityLevelForStorage` | | guage | `name` +`SharedVolumeVssWriterOperationTimeout` | CSV VSS Writer operation timeout in seconds. | guage | `name` +`ShutdownTimeoutInMinutes` | The maximum time in minutes allowed for cluster resources to come offline during cluster service shutdown. | guage | `name` +`UseClientAccessNetworksForSharedVolumes` | Whether the use of client access networks for cluster shared volumes feature of this cluster is enabled. 0: Disabled; 1: Enabled; 2: Auto | guage | `name` +`WitnessDatabaseWriteTimeout` | Controls the maximum time in seconds that a cluster database write to a witness can take before the write is abandoned. | guage | `name` +`WitnessDynamicWeight` | The weight of the configured witness. | guage | `name` +`WitnessRestartInterval` | Controls the witness restart interval. | guage | `name` ### Example metric _This collector does not yet have explained examples, we would appreciate your help adding them!_ diff --git a/docs/collector.mscluster_network.md b/docs/collector.mscluster_network.md index e485046a..0e482736 100644 --- a/docs/collector.mscluster_network.md +++ b/docs/collector.mscluster_network.md @@ -16,11 +16,11 @@ None Name | Description | Type | Labels -----|-------------|------|------- -`Characteristics` | Provides the characteristics of the network. The cluster defines characteristics only for resources. For a description of these characteristics, see [CLUSCTL_RESOURCE_GET_CHARACTERISTICS](https://msdn.microsoft.com/library/aa367466). | guage | None -`Flags` | Provides access to the flags set for the network. The cluster defines flags only for resources. For a description of these flags, see [CLUSCTL_RESOURCE_GET_FLAGS](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/mscs/clusctl-resource-get-flags). | guage | None -`Metric` | The metric of a cluster network (networks with lower values are used first). If this value is set, then the AutoMetric property is set to false. | guage | None -`Role` | Provides access to the network's Role property. The Role property describes the role of the network in the cluster. 0: None; 1: Cluster; 2: Client; 3: Both | guage | None -`State` | Provides the current state of the network. 1-1: Unknown; 0: Unavailable; 1: Down; 2: Partitioned; 3: Up | guage | None +`Characteristics` | Provides the characteristics of the network. The cluster defines characteristics only for resources. For a description of these characteristics, see [CLUSCTL_RESOURCE_GET_CHARACTERISTICS](https://msdn.microsoft.com/library/aa367466). | guage | `name` +`Flags` | Provides access to the flags set for the network. The cluster defines flags only for resources. For a description of these flags, see [CLUSCTL_RESOURCE_GET_FLAGS](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/mscs/clusctl-resource-get-flags). | guage | `name` +`Metric` | The metric of a cluster network (networks with lower values are used first). If this value is set, then the AutoMetric property is set to false. | guage | `name` +`Role` | Provides access to the network's Role property. The Role property describes the role of the network in the cluster. 0: None; 1: Cluster; 2: Client; 3: Both | guage | `name` +`State` | Provides the current state of the network. 1-1: Unknown; 0: Unavailable; 1: Down; 2: Partitioned; 3: Up | guage | `name` ### Example metric _This collector does not yet have explained examples, we would appreciate your help adding them!_ diff --git a/docs/collector.mscluster_node.md b/docs/collector.mscluster_node.md index 8bee1577..d02f3d67 100644 --- a/docs/collector.mscluster_node.md +++ b/docs/collector.mscluster_node.md @@ -16,20 +16,20 @@ None Name | Description | Type | Labels -----|-------------|------|------- -`BuildNumber` | Provides access to the node's BuildNumber property. | guage | None -`Characteristics` | Provides access to the characteristics set for the node. For a list of possible characteristics, see [CLUSCTL_NODE_GET_CHARACTERISTICS](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/mscs/clusctl-node-get-characteristics). | guage | None -`DetectedCloudPlatform` | The dynamic vote weight of the node adjusted by dynamic quorum feature. | guage | None -`DynamicWeight` | The dynamic vote weight of the node adjusted by dynamic quorum feature. | guage | None -`Flags` | Provides access to the flags set for the node. For a list of possible characteristics, see [CLUSCTL_NODE_GET_FLAGS](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/mscs/clusctl-node-get-flags). | guage | None -`MajorVersion` | Provides access to the node's MajorVersion property, which specifies the major portion of the Windows version installed. | guage | None -`MinorVersion` | Provides access to the node's MinorVersion property, which specifies the minor portion of the Windows version installed. | guage | None -`NeedsPreventQuorum` | Whether the cluster service on that node should be started with prevent quorum flag. | guage | None -`NodeDrainStatus` | The current node drain status of a node. 0: Not Initiated; 1: In Progress; 2: Completed; 3: Failed | guage | None -`NodeHighestVersion` | Provides access to the node's NodeHighestVersion property, which specifies the highest possible version of the cluster service with which the node can join or communicate. | guage | None -`NodeLowestVersion` | Provides access to the node's NodeLowestVersion property, which specifies the lowest possible version of the cluster service with which the node can join or communicate. | guage | None -`NodeWeight` | The vote weight of the node. | guage | None -`State` | Returns the current state of a node. -1: Unknown; 0: Up; 1: Down; 2: Paused; 3: Joining | guage | None -`StatusInformation` | The isolation or quarantine status of the node. | guage | None +`BuildNumber` | Provides access to the node's BuildNumber property. | guage | `name` +`Characteristics` | Provides access to the characteristics set for the node. For a list of possible characteristics, see [CLUSCTL_NODE_GET_CHARACTERISTICS](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/mscs/clusctl-node-get-characteristics). | guage | `name` +`DetectedCloudPlatform` | The dynamic vote weight of the node adjusted by dynamic quorum feature. | guage | `name` +`DynamicWeight` | The dynamic vote weight of the node adjusted by dynamic quorum feature. | guage | `name` +`Flags` | Provides access to the flags set for the node. For a list of possible characteristics, see [CLUSCTL_NODE_GET_FLAGS](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/mscs/clusctl-node-get-flags). | guage | `name` +`MajorVersion` | Provides access to the node's MajorVersion property, which specifies the major portion of the Windows version installed. | guage | `name` +`MinorVersion` | Provides access to the node's MinorVersion property, which specifies the minor portion of the Windows version installed. | guage | `name` +`NeedsPreventQuorum` | Whether the cluster service on that node should be started with prevent quorum flag. | guage | `name` +`NodeDrainStatus` | The current node drain status of a node. 0: Not Initiated; 1: In Progress; 2: Completed; 3: Failed | guage | `name` +`NodeHighestVersion` | Provides access to the node's NodeHighestVersion property, which specifies the highest possible version of the cluster service with which the node can join or communicate. | guage | `name` +`NodeLowestVersion` | Provides access to the node's NodeLowestVersion property, which specifies the lowest possible version of the cluster service with which the node can join or communicate. | guage | `name` +`NodeWeight` | The vote weight of the node. | guage | `name` +`State` | Returns the current state of a node. -1: Unknown; 0: Up; 1: Down; 2: Paused; 3: Joining | guage | `name` +`StatusInformation` | The isolation or quarantine status of the node. | guage | `name` ### Example metric _This collector does not yet have explained examples, we would appreciate your help adding them!_