Welcome: Guest | Sign-In
NOTE: This site is no longer maintained. Upgrade to ipMonitor v9 here.

NOTE: This site is no longer maintained. Upgrade to ipMonitor v9 here.
Watch a 4-minute movie about ipMonitor v9!
Knowledge Center > ipMonitor 8.5 Administrator's Guide
Content Generator

A Content Generator is used to format data into messages for Information Alerts. The Event Log, SNMP Trap and File Watching Monitors support the use of Regular Expressions to capture variable data such as:

  • An Event Log description
  • Variable-binding data from an SNMP Trap
  • A line from a log file

Captured data is then passed to a Content Generator for parsing into a message. Additional information relating to the Monitor such as the Event timestamp or the source IP address of a received SNMP Trap can also be included in the message.

Once the message is structured correctly, it may be passed to any number of Alerts that are configured to act on the specific Monitor that triggered the Alert.

A Default Content Generator is included in ipMonitor. Please note that the message generated by the Default Content Generator only contains the number of matches captured by the Monitor in the data source.

You will need to create a user-defined Content Generator to return an Information Alert message in a customized format. Customized messages can be structured for different purposes, for example, for use with email Alerts, text logs or SNMP Traps.

Top of page

Alert Types that Support Information Alert Messages

Within the configuration interface for Alerts, the Notification Content - Information Messages section is used to control output of Information Alert messages. The Send Information Notifications option must be enabled (checked) for the Alert to act on Information Alerts.

Messages formatted by Content Generators are inserted into Alerts by simply adding the following Alert Token in the Information Message Body section:

%generatedcontent%

The following Alert types fully support Information Alert messages:

  • Simple Email
  • Customized Email
  • Net Broadcast
  • Event Log
  • Text Log
  • SNMP Trap

Text Messaging Alerts are limited by the display capabilities of the target device. This should be taken into consideration when creating Content Generators for use with text messaging devices through the following Alerts:

  • SMS Text Message: TAP
  • SMS Text Message: UCP

The following Alerts do not act on Information Alert messages:

  • SMS Numeric Message: TAP
  • SMS Numeric Message: UCP
  • External Process
  • Reboot Server
  • Restart Service

Top of page

Supplemental Content Generator Tokens

The SNMP Trap, Event Log and File Watching Monitors support supplemental Tokens that can be referenced in a Content Generator to provide additional information in the Alert message. These Tokens can be divided into two categories: Numeric Tokens and Property Tokens.

Numeric Tokens
Numeric Tokens allow you to retrieve specific text matches, or 'captures', located by a Regular Expression search. The syntax for Numeric Tokens is: %capture[#]% (ie. %capture[1]% or %capture[2]%).

For example, consider a file watched by the File Watching Monitor, which contains the following entry:

1/30/2006 7:45:08 AM ERROR: The application failed to start. REASON: Required resource myapp.dll could not be located.

Within the File Watching Monitor, the following Regular Expression has been entered:

ERROR\: (.*?) REASON\: (.*?)

In this example:

  • The %capture[1]% Token would resolve to: "The application failed to start."
  • The %capture[2]% Token would resolve to: "Required resource myapp.dll could not be located.".

Assuming an Information Alert was correctly configured, this information would be included in the body of the Alert.

Property Tokens
Property tokens allow you to access additional parameters describing an Event Log entry, a file entry, or an SNMP Trap. The syntax for Property Tokens is %capture[property_name]%.

For example:

%capture[timewritten]%     (Event Log Monitor specific)

%capture[bindings]%     (SNMP Trap Monitor specific)

%capture[offset]%     (File Watching Monitor specific)

The following tables contain the Property Tokens available to the Event Log, File Watching and SNMP Trap Monitors:

Event Log

Content Generator Tokens
Token Name Sample Return Value
%capture[category]%   2
%capture[computername]%   MISWKSTN
%capture[logfile]%   System
%capture[sourcename]%   W3SVC
%capture[timewritten]%   20040209102741.000000-300

SNMP Trap

Content Generator Tokens
Token Name Sample Return Value
%capture[agent-addr]%   10.1.2.3
%capture[community]%   public
%capture[enterprise]%   1.3.6.1.4.1.674.10892.1
%capture[generic-trap]%   enterpriseSpecific (6)
%capture[specific-trap]%   1053
%capture[time-stamp]%   9212200
%capture[1.3.6.1.2.1.1.0]%   Dell OpenManage Temperature
  Status [snmp: trap] is down
%capture[bindings]%   mib-2.system.0: SNMP Trap
  Monitor :: Dell OpenManage
  Temperature Status[snmp: trap]
  is down
%capture[bindings-raw]%   1.3.6.1.2.1.1.0: SNMP Trap
  Monitor :: Dell OpenManage
  Temperature Status[snmp: trap]
  is down

File Watching

Content Generator Tokens
Token Name Sample Return Value
%capture[offset]%   23698

Note: %capture[1.3.6.1.2.1.1.0]% will display the value of the specified OID entered within the square brackets [ ]. A wildcard character (*) cannot be used to specify an OID prefix.

Top of page

Add or Edit a Content Generator

To add or edit a Content Generator, click the Content Generators menu option located in the Alerts section.

A Content Generator contains three elements:

  1. Name: Identifies the Content Generator
  2. Value: Defines the layout of the "captured" data. This will be the format of the Alert message.
  3. Coalesce Separator: specifies the string used to terminate each captured data "element". By default, this is \r\n (CRLF)

Note: When capturing data from an Event Log description, the captured string may already terminate with a CRLF. If an Information Alert "appears" to contain an extra CRLF, this may be the source of the formatting problem.

%capture[#]% Variable Type
The variable type used to parse information captured by Regular Expressions. For example:

New Account Name: %capture[1]%

Variables are enumerated in the same order they are defined in the RegEx. In the example shown above, "New Account Name" is the first variable defined in the RegEx and "Caller Domain" is the last.

When more than one RegEx Search Scenario is configured for a Monitor, variables are enumerated starting in the first Regular Expression and counting through the last Regular Expression. For example:

First Regular Expression: %capture[1]%, %capture[2]%, %capture[3]%
Second Regular Expression: %capture[4]%, %capture[5]%, etc...

%capture[token_name]% Variable Type
The variable type used to parse supplemental Content Generator Tokens. For example:

Event Timestamp: %capture[timewritten]%

For additional examples illustrating how to configure Information Alerts and Content Generators refer to:

Top of page

Additional Resources

For information on other features and concepts related to those discussed in this article, refer to the following ipMonitor resources:

< Back

Last Updated: March 30, 2007 | What did you think of this topic?

Privacy Statement | Terms of Use | EULA | Contact | Site Map

Prices displayed do not reflect international pricing unless otherwise stated. Please see our international price list for current pricing specific to your location. All prices are subject to change without notice.

© 2003-2008 SolarWinds.net, Inc. All Rights Reserved. SolarWinds®, the SolarWinds logo, ipMonitor®, LANsurveyor®, and Orion® are among the trademarks or registered trademarks of the company in the United States and/or other countries. All other trademarks are property of their respective owners.