Page tree

Skip to end of metadata
Go to start of metadata

Use the BMC Synthetic Transaction SLA Report utility to generate data for building SLA reports. The SLA Report utility aggregates raw data from all collectors that are connected to your App Visibility Portal. You can then use this data to create reports in the reporting tool of your choice. 

The SLA Report utility is included with the installation files of the TEA Agent. 

You can run the utility interactively, with no input on the command line, and the utility prompts you for the necessary parameters; or you can run the utility with all of the parameters included in a single command line.

To run the SLA Report utility interactively

  1. Run the sla_report_tool batch file from the \Disk1\utility\SLAReportTool folder from the TEA Agent installation.
    A command prompt window opens. 
  2. Enter the following required parameters when you are prompted.

    ParameterDescription
    Start TimeStarting time of the time range you want to include in your report data
    Enter one of the following formats:
    • 13-digit time stamp
    • Date in the following format: dd/MM/yyyy
    End TimeEnd time of the time range you want to include in your report data
    Enter one of the following formats:
    • 13-digit time stamp
    • Date in the following format: dd/MM/yyyy

    App Visibility Portal Host Name or IP Address

    Host name or IP address of your App Visibility Portal
    App Visibility Portal port numberPort number of your App Visibility Portal Default value: 8100
    Hierarchy ReportY or N to indicate whether you want to generate mapping and hierarchy files
    Output FormatEnter one of the following values:
    • C—.csv file
    • Z—Zipped .csv file
    • B—Both .csv and zipped .csv

To run the SLA Report utility from a single command line

Open a command prompt and use the following syntax to run the SLA Report utility from the command line:

 

Usage
sla_report_tool -s "<start time>" -e "<end time>" -i "<host name/IP>" -p "<port number>" -r "y/n" -o "c/z/b"

For detailed instructions, use the -h command line option. 

See the previous procedure for details about the parameters.

Note

All of the parameters are mandatory. 

If you omit any parameters, the utility prompts you for the missing parameters as in the interactive mode.

 

Files generated by the SLA Report utility

The utility generates the following files:

  • .csv report—in the \reports folder

    This file is generated if you entered C or B for your output format. The file name is made up of the time stamps of the time range included in the report, separated by an underscore. For example, 1419984000000_1420070400000. The data in the file is aggregated by day, Execution Plan, transaction, and location. A new row is generated for each combination of day, Execution Plan, transaction, and location.
    If problems occur with the report generation, the suffix _warning is added to the report name, for example: if one of your collectors is not responding, the _warning suffix is added. If you see the _warning suffix, review the contents of the SLAReportTool.log file to see details of the problem.

    The report file includes the following data:

    NameDescription
    intervalStartTimeTime stamp of the beginning of the range
    intervalEndTimeTime stamp of the end of the range
    executionPlanIdIdentification number of the Execution Plan
    locationIdIdentification number of the location
    transactionNameName of the transaction
    performanceViolationCountNumber of latency threshold violations that occurred
    availabilityErrorCountNumber of availability errors that occurred
    accuracyErrorCountNumber of accuracy errors that occurred
    executionErrorCountNumber of execution errors that occurred
    goodCountNumber of completed transactions without any problems
    totalCountTotal number of completed transactions
  • Zipped .csv reportin the \reports folder
    This file is generated if you entered Z or B for your output format. The file name is made up of the time stamps of the time range included in the report, separated by an underscore. For example, 1419984000000_1420070400000.
    If problems occur with the report generation, the suffix
    _warning is added to the report name, for example: if one of your collectors is not responding, the _warning suffix is added. If you see the _warning suffix, review the contents of the SLAReportTool.log file to see details of the problem.

  • SLAReportTool.log—in the \log folder
    Log of your SLA Report utility runs. If your report generation encountered problems, you can find more details about them in the log file. Details about new runs of the SLA Report tool are appended to the end of existing file until the log file is full. When the log file is full, a new log file is created. Log file names include a numerical suffix indicating the order of the log files. The system retains a maximum of five log files. Older log files are deleted automatically.
  • hierarchy.csv—in the \hierarchy folder

    The hierarchy file is a flat representation of the hierarchy of the applications, locations, and Execution Plans defined in your system. Each combination of application, location and Execution Plan is unique. In other words, you can only have a specific Execution Plan, associated with a specific application, defined a single time for each location.

    The hierarchy file includes the following data:

    NameDescription
    ApplicationIdIdentification number of the application
    ApplicationNameName of the application
    LocationIdIdentification number of the location
    LocationNameName of the location
    ExecutionPlanIdIdentification number of the Execution Plan
    ExecutionPlanNameName of the Execution Plan
    IntervalTime between executions, in milliseconds Default value is 300000
    isAllActiveFlag indicating whether the Execution Plan is active
  • mapping.csv---in the \hierarchy folder

    The mapping file is a list of corresponding IDs and names, of the applications, locations, and Execution Plans that are defined in your system.

    The mapping file includes the following data:

    NameDescription
    TypeType of entity. Possible values are:
    • Application
    • Location
    • Execution Plan
    IDIdentification number of the entity
    NameName of the entity

Related topics

Retrieving the performance data of monitor instances

Retrieving Presentation Server data with Web services

Developing