IIS

• Overview
• Setup
  • Prerequisites
  • Configuration
• Metrics and Tags
  • Default Metrics
  • Default Metric Tags
• Optional Metrics
  • Web Server Metrics
  • Website Metrics
  • Application Pool Metrics

Overview

This plugin collects runtime metrics from Microsoft IIS. The plugin requires Microsoft IIS Administration API to be installed and configured. Plugin gathers information about connections, requests, memory and network statistics, etc. for webserver, application pools and websites. For more information, please refer to IIS Administration API Monitoring.

Setup

The iis plugin is included with the SolarWinds Snap Agent by default, please follow the directions below to enable it for a agent instance.

Prerequisites

This plugin require access token and optionally user credentials to gather status information using IIS Administration API. Please refer to IIS Administration API documentation on how to configure API access.

1
2
3
> $cred = Get-Credential -Credential <API user>
> Invoke-WebRequest -Headers @{"Access-Token"="Bearer <API token>"} -Method GET https://localhost:55539/api/webserver/monitoring/ -Credential $cred | ConvertFrom-Json

Configuration

The agent provides an example configuration file to help you get started quickly. It defines the plugin and task file to be loaded by the agent, but requires you to provide the correct settings for authentication. To enable the plugin:

1. Make a copy of the iis example configuration file iis.yaml.example, renaming it to iis.yaml:

On Windows, using Explorer or PowerShell:

Copy

> copy "C:\ProgramData\SolarWinds\Snap\plugins.d\iis.yaml.example" "C:\ProgramData\SolarWinds\Snap\plugins.d\iis.yaml"

On Linux using command line:

Copy

$ sudo cp /opt/SolarWinds/Snap/etc/plugins.d/iis.yaml.example /opt/SolarWinds/Snap/etc/plugins.d/iis.yaml

2. Update the iis.yaml configuration file with settings specific to your IIS instance, for example:

Copy

1
2
3
4
5
6
7
8
9
10
11
12
collector:
iis:
    all:
        url: "https://localhost:55539"
        token: "oolldxQpEvg3Vj_fRlhVF4-Z9IZgGf5bWM2M2cVEPi1TmOlzjFiGWw"
        username: ""
        password: ""
        domain: ""
load:
    plugin: snap-plugin-collector-aoiis.exe
    task: task-aoiis.yaml

3. Restart the agent:

On Windows command line:

Copy

> net stop swisnapd
> net start swisnapd

On Linux command line:

Copy

$ sudo service swisnapd restart

4. Enable the IIS plugin in the AppOptics UI

On the Integrations Page you will see the IIS plugin available if the previous steps were successful. If you do not see the plugin, see Troubleshooting Linux.

Select the IIS plugin to open the configuration menu in the UI, and enable the plugin.

You should soon see the iis metrics reported to your dashboard.

Metrics and Tags

The tables below outline the default set of metrics collected by the iis plugin along with the optional metrics available.

Default Metrics

By default, plugin collects selected Web Server metrics.

Default Metric Tags

All IIS metrics are tagged with hostname. Instead of using that tag, we recommend using the @host alias. Additionally, all IIS metrics are tagged with IIS webserver ID. Application Pool and Websites metrics are additionally tagged respectively with AppPoolId and WebSiteId .

Optional Metrics

Optinal metrics can be activated by editing the task yaml. For more information please read the SolarWinds Snap Agent configuration article.

Web Server Metrics

Website Metrics

Application Pool Metrics

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.