Administer > Manage application monitor templates and component monitors > Create and manage templates

Manage templates

You can create a new template, copy a current template, or manage existing templates. You can access existing templates, assigned monitors, and THWACK via the All Settings > SAM Settings > Manage Templates page.

You may need to log in with an administrator account to perform these actions.

To manage templates, you can:

Create a template

You can create a template through the SAM Settings page or when managing templates. Creating a new template does not include any configured settings beyond the defaults for polling frequency and timeout (300).

To quickly create a template with multiple instance of a component monitor, use the Component Monitor Wizard.

  1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates > Create New Template.
  2. Add general information and settings for the template including the name, description, tags, and polling frequency.
  3. You have two options for adding component monitors. You can select Manually Add Component Monitors (select and add, editing in the template view) or Browse for Component Monitors (opens the Component Monitor Wizard). When added, you can modify the configurations and custom settings per monitor. For details on each monitor, you can access the help link. See Component Monitor Types.

  4. When done, click Submit to save the changes.

Make sure the name of the template does not begin or end with a space. If so, application resources may not list all applications. Edit the template name to remove any extra spaces in the name.

Create a custom template (Example)

The following procedure creates a SolarWinds SAM Application Monitor template that monitors a locally installed SQL Server instance. The template is simplified by using the Windows Service component monitors, a TCP port monitor for your SQL Server, and an HTTP monitor for the local Web Console.

Create an application template with the following component monitors:

  • TCP port component monitor to monitor port 1433, the port through which SolarWinds communicates with the SQL Server.
  • Service component monitors for the following windows services:
    • SolarWinds Alerting Engine
    • SolarWinds Network Performance Monitor
    • SolarWinds Job Engine
    • SolarWinds Job Scheduler
    • SolarWinds Module Engine
    • SolarWinds Syslog Service
    • SolarWinds Trap Service
  • HTTP component monitor to monitor port 80, the port through which you access the SolarWinds Web Console.

Create a SolarWinds Windows service application template

You can create templates specifically for the following SolarWinds Windows services:

  • SolarWinds Network Performance Monitor
  • SolarWinds Job Engine v2
  • SolarWinds Job Scheduler
  • SolarWinds Module Engine
  • SolarWinds Syslog Service
  • SolarWinds Trap Service

When creating the templates, use these instructions with variations based on the services you are monitoring:

  1. On the Web Console, click Settings > All Settings > SAM Settings > Create New Template.
  2. Add general information to the template including a name, description, and tags. Tags are used for searching or opening lists of templates per tag.
  3. Click Add Component Monitor, expand the Network Protocol Component Monitors list, and select TCP Port Monitor. Click Submit to add.
  4. Click Rename and name the TCP port monitor, and click OK.
  5. Ensure the Port Number field corresponds to the port used to communicate with the SolarWinds SQL Server instance. By default, this is port 1433.
  6. Click Add Component Monitor, expand the Process and Service Component Monitors, and check Windows Service Monitor and click Submit.
  7. Click Rename, name the SolarWinds Alerting Engine monitor, and click OK.
  8. Enter or select the credential set to use when accessing the Windows service information.
  9. Enter the name of the SolarWinds Alerting Engine service in the Net Service Name field.
  10. Click Add Component Monitor then expand the User Experience Component Monitors list, and then check HTTP Monitor.
  11. Click Rename, name the HTTP port monitor, then click OK.
  12. Ensure the Port Number field corresponds to the port you use for the SolarWinds Web Console port, then click Submit.

Assign a template to a node

To begin monitoring with templates, you need to assign the application templates and monitors to a node. When assigned and enabled, the template collects and reports on polling data to the node according to the application monitors and configuration settings. To add nodes, see Discover and add network devices.

To assign templates to nodes:

  1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
  2. Check the template(s) to assign, and click Assign to Node.
  3. Specify the node(s) to monitor and click Next.
  4. Enter or select the appropriate credentials.
  5. Click Assign Application Monitors.

Edit a template

Every template, including default SAM templates, can be modified. You can change the name, description, general settings, and application monitors. You can also create a copy of a template and modify the copy.

  1. On the Web Console, click Settings > All Settings > Settings > Manage Templates.
  2. Check an application template and click Edit.
  3. Specify the values for the Polling Frequency and Polling Timeout fields.

    Setting a polling frequency below 30 seconds can result in erratic monitor behavior.

  4. To add a monitor, click Add Component Monitor. Expand and filter through the options to add one or more monitors to the template.
  5. You can edit one or more monitors, update settings per monitor, and more. See Modify and customize monitors for details. To review help information per monitor, use the help option in the web console.
  6. When done, click Submit to save the changes.

Copy a template

You can modify current templates, or create a copy. With copies, you can use a base template from the default templates, imported templates, or templates you created. Using a copy for a new template can make the process much faster than starting a new template without pre-filled monitors and configurations.

