Regenerate integrations docs (#20506)
Co-authored-by: thiagoftsm <49162938+thiagoftsm@users.noreply.github.com>
Netdata bot committed
Jun 18, 2025 at 07:34 UTC
cc65b86bddd2242b0d27f31895ffe21e980ba984
2 files changed
+153
src/collectors/COLLECTORS.md
+2
@@ -1173,6 +1173,8 @@ If you don't see the app/service you'd like to monitor in this list:
1173
1174
- [IIS](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/iis.md)
1175
1176
+- [MS Exchange](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/ms_exchange.md)
1177
+
1178
- [MS SQL Server](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/ms_sql_server.md)
1179
1180
- [Memory statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/memory_statistics.md)
src/collectors/windows.plugin/integrations/ms_exchange.md
new
+151
@@ -0,0 +1,151 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/ms_exchange.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
+sidebar_label: "MS Exchange"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Windows Systems"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# MS Exchange
12
+
13
+
14
+<img src="https://netdata.cloud/img/exchange.svg" width="150"/>
15
+
16
+
17
+Plugin: windows.plugin
18
+Module: PerflibExchange
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors Microsoft Exchange.
25
+
26
+
27
+It queries different Exchange objects from Perflib in order to gather the metrics.
28
+
29
+
30
+This collector is only supported on the following platforms:
31
+
32
+- windows
33
+
34
+This collector only supports collecting metrics from a single instance of this integration.
35
+
36
+
37
+### Default Behavior
38
+
39
+#### Auto-Detection
40
+
41
+The collector automatically detects all of the metrics, no further configuration is required.
42
+
43
+
44
+#### Limits
45
+
46
+The default configuration for this integration does not impose any limits on data collection.
47
+
48
+#### Performance Impact
49
+
50
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
51
+
52
+
53
+## Metrics
54
+
55
+Metrics grouped by *scope*.
56
+
57
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
58
+
59
+
60
+
61
+### Per Windows Exchange
62
+
63
+These metrics refer to Windows Exchange.
64
+
65
+This scope has no labels.
66
+
67
+Metrics:
68
+
69
+| Metric | Dimensions | Unit |
70
+|:------|:----------|:----|
71
+| exchange.transport_queues_active_mail_box_delivery | active | messages |
72
+| exchange.transport_queues_external_active_remote_delivery | active | messages |
73
+| exchange.transport_queues_internal_active_remote_delivery | active | messages |
74
+| exchange.transport_queues_unreachable | unreachable | messages |
75
+| exchange.transport_queues_poison | unreachable | messages |
76
+| exchange.activesync_ping_cmds_pending | pending | commands |
77
+| exchange.activesync_requests | received | requests/s |
78
+| exchange.activesync_sync_cmds | processed | commands/s |
79
+| exchange.rpc_active_user_count | active | users |
80
+| exchange.rpc_avg_latency | latency | seconds |
81
+| exchange.rpc_connection_count | connections | connections |
82
+| exchange.rpc_requests | processed | requests |
83
+| exchange.rpc_active_user | users | users |
84
+| exchange.rpc_connection | connections | connections |
85
+| exchange.rpc_operations | operations | operations/s |
86
+| exchange.rpc_user_count | users | users |
87
+| exchange.owa_current_unique_users | logged-in | users |
88
+| exchange.owa_requests_total | handled | requests/s |
89
+| exchange.workload_active_tasks | active | tasks |
90
+| exchange.workload_completed_tasks | completed | tasks/s |
91
+| exchange.workload_queued_tasks | queued | tasks/s |
92
+| exchange.workload_yielded_tasks | yielded | tasks/s |
93
+| exchange.workload_activity_status | active, paused | status |
94
+| exchange.http_proxy_avg_auth_latency | latency | seconds |
95
+| exchange.http_proxy_avg_cas_processing_latency_sec | latency | seconds |
96
+| exchange.http_proxy_mailbox_proxy_failure_rate | failures | seconds |
97
+| exchange.http_proxy_mailbox_server_locator_avg_latency_sec | latency | seconds |
98
+| exchange.http_proxy_outstanding_proxy_requests | requests | seconds |
99
+| exchange.http_proxy_requests | requests | seconds |
100
+| exchange.autodiscover_requests | processed | requests/s |
101
+| exchange.avail_service_requests | serviced | requests/s |
102
+
103
+
104
+
105
+## Alerts
106
+
107
+There are no alerts configured by default for this integration.
108
+
109
+
110
+## Setup
111
+
112
+### Prerequisites
113
+
114
+No action required.
115
+
116
+### Configuration
117
+
118
+#### File
119
+
120
+The configuration file name for this integration is `netdata.conf`.
121
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
122
+
123
+The file format is a modified INI syntax. The general structure is:
124
+
125
+```ini
126
+[section1]
127
+ option1 = some value
128
+ option2 = some other value
129
+
130
+[section2]
131
+ option3 = some third value
132
+```
133
+You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
134
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
135
+
136
+```bash
137
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
138
+sudo ./edit-config netdata.conf
139
+```
140
+#### Options
141
+
142
+
143
+
144
+| Name | Description | Default | Required |
145
+|:----|:-----------|:-------|:--------:|
146
+| PerflibExchange | An option to enable or disable the data collection. | yes | no |
147
+
148
+#### Examples
149
+There are no configuration examples.
150
+
151
+