mirror of
https://github.com/prometheus-community/windows_exporter
synced 2025-01-04 05:22:10 +00:00
chore: Adding/updating documentation for mscluster_network collector
Signed-off-by: Sam Storie <sam.storie@emerson.com>
This commit is contained in:
parent
3d50cf4309
commit
00f79ebaf4
@ -23,31 +23,31 @@ func newMSCluster_NetworkCollector() (Collector, error) {
|
|||||||
return &MSCluster_NetworkCollector{
|
return &MSCluster_NetworkCollector{
|
||||||
Characteristics: prometheus.NewDesc(
|
Characteristics: prometheus.NewDesc(
|
||||||
prometheus.BuildFQName(Namespace, subsystem, "characteristics"),
|
prometheus.BuildFQName(Namespace, subsystem, "characteristics"),
|
||||||
"(Characteristics)",
|
"Provides the characteristics of the network.",
|
||||||
[]string{"name"},
|
[]string{"name"},
|
||||||
nil,
|
nil,
|
||||||
),
|
),
|
||||||
Flags: prometheus.NewDesc(
|
Flags: prometheus.NewDesc(
|
||||||
prometheus.BuildFQName(Namespace, subsystem, "flags"),
|
prometheus.BuildFQName(Namespace, subsystem, "flags"),
|
||||||
"(Flags)",
|
"Provides access to the flags set for the node. ",
|
||||||
[]string{"name"},
|
[]string{"name"},
|
||||||
nil,
|
nil,
|
||||||
),
|
),
|
||||||
Metric: prometheus.NewDesc(
|
Metric: prometheus.NewDesc(
|
||||||
prometheus.BuildFQName(Namespace, subsystem, "metric"),
|
prometheus.BuildFQName(Namespace, subsystem, "metric"),
|
||||||
"(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.",
|
||||||
[]string{"name"},
|
[]string{"name"},
|
||||||
nil,
|
nil,
|
||||||
),
|
),
|
||||||
Role: prometheus.NewDesc(
|
Role: prometheus.NewDesc(
|
||||||
prometheus.BuildFQName(Namespace, subsystem, "role"),
|
prometheus.BuildFQName(Namespace, subsystem, "role"),
|
||||||
"(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 ",
|
||||||
[]string{"name"},
|
[]string{"name"},
|
||||||
nil,
|
nil,
|
||||||
),
|
),
|
||||||
State: prometheus.NewDesc(
|
State: prometheus.NewDesc(
|
||||||
prometheus.BuildFQName(Namespace, subsystem, "state"),
|
prometheus.BuildFQName(Namespace, subsystem, "state"),
|
||||||
"(State)",
|
"Provides the current state of the network. 1-1: Unknown; 0: Unavailable; 1: Down; 2: Partitioned; 3: Up",
|
||||||
[]string{"name"},
|
[]string{"name"},
|
||||||
nil,
|
nil,
|
||||||
),
|
),
|
||||||
|
32
docs/collector.mscluster_network.md
Normal file
32
docs/collector.mscluster_network.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# mscluster_network collector
|
||||||
|
|
||||||
|
The MSCluster_Network class is a dynamic WMI class that represents cluster networks.
|
||||||
|
|
||||||
|
|||
|
||||||
|
-|-
|
||||||
|
Metric name prefix | `mscluster_network`
|
||||||
|
Classes | `MSCluster_Network`
|
||||||
|
Enabled by default? | No
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
## Metrics
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### Example metric
|
||||||
|
_This collector does not yet have explained examples, we would appreciate your help adding them!_
|
||||||
|
|
||||||
|
## Useful queries
|
||||||
|
_This collector does not yet have any useful queries added, we would appreciate your help adding them!_
|
||||||
|
|
||||||
|
## Alerting examples
|
||||||
|
_This collector does not yet have alerting examples, we would appreciate your help adding them!_
|
Loading…
Reference in New Issue
Block a user