The copied templates use the same name of the original name with "- Copy" appended.

If you want to completely modify a current template, use a copy to keep the original.

  1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
  2. Select the application template you want to copy, and click Copy. A new template is added copying all of the application and component monitors, including any configured settings.

Export and import templates

Templates can be exported and imported to share and use between all Orion users. Exporting templates creates a file you can share on thwack with other users.

Ensure the imported file format is XML with .apm-template extension. Unzip templates before importing.

To export to THWACK:

Templates can take about 5 minutes to export to THWACK. If exporting multiple templates, give SAM time to complete the export.

  1. On the Web Console, click Settings > All Settings > SAM Settings, and click Manage Templates.
  2. Browse or select for a template in the list.
  3. Click Import Export > Export to THWACK.
  4. Enter your THWACK account credentials when prompted.

    If you need an account, click Create Account and follow the steps.

    A message displays with the template exporting to THWACK. The template packages into an XML file with an extension .apm-template.

To export to a file:

  1. On the Web Console, click Settings > All Settings > SAM Settings, and click Manage Templates.
  2. Browse or select for a template in the list.

  3. Click Import Export > Export as File, and click Save.

    The template packages into a file with an extension .apm-template. You can also post a zip file of templates if needed.

  4. To share the template, visit the Application Monitor Templates folder on THWACK.
  5. Click Write a document, add a title and description for the template, and attach the .apm-template file.
  6. Add apm_monitoring_templatein the Tags field.
  7. Select Application Monitor Templates in Categories.
  8. Click Publish to post the information and template.

To import templates from THWACK:

  1. On the Web Console, click Settings > All Settings > SAM Settings, and click Manage Templates.
  2. Click the Shared Templates on THWACK tab.

    A page opens and populates with available templates from THWACK.

  3. Search or browse the templates. Select a template file and click Import.

    To view information per template from the authors, click the link for content exchange area on THWACK.

  4. Enter your THWACK account credentials when prompted.

  5. The template imports into the Orion Web Console. Search or browse to locate and edit the template as needed.

    If you import a template with the same name as one of your existing templates, the name of the imported template is modified by appending (n) to the name, where n is an integer.

If you receive an invalid file error, check the file format. The template should be XML code with .apm-template extension. If you are importing a ZIP, unzip the contents then import the template file.

To import templates from file:

You can download templates and import templates from your local computer using the Import option. You can locate these templates on THWACK. If the template is in a .zip file, extract the zip and verify it is XML and has an extension of .apm-template. If not, you will receive an invalid file error.

  1. On the Web Console, click Settings > All Settings > SAM Settings, and click Manage Templates.
  2. Click Import/Export, and click Import.

    A page opens to browse and select the file.

  3. Browse and select the template file from your local drive.
  4. Click Submit.

    SAM checks the file type and format.

  5. The template imports into the Orion Web Console. Search or browse to locate and edit the template as needed.

    If you import a template with the same name as one of your existing templates, the name of the imported template is modified by appending (n) to the name, where n is an integer.

Delete templates

Deleting a template also deletes all of its assigned applications, both modified and unmodified. To speed up user interface interaction, data is not immediately removed from the database, but systematically updated every few minutes in the background.

If you may want to use the template at a later time, export to the template to file to save a backup. You can later import the template from file to add it back into SAM.

  1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
  2. Check the template(s) to delete and then click Delete.
  3. Confirm deletion by clicking Yes.

Tag a template

Tags are descriptive labels that help you classify and sort your application templates on the Manage Application Monitor Templates page. The application templates included in SolarWinds SAM have already been tagged with several descriptive labels you can modify as you see fit.

  1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
  2. Select the templates you want to tag, then click Tags.
  3. Click Add existing tag(s) or select the tags from the list.
  4. Type the tags, separating multiple tag entries with commas, then click Submit.

To remove tags:

  1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
  2. Select the templates you want to tag, then click Tags > Remove Tags.
  3. Select the tags from the list, then click Submit.

Change between 32-bit and 64-bit polling

You should use 64-bit polling on 64-bit OS systems. Using AppInsight applications with 32-bit polling on 64-bit computers via an agent prevents certain performance counters from collecting information.

You may need to log in with an administrator account to perform these changes.

Change to 64-bit polling at the application resource level:

  1. On the Web Console, click My Dashboards > Applications > SAM Summary.
  2. Select an AppInsight Application (Exchange, SQL, IIS) and then click Edit Application Monitor.
  3. Expand Advanced, and then click Override Template.
  4. In the Platform to run polling job field, change the value to x64.
  5. Click Submit.

Change to 64-bit polling at the template level:

  1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
  2. Select an AppInsight application and click Edit.
  3. Expand Advanced, and in the Platform to run polling job on field, change the value to x64.