performancecounter: rename collector

README.md

@@ -42,7 +42,7 @@ Name     | Description | Enabled by default
 [net](docs/collector.net.md) | Network interface I/O | ✓
 [os](docs/collector.os.md) | OS metrics (memory, processes, users) | ✓
 [pagefile](docs/collector.pagefile.md) | pagefile metrics |
-[perfdata](docs/collector.perfdata.md) | Custom perfdata metrics |
+[performancecounter](docs/collector.performancecounter.md) | Custom performance counter metrics |
 [physical_disk](docs/collector.physical_disk.md) | physical disk metrics | ✓
 [printer](docs/collector.printer.md) | Printer metrics |
 [process](docs/collector.process.md) | Per-process metrics |

docs/README.md

@@ -18,6 +18,7 @@ This directory contains documentation of the collectors in the windows_exporter,
 - [`fsrmquota`](collector.fsrmquota.md)
 - [`hyperv`](collector.hyperv.md)
 - [`iis`](collector.iis.md)
+- [`license`](collector.license.md)
 - [`logical_disk`](collector.logical_disk.md)
 - [`logon`](collector.logon.md)
 - [`memory`](collector.memory.md)
@@ -28,12 +29,16 @@ This directory contains documentation of the collectors in the windows_exporter,
 - [`netframework`](collector.netframework.md)
 - [`nps`](collector.nps.md)
 - [`os`](collector.os.md)
+- [`pagefile`](collector.pagefile.md)
+- [`performancecounter`](collector.performancecounter.md)
 - [`physical_disk`](collector.physical_disk.md)
+- [`printer`](collector.printer.md)
 - [`process`](collector.process.md)
 - [`remote_fx`](collector.remote_fx.md)
 - [`scheduled_task`](collector.scheduled_task.md)
 - [`service`](collector.service.md)
 - [`smb`](collector.smb.md)
+- [`smbclient`](collector.smbclient.md)
 - [`smtp`](collector.smtp.md)
 - [`system`](collector.system.md)
 - [`tcp`](collector.tcp.md)

docs/collector.performancecounter.md

