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 |
|
- Administration Methods
- Unified Resource Manager (URM) JMX Methods
- How to Manage UCMDB Licenses Using the JMX Console
- How to Enable Remote Access to the JMX Console
- How to Download a Zip File of Log Files and Thread Dumps
- How to Retrieve UCMDB Server Logs for a Specific Time Frame
- How to Access Support Using the JMX Console
- How to Set Master Keys
- How to Use the User Activity Log
- How to Configure UCMDB Log Levels
- How to Check the Database Connection
- How to View the KPI Dashboard
- How to Enable Validation of Host Header of a Request
- How to Show/Hide the "Cannot invoke trigger" Error Message on UI
- How to View and Track Hotfixes Applied on UCMDB Server
- How to Enable Asynchronous CI History
- How to Enable CI Properties Validation On SDK APIs
- How to Encrypt/Decrypt IP Ranges Information on the Probes
- How to Prevent Custom CI Attributes Values from Being Updated by Default Values During Reconciliation
- How to Configure Maximum Number of Condition Phrases for a Single Node
- How to Enable and Define LDAP Authentication Method
- How to Change the Priority of a User Repository
- How to Restrict User Access to a Limited Subset of the UCMDB Server JMX Methods
- How to Enable Login to Universal CMDB with SAML Authentication
- High Availability Mode JMX Methods
- UCMDB Browser module JMX Methods
- Package Manager JMX Methods
- History DB Services JMX Methods
How to View the KPI Dashboard
You can use the key performance indicator (KPI) dashboard in the JMX console to view the following information of the UCMDB Server:
- Database connection summary
- Discovery processing statistics
- Operations information
Follow these steps to view the KPI dashboard:
-
Launch a web browser and enter the following address: https://localhost:8443/jmx-console.
You may have to log in with a user name and password.
- Locate KPI:service=Dashboard and click the link to open the JMX MBEAN View page.
-
Invoke one of the following methods:
- viewDbConnectionSummary: displays database connection summary
- viewDiscoveryProcessingStatistics: displays discovery processing statistics
- viewOperationsInformation: displays operations information
Note The showHTML option controls if the information is displayed in the HTML or JSON format.
True: the information is displayed in the HTML format
False: the information is displayed in the JSON format
If the database is Oracle, the viewDbConnectionSummary method can gather and display database sessions. To enable this capability, the customer DBA must grant rights to the UCMDB:
- grant select on v_$session to <db_schema>;
- grant select on v_$locked_object to <db_schema>;
- grant select on v_$sqlarea to <db_schema>;
- grant select on v_$transaction to <db_schema>;
The UCMDB Server regularly exports the information displayed in the KPI dashboard into the following folder: UCMDBServer/runtime/log/statistics/metrics_json. The automatic export is performed by a scheduled job: KPI Dashboard Dump, which by default runs hourly. The exported files have names that resemble the following examples:
- DbConnectionSummary2016.05.01-11.30.00.json
- DiscoveryProcessingStats2016.05.01-11.30.00.json
If you want to start or stop this automatic export, use one of the following options:
- Activate or deactivate the KPI Dashboard Dump job from Administration > Scheduler
- Set the statistics.gathering.enabled setting to true (activate) or false (deactivate).
Performance Statistics Dashboard
The UCMDB Server automatically captures performance metrics and saves the data statistically in .csv files under the UCMDBServer\runtime\log\statistics\metrics folder.
The following table explains each column in the .csv files.
Column | Information |
---|---|
t | Timestamp (epoch) |
count | Number of invocations 1 |
max | Max invocation duration 1 |
mean | Average invocation duration 1 |
min | Min invocation duration 1 |
stddev | Standard Deviation of the values |
p50 | 50% quantile 12 |
p75 | 75% quantile 12 |
p95 | 95% quantile 12 |
p98 | 98% quantile 12 |
p99 | 99% quantile 12 |
p999 | 99.9% quantile 12 |
mean_rate | Average event rate (per second) |
m1_rate | Average event rate in the last minutes |
m5_rate | Average event rate in the last 5 minutes |
m15_rate | Average event rate in the last 15 minutes |
rate_unit | Unit for the rate (for example, calls/second) |
duration_unit | Unit for the durations (for example, seconds) |
Note
- All these values are collected since the last metric reset. Every 15 minutes after dumping the statistics to a CSV, the metrics (counters, durations) are reset to 0.
- A quantile is calculated by taking the entire data set, sorting it, and taking the value in the middle (or 1% from the end, for the 99th percentile). For example, the 75% quantile shows the median of the lower 75% values. These quantiles apply to the set of durations of each invocation.
Counters are not reset every 15 minutes, so their values keep growing and show overall counts since the system startup.
How to Define Performance Statistics Gathering Interval
To define the interval (measured in minutes) at which the UCMDB Server gathers performance metrics:
-
In UCMDB, go to Administration > infrastructure Settings Manager > General Settings.
-
Locate Statistics gathering interval setting and specify a time interval in minutes. The default value is 15 minutes.
- Restart the UCMDB Server.
Captured Metrics
The following tables show the captured metrics.
Metrics |
Measurement |
Note |
---|---|---|
data-in.<submodule> | Timer | A breakdown of times in the data in process, by submodule (and submodules of submodules) |
data-in.total | Timer | An overall timer from start to end for the data-in operation |
Metrics |
Measurement |
Note |
---|---|---|
api-executed.<Operation> | Timer | A timer over API requests |
api-failed | Counter | A counter that shows the number of failed API requests |
Metrics |
Measurement |
---|---|
server-sessions | Counter |
Metrics |
Measurement |
---|---|
db-connection-borrowed |
Counter |
db-connection-borrow-failed |
Counter |
db-connection-returned |
Counter |
db-connection-invalidated |
Counter |
Connection timers | Timer |
Metrics |
Measurement |
Note |
---|---|---|
dal-executed.<sql> | Timer | A timer over the execution of a specific, long-running SQL (>1 minute) |
dal-executed | Timer | Overall timer across all DAL executions |
dal-failed | Counter | |
db-rows-updated | Counter | A counter showing how many rows all the SQLs modified |
Metrics |
Measurement |
Note |
---|---|---|
tql-calculation.<tql> | Timer | A timer over the execution of a specific, long-running TQL (>1 minute) |
tql-calculation | Timer | Overall timer across all TQL executions |
tql-results | Timer | Counter for the total amount of CIs returned by TQL queries so far |
Metrics |
Measurement |
Note |
---|---|---|
startup | Timer | A timer over the startup of UCMDB and shows the time needed for the server startup |
Metrics |
Measurement |
Note |
---|---|---|
operation-executed.<"sync"/"async">. <CallerApp>.<OperationName> | Timer |
Timers over specific operations
|
operation-executed."end-to-end" .<"sync"/"async">. <CallerApp>.<OperationName> | Timer | Timers that are over end-to-end operations, meaning the operation in the timer name is the first operation in an operation call stack |
operation-failed | Counter | A counter that shows the number of failed operations |
Metrics |
Measurement |
Note |
---|---|---|
ui-service-executed.<Service> | Timer | Timers over specific UI Server service calls |
ui-service-failed.<Service> | Counter |
Metrics |
---|
"gc" |
"buffers" |
"memory" |
"threads" |
Metrics |
---|
war-context-handler.<context> |
root-handler |
empty-root-handler |
jetty-connections |
Metrics |
---|
utilization |
utilization-max |
size |
jobs |
Metrics | Measurement |
---|---|
merged-cis | Counter |
type_changes | Counter |
merge-operations | Counter |
ignored-from-cmdb | Counter |
ignored-from-bulk | Counter |
updated-objects | Counter |
updated-links | Counter |
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 cms-doc@microfocus.com.
Help Topic ID:
Product:
Topic Title:
Feedback: