Monitoring applications with the Performance Dashboard
Learn how to monitor and improve application performance with the Performance Dashboard.
What you’ll learn
You will learn how to add and enable monitoring to your application. Then, you can run an application and use the Performance Dashboard data to determine whether the application is working harder than it should. By determining which applications are running harder than necessary, the Performance Dashboard can help you find slower applications and detect memory leaks.
- Eclipse, Eclipse Che, IntelliJ, or VS Code
- A Codewind installation
Accessing the Performance Dashboard
- From your IDE, go to the Codewind plug-in and right-click on a project.
- Then, select Performance Dashboard. A window appears that displays the Performance Dashboard.
Project Capabilities Overview
When the Performance Dashboard opens, the Project Capabilities Overview pane is displayed.
The Project Capabilities Overview pane provides the current running state of your project and a summary of load test and metrics-related capabilities that your project can support:
- Project status: Provides current project status.
- Run Load Feature: Provides information about whether load pressure can be applied to your project.
- Live monitoring: Use this information to determine whether you can view live metrics. For example, Appsody projects, by default, protect the metrics endpoints and require authenticated user access. Codewind can automatically configure your project and grant anonymous access to the metrics endpoint to read metrics data. Click Allow anonymous connections to make the required changes to the container and restart the project. You can then use the metrics capabilities. To reprotect the metrics endpoint in your project, revisit the capabilities pane and turn off anonymous access. While the project is being restarted, notifications appear in the dashboard during each phase of the restart.
- Benchmarks: Benchmarks are a collection of completed load test results displayed on a chart and in a table.
You can close and reopen the pane at any time by clicking the Project Capabilities Overview button in the main page navigation bar:
Running a load test
- Click Run Load Test. A Run a new load test window appears.
- [Optional] Add a description for the test.
- Then, click Run. The Running counter begins counting down as load is applied to your application.
- [Optional] If you want to cancel, click X to stop the test.
- When the load is finished, the graph shifts and displays new plot points.
Modifying the load test
- To modify the type of load run, click Edit load run settings. The Load test configuration window appears.
- You can change the following values:
- Method: Choose a GET or POST request.
- Path: Path for your request.
- Requests/second: Change the number of requests per second.
- Concurrent: Choose the number of concurrent tests.
- Duration: Choose the duration of the test in seconds.
- JSON Body: Add custom JSON. The builds include validation, and notifications are sent if the JSON is incorrect.
Viewing test comparisons
The Previous test and Latest test display a comparison between the most recent load test that you ran and the previous load test.
You can edit the test descriptions by clicking the pencil icons and saving your text. The description then appears in the Test history table. Click the pencil or the text to edit the description in the Test history table.
Reading line graphs
- The response time, Response (ms), is selected by default.
- The graph shows the last entry that you selected in the list of counter types, such as Hits, CPU (%), and Memory (MB).
- Hover over a point in the graph to see individual values for the counters. The tooltip displays CPU (%), Memory, HTTP Response, and HTTP Hits.
- A maximum of fifteen minutes of data is shown across all graphs. If the monitored application is producing large amounts of data, the dashboard automatically starts to aggregate the data. The longest time is the value that is plotted.
- If you have five or more snapshots, the zoom bar appears by default. To use the zoom bar, swipe over a section of the graph by using your computer touchpad or use the handles in the zoom bar itself. To remove the handles, click a blank space in the zoom bar.
Use the Performance Dashboard to identify common performance problems:
- Slow HTTP response times on some or all routes
- Lower than expected throughput in the application
- Spikes in demand that cause a slowdown
- Higher than expected CPU usage for the level of throughput or load
- High or growing memory usage that indicates a potential memory leak
- Where time is being spent in your application