@@ -0,0 +1,193 @@
+# performancecounter collector
+
+The performancecounter collector exposes any configured metric.
+
+|                     |                         |
+|---------------------|-------------------------|
+| Metric name prefix  | `performancecounter`              |
+| Data source         | Performance Data Helper |
+| Enabled by default? | No                      |
+
+## Flags
+
+
+### `--collector.performancecounter.objects`
+
+Objects is a list of objects to collect metrics from. The value takes the form of a JSON array of strings. YAML is also supported.
+
+The collector supports only english named counter. Localized counter-names are not supported.
+
+#### Schema
+
+YAML:
+
+<details>
+<summary>Click to expand YAML schema</summary>
+
+```yaml
+- object: "Processor Information"
+  instances: ["*"]
+  instance_label: "core"
+  counters:
+    - name: "% Processor Time"
+      metric: windows_performancecounter_processor_information_processor_time # optional
+      labels:
+        state: active
+    - name: "% Idle Time"
+      metric: windows_performancecounter_processor_information_processor_time # optional
+      labels:
+        state: idle
+- object: "Memory"
+  counters:
+    - name: "Cache Faults/sec"
+      type: "counter" # optional
+```
+
+</details>
+
+<details>
+<summary>Click to expand JSON schema</summary>
+
+```json
+[
+  {
+    "object": "Processor Information",
+    "instances": [
+      "*"
+    ],
+    "instance_label": "core",
+    "counters": [
+      {
+        "name": "% Processor Time",
+        "metric": "windows_performancecounter_processor_information_processor_time",
+        "labels": {
+          "state": "active"
+        }
+      },
+      {
+        "name": "% Idle Time",
+        "metric": "windows_performancecounter_processor_information_processor_time",
+        "labels": {
+          "state": "idle"
+        }
+      }
+    ]
+  },
+  {
+    "object": "Memory",
+    "counters": [
+      {
+        "name": "Cache Faults/sec",
+        "type": "counter"
+      }
+    ]
+  }
+]
+```
+
+#### name
+
+ObjectName is the Object to query for, like Processor, DirectoryServices, LogicalDisk or similar.
+
+The collector supports only english named counter. Localized counter-names are not supported.
+
+#### instances
+
+The instances key (this is an array) declares the instances of a counter you would like returned, it can be one or more values.
+
+Example: Instances = `["C:","D:","E:"]`
+
+This will return only for the instances C:, D: and E: where relevant. To get all instances of a Counter, use `["*"]` only.
+
+Some Objects like `Memory` do not have instances to select from at all. In this case, the `instances` key can be omitted.
+
+#### counters
+
+List of counters to collect from the object. See the counters sub-schema for more information.
+
+#### counters Sub-Schema
+
+##### name
+
+The name of the counter to collect.
+
+##### metric
+
+It indicates the name of the metric to be exposed. If not specified, the metric name will be generated based on the object name and the counter name.
+
+This key is optional.
+
+##### type
+
+It indicates the type of the counter. The value can be `counter` or `gauge`.
+If not specified, the windows_exporter will try to determine the type based on the counter type.
+
+This key is optional.
+
+##### labels
+
+Labels is a map of key-value pairs that will be added as labels to the metric.
+
+### Example
+
+```
+# HELP windows_performancecounter_memory_cache_faults_sec
+# TYPE windows_performancecounter_memory_cache_faults_sec counter
+windows_performancecounter_memory_cache_faults_sec 7.028097e+06
+# HELP windows_performancecounter_processor_information_processor_time
+# TYPE windows_performancecounter_processor_information_processor_time counter
+windows_performancecounter_processor_information_processor_time{core="0,0",state="active"} 8.3809375e+10
+windows_performancecounter_processor_information_processor_time{core="0,0",state="idle"} 8380.9375
+windows_performancecounter_processor_information_processor_time{core="0,1",state="active"} 8.2868125e+10
+windows_performancecounter_processor_information_processor_time{core="0,1",state="idle"} 8286.8125
+windows_performancecounter_processor_information_processor_time{core="0,10",state="active"} 9.720046875e+10
+windows_performancecounter_processor_information_processor_time{core="0,10",state="idle"} 9720.046875
+windows_performancecounter_processor_information_processor_time{core="0,11",state="active"} 9.994921875e+10
+windows_performancecounter_processor_information_processor_time{core="0,11",state="idle"} 9994.921875
+windows_performancecounter_processor_information_processor_time{core="0,12",state="active"} 1.014403125e+11
+windows_performancecounter_processor_information_processor_time{core="0,12",state="idle"} 10144.03125
+windows_performancecounter_processor_information_processor_time{core="0,13",state="active"} 1.0155453125e+11
+windows_performancecounter_processor_information_processor_time{core="0,13",state="idle"} 10155.453125
+windows_performancecounter_processor_information_processor_time{core="0,14",state="active"} 1.01290625e+11
+windows_performancecounter_processor_information_processor_time{core="0,14",state="idle"} 10129.0625
+windows_performancecounter_processor_information_processor_time{core="0,15",state="active"} 1.0134890625e+11
+windows_performancecounter_processor_information_processor_time{core="0,15",state="idle"} 10134.890625
+windows_performancecounter_processor_information_processor_time{core="0,16",state="active"} 1.01405625e+11
+windows_performancecounter_processor_information_processor_time{core="0,16",state="idle"} 10140.5625
+windows_performancecounter_processor_information_processor_time{core="0,17",state="active"} 1.0153421875e+11
+windows_performancecounter_processor_information_processor_time{core="0,17",state="idle"} 10153.421875
+windows_performancecounter_processor_information_processor_time{core="0,18",state="active"} 1.0086390625e+11
+windows_performancecounter_processor_information_processor_time{core="0,18",state="idle"} 10086.390625
+windows_performancecounter_processor_information_processor_time{core="0,19",state="active"} 1.0123453125e+11
+windows_performancecounter_processor_information_processor_time{core="0,19",state="idle"} 10123.453125
+windows_performancecounter_processor_information_processor_time{core="0,2",state="active"} 8.3548125e+10
+windows_performancecounter_processor_information_processor_time{core="0,2",state="idle"} 8354.8125
+windows_performancecounter_processor_information_processor_time{core="0,20",state="active"} 1.011703125e+11
+windows_performancecounter_processor_information_processor_time{core="0,20",state="idle"} 10117.03125
+windows_performancecounter_processor_information_processor_time{core="0,21",state="active"} 1.0140984375e+11
+windows_performancecounter_processor_information_processor_time{core="0,21",state="idle"} 10140.984375
+windows_performancecounter_processor_information_processor_time{core="0,22",state="active"} 1.014615625e+11
+windows_performancecounter_processor_information_processor_time{core="0,22",state="idle"} 10146.15625
+windows_performancecounter_processor_information_processor_time{core="0,23",state="active"} 1.0145125e+11
+windows_performancecounter_processor_information_processor_time{core="0,23",state="idle"} 10145.125
+windows_performancecounter_processor_information_processor_time{core="0,3",state="active"} 8.488953125e+10
+windows_performancecounter_processor_information_processor_time{core="0,3",state="idle"} 8488.953125
+windows_performancecounter_processor_information_processor_time{core="0,4",state="active"} 9.338234375e+10
+windows_performancecounter_processor_information_processor_time{core="0,4",state="idle"} 9338.234375
+windows_performancecounter_processor_information_processor_time{core="0,5",state="active"} 9.776453125e+10
+windows_performancecounter_processor_information_processor_time{core="0,5",state="idle"} 9776.453125
+windows_performancecounter_processor_information_processor_time{core="0,6",state="active"} 9.736265625e+10
+windows_performancecounter_processor_information_processor_time{core="0,6",state="idle"} 9736.265625
+windows_performancecounter_processor_information_processor_time{core="0,7",state="active"} 9.959375e+10
+windows_performancecounter_processor_information_processor_time{core="0,7",state="idle"} 9959.375
+windows_performancecounter_processor_information_processor_time{core="0,8",state="active"} 9.939421875e+10
+windows_performancecounter_processor_information_processor_time{core="0,8",state="idle"} 9939.421875
+windows_performancecounter_processor_information_processor_time{core="0,9",state="active"} 1.0059484375e+11
+windows_performancecounter_processor_information_processor_time{core="0,9",state="idle"} 10059.484375
+```
+
+## Metrics
+
+The perfdata collector returns metrics based on the user configuration.
+The metrics are named based on the object name and the counter name.
+The instance name is added as a label to the metric.