Install and configure the Content Pack for Monitoring Microsoft Windows
Perform the following high-level steps to configure the Content Pack for Monitoring Microsoft Windows:
- Install the content pack on your ITSI search head.
- Create a search macro that includes all indexes you're using for data collection.
- Enable entity discovery to automatically discover entities for which relevant data has been collected.
- Tune KPI base searches
- Tune KPI threshold levels.
- You must be collecting data using a universal or heavy forwarder on each Microsoft Windows server you want to monitor. See Data requirements for the Content Pack for Monitoring Microsoft Windows.
- Take a full backup of your ITSI environment in case you need to uninstall the content pack later. See Create a full backup.
Step 1: Install the content pack
If you're a Splunk Cloud Platform customer, you can install the content pack directly through the ITSI Content Library in a future release. You can also install content packs through the ITSI REST API. If you're an on-premises customer on a version lower than 4.8.0, see Install the content pack in an on-premises instance.
Install the content pack through the REST API
On ITSI version 4.8.x you can use the itoa_interface/content_pack endpoint to install content packs through the ITSI REST API. The endpoint includes GET operations to fetch versioning information and preview the contents of the content pack, and a POST operation to install content packs.
Install the content pack on an on-premises instance
Perform the following steps to install the content pack:
- Download the following ITSI backup file: BACKUP-CP-WIN-OS-1.0.1.zip.
- On your ITSI search head, create a restore job and upload the backup file. For instructions, see Restore from a backup zip file.
- After the restore job completes, confirm that the objects included in the content pack are restored to your environment.
Step 2: Create the index search macro
If you're not collecting data in the default indexes given by the Splunk Add-on for Microsoft Windows, you need to create a new macro with the indexes that you're using for data collection.
- You must have the admin role to create the index search macro.
- You must know the indexes your organization uses to send data to your Splunk platform deployment using the Splunk Add-on for Microsoft Windows.
- From Splunk Web, click Settings > Advanced Search > Search Macros.
- Click New Search Macro.
- Configure the following fields:
Field Value Destination app itsi Name itsi-cp-windows-indexes Definition All of the indexes that you're using for data collection from add-ons combined with OR operators.
(index=windows OR index=perfmon OR index=<index-name>)
- Click Save.
- Configure read/write permissions for the macro:
- For the newly created macro, click Permissions.
- Select All apps (system).
- Give Read access to Everyone.
- Give Write access to admin.
- Click Save.
Step 3: Enable automatic entity discovery
Perform the following steps to ensure that ITSI automatically detects your Microsoft Windows hosts. For best results, perform these steps after you configure one or more hosts to send data to Splunk.
- Navigate to ITSI on the search head.
- Click Configuration > Entities.
- Click Create Entity > Import from Search.
- Select Ad hoc search and enter the following search:
`itsi-cp-windows-indexes` sourcetype=WinHostMon | eval role="operating_system_host" | stats latest(family) as family, latest(version) as version, latest(vendor_product) as vendor_product, latest(role) as itsi_role, latest(cpu_cores) as cpu_cores, latest(mem) as memory, latest(cpu_architecture) as cpu_architecture by host | fields + host, family, version, vendor_product, itsi_role, cpu_cores, memory, cpu_architecture
- Click the search icon to run the search and confirm that one or more hosts are shown with all columns populated.
- Click Next.
- In the Import Column As column, set the host field to
Entity Title. Set all other fields to
Entity Information Field.
- Set Conflict Resolution to
Update Existing Entitiesand set the Conflict Resolution Field to
- Click Import.
- After the import completes, click Set up Recurring Import.
- Name the recurring import ITSI discovery of Windows servers
- Set the frequency based on the needs of your deployment. Use Run on cron Schedule for maximum flexibility.
- Click Submit. ITSI creates the new modular input in
Step 4: Tune KPI base searches
This content pack ships with the following KPI base searches:
Each search runs every five minutes with a 5 minute calculation window, and uses only the latest value on a per-entity basis. The 5 minute calculation window ensures that you won't see N/A for less frequent data. Using the latest value means that the KPI status refreshes as quickly as possible for data collected more frequently.
You must review and tune all base searches to run at a frequency that matches your data collection interval.
Step 5: Tune KPI thresholds
Aggregate KPI thresholds use Normal, Medium, and Low levels, while per-entity thresholds except for available disk space don't exceed Medium. Lower threshold levels for OS-level monitoring allow application-level KPIs to take a more prominent threshold level. For example, a server at 100% CPU isn't a critical issue if the apps running on that server are responding normally.
Aggregate threshold values are calculated for general use only. You must tune these threshold values according to your environment. For more information, see Overview of creating KPIs in ITSI in the Service Insights manual.
Data requirements for the Content Pack for Monitoring Microsoft Windows
Use the Content Pack for Monitoring Microsoft Windows
This documentation applies to the following versions of Splunk® Content Packs for ITSI and IT Essentials Work: current