Accessing Web Dashboard
User needs to follow the below mentioned steps to access the Web Dashboard.
- Open the product login window.
2. Enter the Username and Password and click Login. The user logs-in into the system and Product UI window is displayed.
User Permission (Capabilities) Indication
This enhancement indicates the capabilities, which is assigned to a user so that user can have access to this information from all screens. For example, one of the capabilities in which guest user falls in is “ReadOnly”.
Now, the user is able to see the assigned capabilities in the Logged-in user’s button tool-tip.
If that user has multiple capabilities, it is displayed in a comma separated format. The list of capabilities is also displayed for Multi DC environment as well.
Product Home Page Description
Product home page consists of a left pane and a right pane. Left pane contains a menu from where a user can view details on test runs, scenarios, monitors, and various other sections. Using this menu, user can access further sections of the web dashboard and can perform various operations, such as compare test runs, generate reports, access various features of web dashboard, and so on. In the right pane, summary of the important aspects is displayed, be it a release version, CPU usage, memory utilization, or alerts generated in the system.
Left Pane
It contains following menus / sub-menus, and menu items:
View
- Dashboard: This displays the current Dashboard.
- Test Runs: Shows the test runs window.
- Scripts: To launch script manager and create a script.
- Scenarios: To create scenarios.
- Run Time Progress: This shows the run time progress of the test. This is only available when the test is running currently.
- Virtual User Trace: This is used for tracing the users for different group(s).
- Transactions: This displays detailing of all transaction(s) in current test run.
- Show Vector in Title: To view graph with breadcrumb, such as last 1, 2…5.
- Events: This shows all event(s) generated in current test run.
- System Logs: To view system related logs, such as Kubernetes logs, RBU access logs, peripheral device logs, and system events.
- Logs
- Test Output: This shows the test output in browser as well as on panel.
- Debug Trace Log: This displays debug trace logs if Debug feature is enabled in scenario.
- Pause Resume Log: This is used to pause or resume logs (if any).
- Stats: It shows the TCP connection information and is available if test is running currently.
- Application Health: To view application health.
- Application End to End View: To view end to end monitoring approach.
- Geo Map: To view Geo map.
- DB Monitoring: This is a powerful feature to measure the performance of each query contributing in a session execution. It provides complete monitoring of MSSQL queries with insights into SQL activity, wait statistics, databases, support services, Temp DB, and high availability. It enables a user to detect such queries, which are consuming more resources as compare to normal ones. Once identified, user can diagnose the issue and perform corrective measures.
Analytics
- Compare: This feature is used to compare two test runs. User can perform further actions for post compare operation:
- Disable Compare: To disable the comparison applied and back to original form.
- Update Compare: To update the inputs provided for comparison.
- Scenario Difference: This displays scenario difference between current and baseline test run.
- Script Difference: This displays script difference between current and baseline test run.
- Server Signature Difference: This displays server signature used in current test.
- Derived Metrics: This feature is used to create a derived graph from two or more graphs.
Favorites
Favorite allows a user to save current view of Real Time Graphs (RTG). User can create a new profile by saving current view of RTG UI as a profile. If user wants to see current view of graphs next time in Web Dashboard, then user needs to add graphs in favorite. When user loads saved favorite, then all graphs of favorite are displayed in Web dashboard’s graph panel.
Alerts
- Alert Maintenance Window: This window provides alert maintenance configuration to disable generation of alerts at the time of maintenance or server goes down.
- Alert Settings: This is used to enable/disable alert configuration, such as alert mail, capacity/ behavior alert, and thread dump.
- Baseline: In case of behavior alert, alerts are generated based on trends and trends are defined in baseline.
- Alert Policy: This is used to create policy for specified condition and rules.
- Alert Actions: This is used to create actions, such as alert mail, thread dump, and TCP dump.
- Rules: This is used to activate/deactivate/add/delete/update rules.
- Active Alerts: This is used to see generated alerts, such as capacity and behavior alerts.
- Alert History: This is used to see the alerts generated in the past.
- Active Alert Graphs: This is used to generate graphs for active alerts.
- Alert Stats Report: This is used to generate stats report for alerts.
- Alert Action History: It contains details of action taken by alerts, such as SNMP Trap Sent / Email Sent / Cisco Spark Chat sent and so on.
Configuration
- Monitors: To configure the monitors.
- Show Monitors: To view the configured monitors.
- Update Monitors: To update monitors.
- Topology: To configure topology.
- Batch Jobs: To configure batch group and batch jobs.
- Tier Group: To configure tier group list.
- Agent Config: For ND agent configuration.
- Configuration Settings: For various settings, such as dashboard settings, multi-node configuration, show vector in title, and graph tree.
- Color Management: It is used to define the color of the graphs.
- Manage Catalogue: It provides a common platform for the selection of graphs and storing them as a catalogue.
Reports
Reports menu is used to create various types of reports, such as stat report, compare/trend report, hierarchical report, and so on. These reports are generated using templates and have other advanced options to include all or selected metrics. The reporting format may be selected as Word, HTML or Excel. It includes tabular data with or without graphical illustration.
Actions
- Thread Dump: To take thread dump, analyse thread dump, and schedule thread dump.
- Heap Dump: A heap dump is a dump of the state of the Java heap memory. This is useful for analysing the use of memory i.e.an application is making at some point in time so handy in diagnosing some memory issues, and if done at intervals handy in diagnosing memory leaks. User can take heap dump from here.
- Process Dump: To take process dump.
- TCP Dump: This option is used to take the TCP dump.
- Mission Control: It is a property through which user can get thread JVM information for JRocket. This includes two features – Memory Analyzer and Flight Recorder.
- Java Flight Recording: To view all java flight recordings
- Run command: This is used to run command on server.
- Download File: To download a file from the system.
- Import data from Access Log file: This imports data from access log file.
- Update:
- Update User/Session Rate: This updates user/session rate (Online mode only).
- Update Data File: To update data file, it is supported in online mode only.
- Update Running Scenario: To update running scenario (in online mode only).
- Manage Vusers: To manage Vusers, such as start, stop, pause, and so on.
Admin
- Projects: Displays the Project Administration window to add, delete, rename a project / sub-project.
- LDAP Server Settings: To configure LDAP Server settings.
- Servers: DisplaysServer Administration windowto configure a server.
- Settings: To configure module tab settings.
- Manage Controllers: To manage controller with details, such as appliance name, controller name, controller URL, and Service End point IP.
- GIT Settings: To perform GIT Remote Server settings.
- Retention Policy: To configure the data retention / data backup policy (NDE Purge)
- Access Control: To perform identification, authentication and accountability of entities through login credentials including passwords.
- Agent Info: To view machine agent status and application agent status.
- NetHavoc: A feature to implement resilience testing.
Advanced
- Sessions: To view running and executed sessions and perform various operations on the same.
- Design: To design the following components:
- Script
- Scenarios
- Scenario Profile
- IP Management
- Event Definition
- Health Check Monitor
- Test Suite
- Test Case
- Test Report
- JMeter Script
- Transactions: To view all the transactions running in the system and perform various operations on the same.
- Appliance Health: This shows a snapshot / summary of application health in terms of heap memory, CPU utilization, available memory, disk space utilization, and so on.
- System Logs: This displays system logs that include – Kubernetes, RBU Access Logs, Peripheral Device logs, and system events.
- Infrastructure View: This displays performance dashboard that includes details for environment, release, disk usage, inventory, and report. The user can perform various operations within this section.
- Postgres Stats: This displays overall connection stats that includes Max connections, reserved connections, used connections, and available connections. Apart from this, a user can view detailed connection stats based on database and application.
Right Pane
This section provides a summary of the most details related to release, memory, and CPU utilization. It contains following sections:
![]() | Release Details This section provides release details of product, such as release version and build number, the time when the release is installed on the server. It also provides a tabular view where user can see the release details, such as installation date/time, release version, and build number. |
![]() | Test Assets Summary This section provides a summarized and consolidated view of the tests, scripts, and scenarios execution in the system. It contains total tests, achieved tests, locked tests, total scripts, total scenarios, and running tests. |
![]() | Alert Summary In this section, user can view a summary of the alerts, such as date/time when the alert is generated, severity of the alert, such as critical, major, minor and the description of the alert. |
![]() | Tomcat Heap Memory In this section, stats on the total heap memory is displayed. Heap memory is a memory used for dynamic allocations. Used heap memory is displayed (in GB) with blue color, and free heap memory is displayed with yellow color along with its percentage. |
![]() | CPU Utilization Vs Load Average This section displays CPU utilization vs load average in the form of a graph. Various parameters, such as user, system, I/O ae displayed with different colors. The load average among all these is displayed with black color. |
![]() | Available Memory This section displays stats on available memory (in GB) in the form of a graph. Cached memory is displayed with blue color and free memory is displayed with black color. |
![]() | Disk Space Utilization This section provides a summary of the disk space utilization by various directories in the system. It contains information such as total space assigned to a particular directory (in GB), free space, used space, along with used percentage. |
3. User can view the dashboard of an already executed test or a running test. Executed test is the test that has already been executed in the past. A running test is the test that is currently in execution.
To view the dashboard of an existing test and running test, click Total Test(s) section. The Test Run window is displayed. To view all tests, click the Show All button on the top left.
Note:
The limit to choose maximum Test Runs at a time is increased to 400.
4. Please wait for some time, the Web Dashboard is displayed after loading the details.
Layout of Web Dashboard
Web Dashboard consists of top pane, left pane, and bottom pane.
Top Pane
Top pane consists of following sections/specifications/action items:
Section | Icon/Representation | Description |
Screen Navigation | ![]() ![]() | By clicking on these icons, user can navigate to previously navigated screens, such as Home, Test run, Dashboard. User can close a screen using the ![]() |
Current Date & Time | ![]() | This is the current date and time of the system. |
Theme Selection | ![]() | Using this icon, user can select the theme for web dashboard as well as product UI. |
Alerts | ![]() | This displays alerts (capacity and behavior) specification. |
Logged in User Name | ![]() | This shows currently logged-in user name. On clicking the down-arrow, there is an option to logout or view Help. |
Zoom In/Out | ![]() | This icon is used to zoom in/out the screen size. |
Toggle Menu Navigation Panel | ![]() | Clicking this can enable/disable the menu navigation |
Toggle Tree Navigation Panel | ![]() | Clicking this can enable/disable the tree navigation |
Toggle Lower Tabular Panel | ![]() | Clicking this can enable/disable the lower tabular panel |
Navigation Icons | ![]() | This is used to navigate between pages of the web dashboard. |
Monitor Up/Down Status | ![]() | This is used to view the monitor up/down status |
Elapsed Time | ![]() | It is the amount of time that passes from the beginning of an event to its end. |
Last Sample Time | ![]() | This displays the last sample time of the graphs in mm/dd/yyyy hh:mm:ss format. |
Favorite selection | ![]() | This displays currently loaded favorite. User can change the favorite from the drop-down arrow. |
Time Period | ![]() | This displays the time range of graph data as configured by the user. User can also customize the time period. |
View By | ![]() | This displays resolution of the samples i.e. graphs aggregated by a specified interval. User can change the view by from the drop-down arrow. |
Test Run Number | ![]() | This denotes the current test run number. |
Start/Stop/Restart | ![]() | This is used to start/stop/restart test. It is applicable in case test is currently running. |
Pause Test Run | ![]() | Click this icon to pause a test run. Click it again to resume. |
Pause/Resume Data Update | ![]() ![]() | Use these icons to pause/resume data update in test run. It stops updating data in Dashboard but continue running test. Once resume, system captures all the data. |
Advance Settings | There are following options within the Advanced Settings section | |
Monochromatic Colors | ![]() | User can use different shades of one color for multiple graphs. |
Layout Selection | ![]() | User can select layout, such as graph, data, tabular from here. |
Add Widget | ![]() | Use this icon to add widget on the graph panel. |
Add New Layout | ![]() | User can define the metrics (rows X columns) using this icon. |
Save Layout | ![]() | User can save the defined layout using this icon. |
Lower Pane
Lower pane displays data of all the graphs of the selected panel. The data is displayed in Tabular format. It is located at the bottom of the Dashboard GUI.
Following information is displayed in this pane:
- Show/Hide Graph: This column represents the presence of the graph on the widget.
- Graph Number: This column displays the graph serial number.
- Color: This column displays the color of the graph.
- Metric Name: This column represents the metric name.
- Min: This column displays the minimum value of the data sample of the graph.
- Max: This column displays the maximum value of the data sample of the graph.
- Avg: This column displays the average value of the data sample of the graph.
- Last: This column displays the last value of the data sample of the graph.
- Samples: This column displays the total number of samples.
User can perform following actions on the lower panel:
- Download the details in PDF, Excel or Word.
- Configure the columns to show/hide.
- Increase/decrease the size of the panel.
- Hide pagination.
- Filter the graph values on any column.
Multi-Data Center Monitoring
This feature provides users the capability to monitor multiple data centers within a single dashboard. In current days, all the e-commerce applications are moving into multiple data centers to accommodate the application complexity. Now, we have enhanced monitoring capability with the evolution of multi DC in a single dashboard. This advanced technology enables a user to use a single dashboard to monitor multiple data centers. There is a master data center among all the data centers, which allows a user to view the Dashboard of all the data centers.
In the below screen, the metrics are displayed for all data centers:
To view metrics of a particular data center, go to the Data Center drop down list (at the top) and select the required data center from there.
Then, only the metrics of that particular data center is displayed.
Topology is also defined for Multi-DC environment. To view this, go to the graph tree and navigate to the data centers:
In multi-DC environment, there is a group for data centers. Within the data center, there are tiers, servers and instances.
Multi-DC environment support can also be seen in the session window as follows:
In the above image, it can be seen that same session is running at different data centers.
Other features supported in Multi DC:
- Parametrization and Filters on Favorite.
- Lower Panel operations, such as show/hide metrics.
- Zoom Operation for derived Graph.
- Open Merge with Pattern.
- Capability name assigned to logged-in user is displayed in dashboard of Multi-DC in the Logged-in user’s button tooltip. If logged-in user is having multiple capabilities, it is displayed in comma-separated format.
Audit Log
Audit log displays the activity log details of all users. Initially, it displays number of users currently logged in.
In Audit log, entries are populated in audit log files for only those actions of users, which affects user’s object, such as add, edit, update, delete.
Audit log is a separate feature whose permission can be provided to a user, by default user has the permission to see own audit logs. If we assign audit log feature capability to any user, he/she is able to see all the activities performed by user logged in to that machine.
Audit log window displays User, Session Id, IP Address from where user has accessed, Activity Date Time, and Activity description. Every time when user logged in, then a session id is generated. ‘User’ and ‘session id’ group audit log table. Upon expanding any user, displays its multiple sessions. Upon further expansion of any session, activities for that session is displayed.
- By default, audit log window displays logs for a particular duration (such last n hour). More logs can be filtered by applying filter for specified time.
- Active users (which are currently performing some activities i.e. not idle in last one hour) is displayed in a section of User Management.
- Users with Admin capability can force or log out any other user (Users are forcefully logged out if inactive for ‘n’ duration). If same user is trying to log in from different browser or from different IP (Admin can allow access) then system prompts the user about old active session. After confirmation of user, old session is logged out, this allows user to log in new session.
- Session is not having time restrictions, user can also view Logs for specific period. Full session of user can be displayed if any activity lies between applied period.
- System displays complete log for that session. While finding Historical data, system searches for LoggedIn activity. If not found, then user can configure N hours and search for the same. If LoggedIn activity found, then activity is displayed from there to logged out. During that applied period, if LoggedOut session is not available, then go forward N Hours and search for LoggedOut activity. If found, cover all the activities done till LoggedOut otherwise time bound activities are displayed only.
- By default, logs are displayed for last one hour. User can apply any specified time range and view the logs.
- There is a filter provision on each field. User can filter by user, or session id, activity time, or some text in activity description.
View Audit Log
To view the Audit log, navigate to the logged in user, and click the Audit Log option.
This displays the Audit log window with logged in user details, such as user name, IP, and login time:
Upon expanding the record, it displays multiple activities of the user along with the activity time (as shown in below image):
User can select columns to be displayed from the drop-down list.
In addition, there are various options to select the “Group by” functionality, Such as session Id, activity name, activity time, IP, module name, and user name.
Single Sign On (SSO) support through OKTA
With SSO, a user logs in once and gains access to different applications, without the need to re-enter login credentials at each application. There are set of configurations, which need to be done one time in the OKTA and NDE server and after that user needs to login through OKTA. Upon successful authentication through OKTA, user is not prompted to login again until the user session expires. Both Service Provider Initiated and Identity Provider Initiated modes are supported.
Upon requesting a URL, user is navigated to OKTA login UI. Post successful authentication, user is redirected to product UI home page.
Okta integration is also supported with Multi DC.
When a user, who is not part of any group, tries to login the product into default system view, it is redirected to an error page.
For integration of different applications using OKTA, please contact your Cavisson representative.
Security Token based REST calls
This feature allows only an authorized user to access external REST API URLs. To access URLs, user needs to generate a security token, and use it in REST calls for authentication and authorization purpose. Server will validate the token and allow/discard the request. There is an expiration time associated with every security token, which is taken as input while generation of the token. Once token is expired, user will not be able to access the URL with this token. User needs to get/generate a new token for further use.
- To access the Generate Authentication Token window, click the
icon beside the logged in user name, and click the Generate Token option.
2. This displays the Generate Authentication Token window.
3. Enter the duration in HH: MM format and click the Generate button.
4. This generates a token, which is valid for the specified duration. User can generate multiple tokens.
5. To copy the generated token, click the Copy button.