IIS-Native
The IIS-Native plugin collects runtime metrics from Microsoft IIS. Plugin gathers information about connections, requests, memory and network statistics, etc. for webserver, application pools and websites.
This plugin replaces the IIS plugin integration.
This integration is only available for Windows platforms.
Setup
The iis-native
plugin is included with the SolarWinds Snap agent when it is installed in a Windows environment. The plugin is disabled by default. To enable the plugin for the Snap agent, set up a task file for the plugin as described under Configuration.
Configuration
The Snap agent includes an example task file to help you get started quickly. This plugin only does not require special settings or credentials to work; instead metrics are gathered from the Windows Performance Counters. To enable and configure the iis-native
task:
-
Make a copy of the iisnative example task file
task-iis-native.yaml.example
, renaming it to task-iis-native.yaml:On Windows, using Explorer or PowerShell:
copy "C:\ProgramData\SolarWinds\Snap\tasks-autoload.d\task-iis-native.yaml.example" "C:\ProgramData\SolarWinds\Snap\tasks-autoload.d\task-iis-native.yaml"
-
Update the
task-iis-native.yaml
task file to define the metrics that should be gathered. Comment out metrics that should not be gathered and uncomment the metrics that should be gathered. -
Restart the agent. Using the Windows command line, enter:
net stop swisnapd net start swisnapd
-
Enable the IISNative plugin in the AppOptics UI.
IISNative Plugin uses the same dashboard as the deprecated IIS plugin.
Select the IIS integration on the Integrations Page and enable the plugin in the configuration menu. If you do not see the IIS plugin integration, see Troubleshooting Windows.
Your dashboard should soon include iis metrics.
Metrics and tags
All of the metrics can be enabled or disabled in task-iis-native.yaml
. The tables below outline the default set of metrics collected by the iis-native
plugin along with the optional metrics available.
All metrics including custom ones are float64
values.
Default metrics
By default, plugin collects selected Web Server metrics.
Namespace | Description |
---|---|
iis.network.total_bytes_recv
|
The number of bytes received since the web server started |
iis.network.total_bytes_sent
|
The number of bytes sent since the web server started |
iis.network.total_connection_attempts
|
The number of client connections that have been attempted since the web server started |
iis.requests.total
|
The number of requests that have been served since the web server started |
iis.cpu.percent_usage
|
The percentage of CPU being used by web server processes |
iis.disk.io_write_operations_sec
|
The number of write operations performed by all webserver processes in the last second |
iis.disk.io_read_operations_sec
|
The number of read operations performed by all webserver processes in the last second |
iis.cache.output_cache_count
|
Current number of items is in the output cache |
iis.cache.file_cache_count
|
Current number of files whose content is in the user-mode cache |
iis.cache.uri_cache_count
|
Number of URI information blocks that are currently in the user-mode cache |
Default metrics tags
By default, all IIS metrics are tagged with hostname
. SolarWinds recommends using the @host
alias instead. Additionally, Application Pool and Websites metrics are tagged with AppPoolId
and WebSiteId
, respectively.
Optional metrics
Optional metrics can be activated by editing the task yaml. For more information seeTask File.
Web Server metrics
Namespace | Description |
---|---|
iis.network.bytes_sent_sec
|
The number of bytes that the web server sent in the last second |
iis.network.bytes_recv_sec
|
The number of bytes that the web server received in the last second |
iis.network.connection_attempts_sec
|
The number of client connections that have been attempted in the last second |
iis.network.current_connections
|
The number of active connections that are open on the web server |
iis.requests.active
|
The number of requests that are currently being processed by the web server |
iis.requests.per_sec
|
The number of requests that have been served in the past second |
iis.memory.handles
|
The number of handles that are currently open in web server processes |
iis.memory.private_bytes
|
The total private bytes being used by all web server processes |
iis.memory.private_working_set
|
The total private working set being used by all web server processes |
iis.cpu.threads
|
The number of threads currently active in web server processes |
iis.cpu.processes
|
The number of processes being used by the web server to process requests |
iis.cpu.system_percent_usage
|
The percentage of CPU being used by the entire system |
iis.disk.page_faults_sec
|
The number of page faults experienced by all webserver processes in the last second |
iis.cache.file_cache_memory_usage
|
Current number of bytes used for the user-mode file cache |
iis.cache.file_cache_hits
|
Number of successful lookups in the user-mode file cache since the web server started |
iis.cache.file_cache_misses
|
Number of unsuccessful look ups in the user-mode file cache since the web server started |
iis.cache.total_files_cached
|
Number of files whose content was ever added to the user-mode cache since the web server started |
iis.cache.output_cache_memory_usage
|
Current number of bytes used for the output cache |
iis.cache.output_cache_hits
|
Number of successful lookups in the output cache since the web server started |
iis.cache.output_cache_misses
|
Number of unsuccessful lookups in the output cache since the web server started |
iis.cache.uri_cache_hits
|
Number of successful look ups in the user-mode URI cache since the web server started |
iis.cache.uri_cache_misses
|
Number of unsuccessful look ups in the user-mode URI cache since the web server started |
iis.cache.total_uris_cached
|
Number of URI information blocks that have been added to the user-mode cache since the web server started |
Website Metrics
Namespace | Description |
---|---|
iis.website.uptime
|
The number of seconds that have elapsed since the web site started |
iis.website.network.bytes_sent_sec
|
The number of bytes that the website sent in the last second |
iis.website.network.bytes_recv_sec
|
The number of bytes that the website received in the last second |
iis.website.network.connection_attempts_sec
|
The number of client connections that have been attempted in the last second |
iis.website.network.current_connections
|
The number of active connections that are open on the website |
iis.website.network.total_bytes_recv
|
The number of bytes received since the website started |
iis.website.network.total_bytes_sent
|
The number of bytes sent since the website started |
iis.website.network.total_connection_attempts
|
The number of client connections that have been attempted since the website started |
iis.website.requests.active
|
The number of requests that are currently being processed by the website |
iis.website.requests.per_sec
|
The number of requests that have been served in the past second |
iis.website.requests.total
|
The number of requests that have been served since the website started |
iis.website.memory.handles
|
The number of handles that are currently open in website processes |
iis.website.memory.private_bytes
|
The total private bytes being used by all website processes |
iis.website.memory.private_working_set
|
The total private working set being used by all website processes |
iis.website.cpu.percent_usage
|
The percentage of CPU being used by website processes |
iis.website.cpu.processes
|
The number of processes being used by the website to process requests |
iis.website.cpu.threads
|
The number of threads currently active in website processes |
iis.website.disk.io_write_operations_sec
|
The number of write operations performed by all website processes in the last second |
iis.website.disk.io_read_operations_sec
|
The number of read operations performed by all website processes in the last second |
iis.website.disk.page_faults_sec
|
The number of page faults experienced by all website processes in the last second |
iis.website.cache.file_cache_count
|
Current number of files whose content is in the user-mode cache |
iis.website.cache.file_cache_hits
|
Number of successful lookups in the user-mode file cache since the website starte |
iis.website.cache.file_cache_memory_usage
|
Current number of bytes used for the user-mode file cache |
iis.website.cache.file_cache_misses
|
Number of unsuccessful look ups in the user-mode file cache since the website started |
iis.website.cache.total_files_cached
|
Number of files whose content was ever added to the user-mode cache since the website started. |
iis.website.cache.output_cache_count
|
Current number of items is in the output cache |
iis.website.cache.output_cache_hits
|
Number of successful lookups in the output cache since the website started |
iis.website.cache.output_cache_memory_usage
|
Current number of bytes used for the output cache |
iis.website.cache.output_cache_misses
|
Number of unsuccessful lookups in the output cache since the website started |
iis.website.cache.uri_cache_count
|
Number of URI information blocks that are currently in the user-mode cache |
iis.website.cache.uri_cache_hits
|
Number of successful look ups in the user-mode URI cache since the website started |
iis.website.cache.uri_cache_misses
|
Number of unsuccessful look ups in the user-mode URI cache since the website started |
iis.website.cache.total_uris_cached
|
Number of URI information blocks that have been added to the user-mode cache since the website started |
Application Pool Metrics
Namespace | Description |
---|---|
iis.app_pool.requests.active
|
The number of requests that are currently being processed by the application pool |
iis.app_pool.requests.per_sec
|
The number of requests that have been served in the past second |
iis.app_pool.requests.total
|
The number of requests that have been served since the application pool started |
iis.app_pool.memory.handles
|
The number of handles that are currently open in application pool processes |
iis.app_pool.memory.private_bytes
|
The total private bytes being used by all application pool processes |
iis.app_pool.memory.private_working_set
|
The total private working set being used by all application pool processes |
iis.app_pool.cpu.percent_usage
|
The percentage of CPU being used by application pool processes |
iis.app_pool.cpu.processes
|
The number of processes being used by the application pool to process requests |
iis.app_pool.cpu.threads
|
The number of threads currently active in application pool processes |
iis.app_pool.disk.io_read_operations_sec
|
The number of read operations performed by all application pool processes in the last second |
iis.app_pool.disk.io_write_operations_sec
|
The number of write operations performed by all application pool processes in the last second |
iis.app_pool.disk.page_faults_sec
|
The number of page faults experienced by all application pool processes in the last second |
iis.app_pool.cache.file_cache_count
|
Current number of files whose content is in the user-mode cache |
iis.app_pool.cache.file_cache_hits
|
Number of successful lookups in the user-mode file cache since the application pool started |
iis.app_pool.cache.file_cache_memory_usage
|
Current number of bytes used for the user-mode file cache |
iis.app_pool.cache.file_cache_misses
|
Number of unsuccessful look ups in the user-mode file cache since the application pool started |
iis.app_pool.cache.total_files_cached
|
Number of files whose content was ever added to the user-mode cache since the application pool started. |
iis.app_pool.cache.output_cache_count
|
Current number of items is in the output cache |
iis.app_pool.cache.output_cache_hits
|
Number of successful lookups in the output cache since the application pool started |
iis.app_pool.cache.output_cache_memory_usage
|
Current number of bytes used for the output cache |
iis.app_pool.cache.output_cache_misses
|
Number of unsuccessful lookups in the output cache since the application pool started |
iis.app_pool.cache.uri_cache_count
|
Number of URI information blocks that are currently in the user-mode cache |
iis.app_pool.cache.uri_cache_hits
|
Number of successful look ups in the user-mode URI cache since the application pool started |
iis.app_pool.cache.uri_cache_misses
|
Number of unsuccessful look ups in the user-mode URI cache since the application pool started |
iis.app_pool.cache.total_uris_cached
|
Number of URI information blocks that have been added to the user-mode cache since the application pool started |