| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/iis.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml" |
| 4 | sidebar_label: "IIS" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Web Servers and Proxies" |
| 7 | keywords: ['IIS', 'HTTP', 'Web service'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # IIS |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/windows.svg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: windows.plugin |
| 18 | Module: PerflibWebService |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | This collector monitors website requests and logins. |
| 25 | |
| 26 | |
| 27 | It queries the 'Web Service' object 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. | 1 | 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:PerflibWebService]` 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 IIS website |
| 116 | |
| 117 | These metrics refer to the IIS website. |
| 118 | |
| 119 | Labels: |
| 120 | |
| 121 | | Label | Description | |
| 122 | |:-----------|:----------------| |
| 123 | | website | The name of the IIS website. | |
| 124 | |
| 125 | Metrics: |
| 126 | |
| 127 | | Metric | Dimensions | Unit | |
| 128 | |:------|:----------|:----| |
| 129 | | iis.website_traffic | received, sent | bytes/s | |
| 130 | | iis.website_requests_rate | requests | requests/s | |
| 131 | | iis.website_requests_by_type_rate | options, get, post, head, put, delete, trace, move, copy, mkcol, propfind, proppatch, search, lock, unlock, other | requests/s | |
| 132 | | iis.website_active_connections_count | active | connections | |
| 133 | | iis.website_users_count | anonymous, non_anonymous | users | |
| 134 | | iis.website_connection_attempts_rate | connection | attempts/s | |
| 135 | | iis.website_isapi_extension_requests_count | isapi | requests | |
| 136 | | iis.website_isapi_extension_requests_rate | isapi | requests/s | |
| 137 | | iis.website_ftp_file_transfer_rate | received, sent | files/s | |
| 138 | | iis.website_logon_attempts_rate | logon | attempts/s | |
| 139 | | iis.website_errors_rate | document_locked, document_not_found | errors/s | |
| 140 | | iis.website_uptime | uptime | seconds | |
| 141 | |
| 142 | ### Per IIS Application Pool |
| 143 | |
| 144 | These metrics refer to the IIS application pool WAS (Windows Process Activation Service). |
| 145 | |
| 146 | Labels: |
| 147 | |
| 148 | | Label | Description | |
| 149 | |:-----------|:----------------| |
| 150 | | app | The name of the Application Pool. | |
| 151 | |
| 152 | Metrics: |
| 153 | |
| 154 | | Metric | Dimensions | Unit | |
| 155 | |:------|:----------|:----| |
| 156 | | iis.application_pool_current_status | uninitialized, initialized, running, disabling, disabled, shutdown_pending, delete_pending | status | |
| 157 | | iis.application_pool_current_worker_processes | running | processes | |
| 158 | | iis.application_pool_worker_processes_created | created | processes/s | |
| 159 | | iis.application_pool_maximum_worker_processes | created | processes | |
| 160 | | iis.application_pool_recent_worker_process_failures | failures | failures/s | |
| 161 | | iis.application_pool_worker_process_failures | crash, ping, startup, shutdown | failures/s | |
| 162 | | iis.application_pool_recycles | recycles | recycles/s | |
| 163 | | iis.application_pool_uptime | uptime | seconds | |
| 164 | |
| 165 | ### Per IIS W3SCV W3MP |
| 166 | |
| 167 | These metrics refer to the World Wide Web Publishing Service, the service responsible for hosting and serving web content. |
| 168 | |
| 169 | Labels: |
| 170 | |
| 171 | | Label | Description | |
| 172 | |:-----------|:----------------| |
| 173 | | app | Application name. | |
| 174 | |
| 175 | Metrics: |
| 176 | |
| 177 | | Metric | Dimensions | Unit | |
| 178 | |:------|:----------|:----| |
| 179 | | iis.w3svc_w3wp_active_threads | threads | threads | |
| 180 | | iis.w3svc_w3wp_requests_total | requests | requests/s | |
| 181 | | iis.w3svc_w3wp_requests_active | requests | requests | |
| 182 | | iis.w3svc_w3wp_file_cache_mem_usage | used | bytes | |
| 183 | | iis.w3svc_w3wp_files_cache_total | cached_files | files/s | |
| 184 | | iis.w3svc_w3wp_files_flushed_total | file_handles | flushes/s | |
| 185 | | iis.w3svc_w3wp_uri_cache_flushed | cached_uris | flushes/s | |
| 186 | | iis.w3svc_w3wp_total_uri_cached | uri_cache_blocks | blocks/s | |
| 187 | | iis.w3svc_w3wp_total_metadata_cached | metadata_blocks | blocks/s | |
| 188 | | iis.w3svc_w3wp_total_metadata_flushed | metadata_blocks | flushes/s | |
| 189 | | iis.w3svc_w3wp_output_cache_active_flushed_items | used | items | |
| 190 | | iis.w3svc_w3wp_output_cache_memory_usage | used | bytes | |
| 191 | | iis.w3svc_w3wp_output_cache_flushed_total | output_cache_entries | flushes | |
| 192 | |
| 193 |