jslmreport (outputs report data to a CSV file)
- Organization of this page
Function
This command outputs report data, stored in the database, in CSV file format.
Execute this command under the following conditions:
-
ITSLM - Manager version 10-10, or a version of ITSLM - Manager that uses the same data format as version 10-10, has been set up.
-
ITSLM - Manager databases of version 10-00 or earlier have been restored using the overwrite setup.
-
The ITSLM - Manager services JP1/ITSLM - Manager DB Service (service name: HiRDBEmbeddedEdition_JL0) and JP1/ITSLM - Manager Service (service name: JP1_ITSLM_MGR_Service) are running.
If you are in a cluster environment, execute this command on the active server. You cannot execute it on a standby server.
For details about messages displayed during command execution, see 11.3 Messages.
Format
jslmreport -t { service | system | info | overview | graph } -g service-group-name -s service-name -d report-start-date -i { 1day | 1week | 1month | 3months } -o output-file-name [ -f ]
Execution permission
A user account that belongs to the OS's Administrators group
Storage folder
ITSLM-Manager-installation-folder\mgr\bin\
Arguments
-t
Specifies the category of report data to output as a CSV file. One of the following categories can be specified:
-
service
Specify this to output service performance. Note that service cannot be specified if a service that is not subject to service performance monitoring is specified in the -s option.
-
system
Specify this to output system performance.
-
info
Specify this to output availability information.
-
overview
Specify this to output a service availability overview.
-
graph
Specify this to output a performance chart.
-g service-group-name
Specifies the name of the service group to which the target monitored service belongs.
-s service-name
Specifies the name of the target monitored service.
-d report-start-date
Specifies the date from which the report on the target monitored service is to begin. It is specified as follows.
Format |
Details |
---|---|
-d YYYYMMDD |
|
-i
Specifies the report interval for the target monitored service. It is specified as follows:
-
1day
Specify this to output a one-day report.
-
1week
Specify this to output a one-week report.
-
1month
Specify this to output a one-month report.
-
3months
Specify this to output a three-month report.
-o output-file-name
Specifies the name of the output file, as an absolute path, for the report data.
- Output format
-
The first line displays header information, and the second and subsequent lines display data.
The following describes the output format for each data type.
-
The service performance output format is as follows.
Table 9‒7: Service performance output format No.
Header information
Data beginning on line 2
Data details
1
Service_Performance_Start_Date
Start date of the report interval
YYYY/MM/DD (year/month/day)
2
Service_Performance_End_Date
End date of the report interval
YYYY/MM/DD (year/month/day)
3
Service_Performance_Monitored_Target
Monitored target
Name of the selected monitored target
4
Service_Performance_Monitor_Item
Monitor item (unit)
-
Average response time (milliseconds)
-
Throughput (count/second)
-
Error rate (%)
5
Service_Performance_Average
Average#1
-
For average response time:
Total average response time during the report interval number of requests during the report interval (milliseconds)
-
For throughput:
Number of requests during the report interval (excluding requests whose responses timed out before ITSLM - UR could receive them) operation time during the report interval (count/second)
-
For error rate:
(Number of times HTTP status returned an error response during the report interval + number of requests whose responses timed out before ITSLM - UR could receive them) number of requests during the report interval (%)
6
Service_Performance_SLO_Compliance_Ratio
SLO compliance rate#1
(1.0 - duration of overages of a threshold operation time for one month) 100 (%)
7
Service_Performance_VS_Previous_Term
Comparison to a previous period (as a percentage)#2, #3
(Average response time during report interval average response time during comparison period for the report interval - 1.0) 100 (%)
Table 9‒8: Relationship between report interval and previous period to which percentage applies No.
Report interval
Table header
Period used for comparison
1
1 day
Compared to previous day
Day immediately preceding the start date
2
1 week
Compared to previous week
Seven days immediately preceding the start date
3
1 month
Compared to previous month
From the same date in the previous month to the preceding day
4
3 months
Compared to previous quarter
From the same date three months ago to the preceding day
-
-
The system performance output format is as follows.
Table 9‒9: System performance output format No.
Header information
Data beginning on line 2
Data details
1
System_Performance_Start_Date
Start date of the report interval
YYYY/MM/DD (year/month/day)
2
System_Performance_End_Date
End date of the report interval
YYYY/MM/DD (year/month/day)
3
System_Performance_Host
Host
Host name of the selected monitored service
4
System_Performance_Monitored_Target
Monitored target
Name of the monitoring agent contained in the host
5
System_Performance_Monitor_Item
Monitor item (unit)
Name of a monitoring item contained in the monitoring agent
6
System_Performance_Average
Average#1
Average value for the monitoring item
7
System_Performance_SLO_Compliance_Ratio
SLO compliance rate#1
(1.0 - duration of overages of a threshold operation time for one month) 100 (%)
8
System_Performance_VS_Previous_Term
Comparison to a previous period (as a percentage)#2, #3
(Average response time during report interval average response time during comparison period for the report interval - 1.0) 100 (%)
-
The availability information output format is as follows.
Table 9‒10: Availability information output format No.
Header information
Data beginning on line 2
Data details
1
Availability_Info_Start_Date
Start date of the report interval
YYYY/MM/DD (year/month/day)
2
Availability_Info_End_Date
End date of the report interval
YYYY/MM/DD (year/month/day)
3
Availability_Info_Service_Availability
Service availability %#1
(Sum of all operation periods during report interval (sum of all operation periods during report interval + sum of all error periods during report interval) 100) (%)
4
Availability_Info_MTTR
MTTR#2
Sum of all error periods during report interval number of error periods during report interval (minutes)
5
Availability_Info_MTBF
MTBF#2
Sum of all operation periods during report interval number of error periods during report interval (minutes)
-
The service availability overview output format is as follows.
Table 9‒11: Service availability overview output format No.
Header information
Data beginning on line 2
Data details
1
Service_Availability_Overview_Date_And_Time
Date and time#
Date and time an event related to availability monitoring occurred during the report interval
2
Service_Availability_Overview_Event
Event
One of the following events related to availability monitoring that occurred during the report interval:
-
Service recovery
-
Start of service monitoring
-
Stop of service monitoring
-
Service stop
-
-
Performance chart information output to CSV file
The performance chart information output to the CSV file is as follows.
Table 9‒12: Performance chart information output to CSV file No.
Header information
Data beginning on line 2
Data details
1
Date
Date and time
Date and time data acquired from ITSLM. Displayed in the format YYYY/MM/DD hh:mm, based on the ITSLM - Manager's time zone
2
Monitoring item average
Monitoring item average value
Average value for the monitoring item
3
Monitoring item max
Monitoring item maximum value
Maximum value for the monitoring item
4
Monitoring item min
Monitoring item minimum value
Minimum value for the monitoring item
.
.
.
6
Monitoring item average
Monitoring item average value
Average value for the monitoring item
7
Monitoring item max
Monitoring item maximum value
Maximum value for the monitoring item
8
Monitoring item min
Monitoring item minimum value
Minimum value for the monitoring item
- Output character encoding
-
UTF-8 character encoding is used.
-f
Specifies that the output file specified in the -o option is to be overwritten if it already exists.
If this option is omitted and the output file already exists, the command results in an error.
Notes
-
This command's processing and the following operations are mutually exclusive:
-
Registering and deleting monitored services
-
Registering and deleting Web transactions
-
Editing Web transactions (including changing their order)
-
Adding, editing, copying, and deleting report templates
-
Updating configuration information
-
Saving monitoring item settings for system performance
-
Setting up service performance monitoring
-
Setting up system performance monitoring
-
Setting up availability monitoring
If this command is executed while any mutually exclusive processing is underway, the command results in an error and its processing is canceled. Similarly, if an attempt is made to start any mutually exclusive processing while this command is executing, that processing will result in an error and be canceled.
-
-
Do not execute another command while this command is executing, except for the jslmmgrexport command or the jslmminfoget command.
-
The service group name and service name must not begin with a hyphen (-).
-
Nonexistent dates in the report interval are not subject to aggregation in the CSV file. For example, if the report start date is May 31, and the report interval is set to 1 month, the relevant period is from May 31 to June 30, excluding June 31. As a result, the last day of the report interval will be June 29, which is the day preceding June 30, and the report interval will cover May 31 through June 29. The calculations for comparisons to previous periods are handled in the same way.
-
ITSLM retains report data for five years.
-
If the name of a monitoring item includes a comma (,) or a double quotation mark ("), that character is replaced with an underscore (_) in the CSV file.
-
Do not cancel execution of this command by closing the command prompt that is executing this command or by pressing Ctrl+C on the keyboard.
Return value
Return value |
Description |
---|---|
0 |
The CSV file was output successfully. |
1 |
Output of the report to a CSV file failed. |
130 |
Processing was canceled because Ctrl+C was pressed. |
Example
C:\Program Files\HITACHI\JP1ITSLM\mgr\bin\jslmreport -t service -g Group1 -s Service1 -d 20130128 -i 1month -o c:\report.csv -f