@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 157 lines 4.76 KB
Rendered Raw
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/Collectors/Applications"
7 keywords: ['windows', 'microsoft', 'exchange', 'mail']
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 ## Setup
53
54
55 ### Prerequisites
56
57 No action required.
58
59 ### Configuration
60
61 #### Options
62
63
64
65
66
67 | Option | Description | Default | Required |
68 |:-----|:------------|:--------|:---------:|
69 | update every | Data collection frequency. | 10 | no |
70
71
72
73
74 #### via File
75
76 The configuration file name for this integration is `netdata.conf`.
77 Configuration for this specific integration is located in the `[plugin:windows:PerflibExchange]` section within that file.
78
79 The file format is a modified INI syntax. The general structure is:
80
81 ```ini
82 [section1]
83 option1 = some value
84 option2 = some other value
85
86 [section2]
87 option3 = some third value
88 ```
89 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
90 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
91
92 ```bash
93 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
94 sudo ./edit-config netdata.conf
95 ```
96
97 ##### Examples
98 There are no configuration examples.
99
100
101
102 ## Alerts
103
104 There are no alerts configured by default for this integration.
105
106
107 ## Metrics
108
109 Metrics grouped by *scope*.
110
111 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
112
113
114
115 ### Per Windows Exchange
116
117 These metrics refer to Windows Exchange.
118
119 This scope has no labels.
120
121 Metrics:
122
123 | Metric | Dimensions | Unit |
124 |:------|:----------|:----|
125 | exchange.transport_queues_active_mail_box_delivery | active | messages |
126 | exchange.transport_queues_external_active_remote_delivery | active | messages |
127 | exchange.transport_queues_internal_active_remote_delivery | active | messages |
128 | exchange.transport_queues_unreachable | unreachable | messages |
129 | exchange.transport_queues_poison | unreachable | messages |
130 | exchange.activesync_ping_cmds_pending | pending | commands |
131 | exchange.activesync_requests | received | requests/s |
132 | exchange.activesync_sync_cmds | processed | commands/s |
133 | exchange.rpc_active_user_count | active | users |
134 | exchange.rpc_avg_latency | latency | seconds |
135 | exchange.rpc_connection_count | connections | connections |
136 | exchange.rpc_requests | processed | requests |
137 | exchange.rpc_active_user | users | users |
138 | exchange.rpc_connection | connections | connections |
139 | exchange.rpc_operations | operations | operations/s |
140 | exchange.rpc_user_count | users | users |
141 | exchange.owa_current_unique_users | logged-in | users |
142 | exchange.owa_requests_total | handled | requests/s |
143 | exchange.workload_active_tasks | active | tasks |
144 | exchange.workload_completed_tasks | completed | tasks/s |
145 | exchange.workload_queued_tasks | queued | tasks/s |
146 | exchange.workload_yielded_tasks | yielded | tasks/s |
147 | exchange.workload_activity_status | active, paused | status |
148 | exchange.http_proxy_avg_auth_latency | latency | seconds |
149 | exchange.http_proxy_avg_cas_processing_latency_sec | latency | seconds |
150 | exchange.http_proxy_mailbox_proxy_failure_rate | failures | seconds |
151 | exchange.http_proxy_mailbox_server_locator_avg_latency_sec | latency | seconds |
152 | exchange.http_proxy_outstanding_proxy_requests | requests | seconds |
153 | exchange.http_proxy_requests | requests | seconds |
154 | exchange.autodiscover_requests | processed | requests/s |
155 | exchange.avail_service_requests | serviced | requests/s |
156
157