The Diagnostics report gathers TestEngine’s logs, configuration info, and other information that may be useful for troubleshooting.
| Tip: |
The diagnostic report does not contain any sensitive information. |
Collected data
Collected dataHide
-
TestEngine logs.
-
Information about TestEngine settings
-
Licensing information
-
A list of external jar libraries in the <TestEngine>/bin and <TestEngine>/lib folders.
-
Java virtual machine options listed in the *.vmoptions> files.
To get the diagnostics report, you can either use the web interface of TestEngine or send a request to the TestEngine API using curl, ReadyAPI, or any other similar tool.
| Note: |
Only administrators can get the diagnostics report. |
Using API
Use the following operation:
GET http:///api/v1/diagnostics
See details on SwaggerHub.
Example
ExampleHide example
Use the following command line:
curl -u "user:Password" -X GET "http://localhost:8080/api/v1/diagnostics"
In this example:
-u user:Password
Authenticates the request with the administrator’s credentials.
-X GET
Specifies the GET method.
"http://localhost:8080/api/v1/diagnostics"
The endpoint of the request.
-
Create a project and import the TestEngine API definition. See Import from SwaggerHub to learn how to do it.
-
Select the GET request to the /api/v1/diagnostics resource:
Click the image to enlarge it.
-
Open the Auth panel.
-
Select the Basic (Built-in) authorization type.
-
Specify admin credentials and select the Authenticate pre-emptively option:
Click the image to enlarge it.
-
Send the request:
Click the image to enlarge it.
-
The response will contain an archive with the report. To download it, open the HTML tab and click Save to file:
Click the image to enlarge it.
Using Web UI
-
Go to the home page of TestEngine:
http://<testengine-host>:<port>/
For example, if TestEngine is installed on your local machine and you run it on the default port, use the following link:
-
Select Diagnostics Report from the user menu, and then click Download Diagnostics Report:
Click the image to enlarge it.
The address and port of your TestEngine installation.
See Also
Audit Log