System administration

What is System Administration?

It’s a comprensive set of tools to debug, inspect and record actions on Verne. The list of tools included are:

• Search index
• Batch index
• Query DB and Service transaction repository
• Slow requests
• Log viewer (Not available when running in a cluster)
• Manage Loggers (Not available when running in a cluster)
• System Events (Not available when running in a cluster)
• System Errors (Not available when running in a cluster)
• Repository Events (Not available when running in a cluster)
• Recent requests (Not available when running in a cluster)
• UI Recorder & other tools for testers (Not available when running in a cluster)

Search index

Search index it’s advance users tool that allows users to search the indices on the Database. This tool requires users with experience on Databases and examples on how to use the Index search can be found at Query examples:

Batch index

Allows users to reindex all database by refresh the data in elastic search from Mongo DB. Suppose a user wants to add an attribute into the database we can use the batch index to add that attribute after configuration. Please execute the batch index only when is required. Using this tool can be time expensive if needs to run a full batch index with millions of records.

Users will get a warning once they click the button Run Batch Index

Query DB and Service transaction repository

Query DB tool and service transaction repository are 2 tools are working together to achieve retrieval of data.

Service transaction repository

The service transaction is divided in 3 areas:

• Filters: The filters allow users to filter the records by different options.
• Service transaction View: Allows users to see the transaction on a user-friendly graphical view
• Service transaction raw data: This is the view on how is stored on the Database.

if the result on the service transaction raw data view and the service transaction tree view is small can RIGH-CLICK on the record and open on a new tab

By searching on the filter and click on SHOW RAW QUERY users can generate a Mongo DB query that can be used on Query DB (Raw tool)

The query can be copied to use in Query DB (Raw Tool)

Additional functionality on Service transaction repository

Users can compare 2 service transactions by selecting them using CONTROL+CLICK and selecting RIGHT-CLICK

Query DB (raw)

As we mentioned before this tool can be used in conjunction of Service transaction repository tool to generate queries. In the example above we created a query by searching a record and selecting the button SHOW RAW QUERY. Once we have the query we can paste it on the Query section (You don’t need to delete any existing query just append to the box)

To execute users can RIGHT-CLICK over the query and select Execute Query or press CTRL+ENTER

Generate JSON templates for seed using #LONG_ID# , #MEDIUM_ID#, #SHORT_ID#, #TODAY# (Available on 20210326)

The service transaction inspector provides support to override automatically LONG, MEDIUM, SHORT, TODAY on JSON Path tab. By clicking the checkboxes highlighted below users can override automatically the different types of IDs and dates (TODAY).

Slow Requests

This tab presents a summary of slow requests detected by the system, over a series of time periods. The ability to view the slow requests, along with the current configuration values that define what constitutes a slow request is available. This feature is for advance users.

Log Viewer

Log viewer allow users to inspect the application logs by filter the Level option. This option is useful in case of errors difficult to debug or reproduce.

Manage Loggers

This tool works very closely to Log viewer. Advance users with understanding of Verne architecture can change any Log Level on the packages.

For example if a user want to see only debug messages from Selenium (Which is related to the Hercules framework), they must select debug and after that go to log viewer to see the debug messages raised by the automation framework

Only log specific information

In some circumstances, users want to only see one specific Log and not anything else that’s being generated by the application. The following scenario will only log ExtensionMainController as example:

1.Set catalyst to fatal

2.Set com to Fatal

3.Set rules to Fatal

4. Filter MainController and select trace (Selecting trace will log trace/debug/info/warn/error and fatal)

System Events

To monitor high-level system events. To use this tool the system event users must keep the tool open and open a new tab with the service which want to record. In the example below a user is monitoring the service debug information.

System Errors

Allows users to search for Error ID displayed on the screen

Repository Events

Events related to the Database. Users can see the DB information as it moves in the workflow.

Recent Request

Monitoring the request from UI and REST API. This tool is to be used with the application/api in another tab. This tool can help to identify what happens to the request from the client. Can give access as well to the service transaction inspector.

The channel information can provide insights on the method use for the transaction. On the example above was UI the channel used.

Following the example from UI the next example will be related to REST API. The top result is always the latest one. Users can click the Service link that will redirect to the service transaction inspector