IBM WebSphere Liberty Policies
This section provides details of the supplied IBM WebSphere Liberty policies and events to enable you to customize them for your specific environment.
If you simply want to get started using the policy as quickly as possible (with no customization), see Getting-started-with-policies. In order to gain a better understanding of policies, see Policy architecture.
Policy and Event Pack Content
This particular Policy and Event Pack contains a series of Triggers, Action Pipelines, and Templates for detecting and notifying you of events related to IBM WebSphere Liberty technology as monitored by MVMM. While this documentation does not provide true documentation of each trigger, a few words on naming conventions should help you to understand.
The heart of the Policy and Event Pack is a series of Triggers to detect various key conditions on IBM WebSphere Liberty objects as monitored by MVMM. The naming convention for Policy and Event Pack Triggers is Technology_ObjectType_TriggerCondition. Thus, the WebSphere_Liberty_QueueDepthOver90Pct trigger detects the condition where a queue depth is over 90% of it's maximum size.
For each Trigger, there are three provided Templates offering different notification mechanisms. Templates of the form TriggerName_BEM will send an event message (via msend) to BMC Event Manager when the TriggerName condition is met. (Note that this uses the BEM_Generic Action Pipeline and does require the configuration of the integration between the MVMM Server and a BEM Cell in order to operate.) Templates of the form TriggerName_Console will produce an alert in the Middleware Monitor Console Event pane when the TriggerName condition is met using the standard console Alert Action Pipeline (part of the base MVMM product). (Note that some triggers use Delta conditions that preclude the use of Console Alerts. For those triggers, no TriggerName_Console template is provided.) Finally, templates of the form TriggerName_LogToFile will append an event message to the specifiied log file (logToFile_Generic.log in the MVMM home directory by default) when the TriggerName condition is met.
Event Triggers and Templates
There are many triggers and templates, to obtain a list of the triggers and templates contained in this zip use the following command being careful to use the -n option to prevent an actual import. It is recommended you redirect the output to a file and use an editor to search for desired triggers or templates. Both the triggers and templates follow a naming convention beginning with WebSphere_Liberty_<object type>_<trigger condition>.
Agent Policies
- WebSphere_Liberty_Agents_ALL_BEM
- WebSphere_Liberty_Agents_ALL_Email
- WebSphere_Liberty_Agents_All_LogToFile
- WebSphere_Liberty_Agents_Basic
Using the Policy and Event Pack
The Policy and Event Pack contains a zip file produced by mqsexport. To use the Policy and Event Pack objects run the mqsimport command. Depending on which portions of the Policy and Event pack you want to use, the command may vary. It is assumed that you will have knowledge of the mqsimport command to customize, but below are some sample commands:
To import the entire Policy and Event Pack, use the following command:
mqsimport --policy-read-only Samples/EventPacks/Liberty/Liberty_EventPack.zip SATo import no policies and all the event triggers and templates, use the following command:
mqsimport --event-template WebSphere_Liberty_.* --event-trigger WebSphere_Liberty_.* Samples/EventPacks/Liberty/Liberty_EventPack.zip SATo import all templates and triggers for a specific object type, use the following command (sample for a Queues):
mqsimport --event-template WebSphere_Liberty_Queue.* --event-trigger WebSphere_Liberty_Queue.* Samples/EventPacks/Liberty/Liberty_EventPack.zip SA
To import all triggers but only the templates associated with a particular action, use the following command (sample for BEM):
mqsimport --event-action-pipeline ._Generic --event-template WebSphere_Liberty_.*BEM --event-trigger WebSphere_Liberty.* Samples/EventPacks/Liberty/Liberty_EventPack.zip SATo import one specific trigger and template, use the following command (sample for WebSphere_Liberty_MsgEngineStoppedOrFailed_BEM):
mqsimport --event-action-pipeline BEM_Generic --event-template WebSphere_Liberty_MsgEngineStoppedOrFailed_BEM --event-trigger WebSphere_Liberty_MsgEngineStoppedOrFailed Samples/EventPacks/Liberty/Liberty_EventPack.zip SA
WebSphere_Liberty_Agents_Minimal
This Policy and Event Pack does not contain this agent policy.
WebSphere_Liberty_Agents_Basic
This agent policy references the WebSphere_Liberty_POLICY_Basic policy group.
This Object Policy Group contains object policies for all the Liberty objects. These policies apply policy actions to register a set of objects for monitoring and activates history collection for the key attributes using the rules defined in the SAMPLE history template for each object type. No event templates from the Policy and Event Pack are associated with these objects.
WebSphere_Liberty_Agents_Standard_NNN
This Policy and Event Pack does not contain these agent policies. As this extension is new in this release, feedback is welcome on what you believe should exist in the standard Liberty agent policy.
WebSphere_Liberty_Agents_ALL_NNN
This agent policy references the WebSphere_Liberty_POLICY_ALL_NNN policy group.
This Object Policy Group contains object policies for all the Liberty objects. These policies apply policy actions to a set of objects for monitoring and activates history collection for the key attributes using the rules defined in the SAMPLE history template for each object type. All event templates from the Policy and Event Pack are associated with these objects. Review the templates as generally, all the thresholds for each of these events is customizable. As all objects and event templates are used with this policy, it is intended for smaller Liberty installations where you can determine a proper subset for your production environment.
Where to go from here
Now that you have imported the Policy and Event Pack for this technology, go to Getting started with policies to enable them.