Documentation forServer & Application Monitor

Create custom templates in SAM

As described in the SAM Administrator Guide, SAM provides out-of-the-box (OOTB) templates that allow you to monitor over 200 applications. You can use those templates as is, modify them, or create a custom template from scratch to monitor uncommon components or applications that are not included in the templates provided with SAM.

In addition to creating your own templates, this guide explains how to:

For reference, here are some good examples of custom templates available in THWACK:

Sample script monitors are provided in the following default folder on the Orion server: C:\Program Files (x86)\SolarWinds\Orion\APM\Sample-Script Monitors.

Disclaimer: Any custom scripts or other content posted herein 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.

Here is an overview of the steps involved in creating custom templates:

Create a template

To create a template with the Component Monitor Wizard:

  1. Navigate to Settings > All Settings > SAM Settings.
  2. Under Getting Started with SAM, click Component Monitor Wizard.
  3. Follow on-screen instructions to add and customize component monitors for the template, and then assign the template to target nodes.

To copy an existing template to create a new template:

  1. Navigate to Settings > All Settings > SAM Settings > Manage Templates.
  2. On the Manage Application Templates page, click the Application Monitor Templates tab.
  3. Select an existing template and click Copy.
  4. After the "Copying application templates" message appears, type "Copy of" in the Search field.
  5. Select the copied template, click Edit, modify as necessary, and save it.

To create a blank template and add component monitors manually:

  1. Navigate to Settings > All Settings > SAM Settings >Create a template.
  2. On the New Template page, provide a name, description, and other details.
  3. Click Add Component Monitors to add each component monitor you want to include.
  4. Click Submit to save your changes.

You can also import a template from THWACK and customize it.

Add component monitors

With the base component monitors added to a new template, add other component monitors as needed per application.

Assign a template to a node Templates assigned to nodes begin collecting data with the next poll, providing specific metrics and data responses based on the component monitors and configurations. For script monitors, the script collects data and returns metrics and values according to the code you enter.

Create a template with the Component Monitor Wizard

The fastest method to create a template with a set of component monitors is with the Component Monitor Wizard. The wizard provides the most common and popular component monitors per platform.

  1. Click Settings > All Settings > SAM Settings.
  2. Under Getting Started with SAM, click Component Monitor Wizard.
  3. On the first tab of the wizard, select a component monitor type to add to your template, such as Windows Service Monitor, and then click Next.

  4. To select a Target server, enter an IP address or browse to an existing node. Provide all required information and click Next to display a list of available processes, services, and performance counters for the server.

  5. On the Select Component tab, select the services you want to add as component monitors for the template, and then click Next.
  6. On the Edit Properties tab, customize each component monitor by selecting its check box and clicking [+].

    When finished customizing component monitors, click Next.

  7. On the Add to Application Monitor or Template tab, select New Application Monitor Template, enter a Name for the template, and click Next.

    Do not begin or end a Name with a space. Otherwise, application monitors based on the template may not appear in widgets. Edit the name to remove extra spaces.

  8. Assign the template to nodes in your environment according to server type, such as Windows.

    Expand and select one or more servers to assign the template.

  9. Review the template and click Submit to save it.

After you create a template, you can add more component monitors, as described next.

Add component monitors

When editing a template, you can add component monitors using either of these options:

  • Manually Add Component Monitors allows you to select and add multiple types of component monitors to the template
  • Browse for Component Monitors opens the Component Monitor Wizard to add multiple instances of a selected component monitor

This scenario uses the Manually Add Component Monitor option.

  1. You have two options for adding component monitors. This scenario uses the Manually Add Component Monitor option.

    • Manually Add Component Monitors allows you to select and add multiple types of component monitors to the template
    • Browse for Component Monitors opens the Component Monitor Wizard to add multiple instances of a selected component monitor

  2. When added, you can modify the configurations and custom settings per monitor.
  3. Select a component monitor, enter a Quantity based on how many copies you want, and click Add.

  4. Expand each component monitor to configure settings, add scripts, and more.

    As you work, click Save and Continue Working to save changes.

  5. When finished adding component monitors, click Submit.

Assign the template to nodes

To begin monitoring with the template, assign it to one or more nodes, thus establishing an application monitor on each node.

  1. Click Settings > All Settings > SAM Settings and click 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.