Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Service Health Rules API
- API Group and Sibling Rule
- API Sample Rule
- API Duration-Based Sample Rule
- Create rules with the Rules API
- Define an API rule in the CI Customizations page
- Create a text file-based API rule
- Define an API rule in the rule repository
- Work with tooltip entries
- Write to log files from the Rules API code
- Include a CI property in Rules API calculations
- Examples - API Sample Rule
- Examples - API Group and Sibling Rule
Write to log files from the Rules API code
Within your API rules, you can write to log files from rule methods using a logger object. There are five log levels: debug, info, warn, error and fatal. Each of these uses a specific logger method.
By default, only log method invocations of error and fatal severity are written to the log files. You can modify this within the log configuration files.
-
Within the rule method, implement one of the following methods (listed in ascending order of severity):
-
logger.debug("<API rule name> : log message");
-
logger.info("<API rule name> : log message");
-
logger.warn("<API rule name> : log message");
-
logger.error("<API rule name> : log message");
-
logger.fatal("<API rule name> : log message");
-
The Rules API log files are found in the
<OMi_HOME_DPS>/log/marble_supervisor/RulesAPI
directory. -
groupAndSiblingRule.log (for API Group and Sibling rules)
-
sampleRule.log (for API Sample rules)
-
durationBasedSampleRule.log (for API Duration-Based sample rules)
Type the name of your API rule inside the log message to identify each log message with its source rule.
Open one of the following files to view the log messages (depending on your rule type):
-
By default, only log method invocations of error and fatal severity are written to log files. To modify this setting, open the log configuration file located in
<OMi_HOME_DPS>/conf/core/Tools/log4j/marble_supervisor/dashboard_rules.properties
. -
In the line corresponding with your rule type, replace the string ${loglevel} with the severity level you want logged (either DEBUG, INFO, WARN, ERROR, or FATAL). Edit one of the following lines, depending on your rule type:
-
Group and Sibling rules: log4j.category.com.mercury.am.rules.dashboard.blDashboardRules.
simplifiedRule.groupAndSiblingRule.DashboardGroupAndSiblingRule = ${loglevel}, bam.app.rules.api.group.appender -
Sample rules: log4j.category.com.mercury.am.rules.dashboard.blDashboardRules.
simplifiedRule.leaf.DashboardSimplifiedSampleBasedRule = ${loglevel}, bam.app.rules.api.leafsample.appender -
Duration-Based Sample rules: log4j.category.com.mercury.am.rules.dashboard.blDashboardRules.
simplifiedRule.leaf.DashboardSimplifiedTimeBasedRule = ${loglevel}, bam.app.rules.api.leafduration.appender
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: