On this page:
Agents Page
The Agents page shows information about how IncrediBuild is being utilized on various Agent machines in your deployment This helps you gauge how effectively the IncrediBuild infrastructure is being used across your entire deployment process as well as information for specific Agents. You can set filters to specify the parameters for the data represented in the measures displayed on this page.
Page Header
In the Page Header, below "Agent Utilization", the Valid For information is displayed. This shows the date and time of the data represented on this page since it was last refreshed. This is considered to be the current time with respect to the Time Filter set for the page.
Note: You can update the current time manually by refreshing the page. However, refreshing the page will also reset any filters that you have set and return them to their default settings.
Filters
Filters allow you to set the parameters for the data that is shown on the Agents page.
Note: All measures displayed on this page represent only the data within the parameters set from the Agent Filter
Time Filter
The Time Filter enables you to filter the data represented on the Agents page to include only data for the specified time period.
You can set the time filter using one of the preset time range buttons or you can create a custom time range.
The preset time ranges are described in the following table:
Note: In the descriptions below, the Current time refers to the time that the data on the page was last refreshed.
Category | Description |
---|---|
12H | Includes data from builds executed in the 12 hours prior to the current time. |
24H | Includes data from builds executed in the 24 hours prior to the current time. This is the default selection. |
Today | Includes data from builds executed from 00:00 of the current day up to the current time. |
To select one of the preset time ranges:
From the filter pane in the Page Header, click the time range to be applied. Your selection is highlighted in yellow indicating that that time range filter is applied
To set a custom time range:
- Click on Custom
- Pick a Date Range window is displayed:
3. Click on the From Date field.
- A calendar selection window is displayed.
- Select a date.
- The default is set for the current date.
- To select a date from a previous month, click the back arrow on the top of the calendar and then select a date.
- Click OK.
4. Do the same for the end date.
Agents FilterThe Agents filter enables you to filter the data represented on the Agents page to include only builds initiated by a specific group (or groups) of Agents. Agents groups must first be created in the Agents Configuration page before they can be applied to the Agents page (see Configuration Page).
To set the Agents filter:
- Click on the Agents field.
A multi-select list of the Agents Groups is displayed.
2. Click the checkbox next to each of the Agents Groups to be included.
The filter is applied and the selected Agents Groups are now displayed.
Note:
- The default is set to display all Agents available in the IncrediBuild infrastructure.
- If no Agents Groups have been created an option to Add Agents Group is displayed in the Agents drop-down menu.
Agents Key Performance Indicator Summary
The Agents KPI Summary shows aggregated statistics for the KPI measures related to Agent usage in the IncrediBuild infrastructure.
All data represented on the Agents page, including the KPI Summary are based on the parameters set in the Agent Filter. This means that the data presented here may show aggregated of only specific Agents.
The information displayed in the KPI display is explained in the following table:
Category | Item | Description |
|
---|---|---|---|
Value |
| These measures give a rough estimate of the value that you are getting from your IncrediBuild infrastructure in terms of savings in time and cost. |
|
Time Saved | This is a rough estimate of how much longer it would have taken to run all of the build executions if they had been executed without using IncrediBuild (i.e. the builds were run entirely on the Initiator Agents) Note: This measure indicates the Time Saved for the Initiator Agents. This measure relates only to the data of the Initiator Agents, as IncrediBuild only saves time for builds that were initiated by Initiator Agents, this measure represents the time (and cost) saved for Initiator Agents. . Therefore, if the Agents group Group selected in your filter did not initiate any builds during the selected time range the value for this KPI is zero. This calculation is made by taking the aggregate of the core-hours (a core-hour is an hour of utilization of each core, e.g. a 4 core machine running for one hour and fully utilizing all of its cores iswouldFully utilizing all its cores would… be considered to have utilized four core-hours) of utilization of all remote (i.e. Helper) Agents and dividing that by the number of cores on the Initiator Agents. Since usage of the remote Agents is less efficient than usage of the Initiator Agents (because of I/O and Network factors etc.), the result is divided in halfby 1.5. For example, if the Initiator Agent has 4 cores and the build ran for an hour using an additional 12 cores on remote Agents. Then we take the 12 core-hours and divide that by the 4 cores on the Initiator Agent which yields the result of 3 hours. We then take that number and divide it in halfby 1.5 to reach the result that the Time Saved for that build was 1.52 hours. |
| |
Cost Saved | This measure indicates the cost savings you gained by using IncrediBuild. |
| |
Processing Power |
| These measures give an indication of the processing power available in your IncrediBuild infrastructure and to what extent it is being utilized. |
|
Total Licensed Cores | The total number of licensed cores. |
| |
| Average Cores Utilized Per Agent | The average number of cores per Agent being utilized at a given time. |
|
Processing Time |
| These measures indicate the total number of core-hours of execution on local cores (i.e. Initiator cores) and distributed (i.e. remote Helper cores) respectively. A core-hour is an hour of activity of an individual core. For example, if an Agent with 8 cores ran for one hour utilizing all of its cores, the processing time is 8 core-hours. |
|
Local | The total number of core-hours of execution of IncrediBuild tasks on local Agents (i.e. Initiators). |
| |
Distributed | The total number of core-hours of execution of IncrediBuild tasks that were distributed to remote Agents (i.e. Helpers). |
| |
Agent Usage |
| These measures indicate the average percentage of time per Agent that the Agent was in use and available respectively. |
|
Usage Time | The average percentage of time that the Agents were in use either as an Initiator or as a Helper. |
| |
| Available Time | The average percentage of time that the Agents were available for execution of IncrediBuild tasks. Agents are considered to be Available when they are subscribed and connected to the Coordinator (i.e. online). |
Utilization Over Time Graphic Display
This area shows a graphic representation of the Agents KPIs over time. You can select to display the graph for Avg. Cores Utilized, Time Saved or Processing Time (Default: displays Processing Time). For explanation of these measures see Agents KPI Summary. The data displayed for a given point in time relates to all activity that occurred during the time period between the last aggregation of data and the specified time.
Note: The data shown in the graph is aggregated hourly for the last two weeks and daily for earlier dates.
The legend indicating the color of the display for each element is shown at the top of the graph.
You can interact with the display in the following manner:
- Select/Deselect – Click on one of the data elements in the legend to show/hide that element in the display. The default is to display all elements. Therefore, the first time that you click on an element it will hide it.
- Display data – Hover over a point in the graph to create a pop-out display of the specified date and time and the data for that particular point in time.
- Zooming – Drag the cursor over a section of the timeline to zoom in on that time range and display a more granular breakdown of the data over a shorter period of time. To return to the display of the full timeline, click the Reset Zoom button in the top right corner of the graph.
Top Initiators Display
This section shows three bar charts representing either the top or bottom Agents for each of the three measures Agents Page (Copy), Agent Usage and Processing Power. You can select the parameters for the data displayed in these charts from the Page Header. Underneath the title of each chart there is a legend indicating the color of the display for each Agent.
For each chart, you can interact with the display in the following manner:
You can interact with the display in the following manner:
- Select/Deselect – Click on one of the Agent names in the legend to show/hide that Agent for display. The default is to display all Agents. Therefore, the first time that you click on an Agent it will hide it.
Display data – Hover over the bar of an Agent to create a pop-out display of the data for that Agent.
Agents Number Filter
From the Agents Number Filter you can select the number of Agents displayed from the dropdown list (options are: 5,10 or 20). You can also select whether to display the Agents with the top performance or the Agents with the bottom (lowest) performance.
Processing Time
This chart shows data about the amount of time that specific Agents were utilized for execution of IncrediBuild tasks. The bar graph shows the number of core-hours of utilization of the Agent as a Local (i.e. Initiator) Agent and for Distributed tasks (i.e. as a remote, Helper Agent).
Note: The display order of the Top and Bottom Agents is determined based on values for the Overall Processing Time which represents the sum of the Local and Distributed processing times.
The data shown in the pop-out display (which is shown by hovering over an Agent bar) is explained in the following table:
Item | Description |
---|---|
Available Time | The number of core-hours that the Agent was subscribed and connected to the Coordinator. |
Usage Time | The number of core-hours that the Agent was in use executing IncrediBuild tasks.How is this different from 'processing time'? Why are the values shown in the demo so low? In the KPI Usage Time is given in percent and here it is an amount of time, this should be indicated in the names by showing Usage Time [%] in the KPI.The meaning is the same. I believe that we can change the KPIs title but as the value is in %, I don't think it's a must…In the demo it shows up here as an amount of time. Will that be changed? |
Overall Processing Time | The total number of core-hours of utilization of the Agent for execution of IncrediBuild tasks both as a Local (i.e. Initiator) Agent and as a remote (i.e. Helper) Agent. |
Local Processing | The number of core-hours that the Agent executed IncrediBuild tasks for which the Agent itself was the Initiator. |
Distributed Processing | The number of core-hours that the Agent executed IncrediBuild tasks as a remote Helper Agent. |
Licensed Cores | The number of cores in the Agent that are licensed for use with IncrediBuild. |
Avg. Cores Utilized | The average number of cores utilized at a given time while the Agent was in use executing IncrediBuild tasks. This includes utilization both as an Initiator and as a remote Agent. |
Agent Usage
This chart shows data about the amount of time that specific Agents were available and utilized for IncrediBuild. The bar graph shows the number of core-hours that a specific Agent was available (i.e. subscribed and connected to the Coordinator) and the number of core-hours that it was utilized by IncrediBuild.
- The display order of the Top and Bottom Agents is determined based on the values for Available Time.
- The data shown in the pop-out display (which is shown by hovering over an Agent bar) is the same as the data shown in the Processing Time pane.
Processing Power
This chart shows data about the processing power available for specific Agents and how it was utilized for IncrediBuild. The bar graph shows the number of Licensed cores for this Agent and the average number of cores being utilized at a given time.
- The display order of the Top and Bottom Agents is determined based on the values for Avg. Cores Utilized.
- Time during which no Agent is being used by IncrediBuild is not taken into consideration for the Avg. Cores Utilized measure
.
Example:
- if an Agent has 4 cores and during the entire selected time range, and there was only 10 minutes of Agent activity and during the entire 10 minute duration all 4 cores were in use, then the value returned is 4.,
The data shown in the pop-out display (which is shown by hovering over an Agent bar) is the same as the data shown in the Processing Time pane.
Agents Grid
This pane displays detailed information about specific Agents. A list of up to 10 Agents is displayed at a time with a series of columns displaying detailed data about each Agent. Clicking "Expand" will open up a chart with more information regarding that Agent.You can scroll through the rest of the list by clicking the forward and backward arrows below the grid. You can customize the display by selecting which data columns are shown. The builds can be sorted in ascending or descending order in relation to each of the columns. You can view data for a specific Agent shown graphically over time, by clicking on the Agent in the grid.
The data can be accessed in a manner that enables more in-depth analyses by entering Analysis Mode.
Header Filter
From the Header Filter you can select which columns are displayed (for an explanation of the data displayed in each column see Column Definition Table). You can also enter Analysis Mode to enable more in-depth data analyses.
To select which columns are displayed:
1.Click on Columns in the Header Filter
2. A multi-select dropdown list of column categories is displayed. For an explanation of the columns selection, see Column Definition Table.
3.Select the check-box next to each of the columns to be displayed.
4.If a column is selected, you can click the check-box to deselect the column. (Default: the top 6 columns in the list are selected).
5.The selected columns are displayed in the grid.
Note: If there is not sufficient space on the screen to display all of the selected columns then a scrollbar appears below the grid to scroll across to the additional columns.
To enter Analysis Mode:
- Click Analysis Mode from the Header Filter.
Sorting
You can sort the Agents listed in the grid in ascending or descending order for each of the columns.
To sort the Agents listed in the grid:
- Click the up-arrow next to a column title to sort according to the values for that column in descending order (i.e. from highest to lowest).
- Or, click the down-arrow next to a column to sort according to the values for that column in ascending order (i.e. from lowest to highest).
Note: Sorting the grid according to a particular column changes the order in which the Agents are listed, which impacts on the display of the entire grid not just the selected column.
Agent Processing Time Graphic Display
You can click on an Agent to show a graph of the Processing Time for that Agent. This graph shows the number of core-hours of utilization of the Agent as a Local (i.e. Initiator) Agent and for Distributed tasks (i.e. as a remote Agent) shown over time. The graphic display is the same as in the KPI Utilization Over Time Graphic Display, see that section for further explanation about the display and how you can interact with it.
Column Definition Table
Item | Description |
---|---|
Agent | The name of the Agent. |
Local Processing Time | The number of core-hours that the Agent executed IncrediBuild tasks for which the Agent itself was the Initiator. |
Distributed Processing Time | The number of core-hours that the Agent executed IncrediBuild tasks as a remote Helper Agent. |
Usage Time | The percentage of time during which the Agent was executing IncrediBuild tasks either as an Initiator or remote Agent, out of the total time in the selected time range. |
Average Cores Utilized | The average number of cores utilized on the Agent for IncrediBuild tasks, either as an Initiator or as a remote Agent, at a given time. |
Physical Cores | The number of physical cores that the Agent has. |
Available Time | The percentage of time that Agent was available for IncrediBuild tasks (i.e. subscribed and connected to the Coordinator), out of the total time in the selected time range. |
Offline Time | The percentage of time that the Agent was offline (i.e. subscribed, but not connected to the Coordinator), out of the total time in the selected time range. |
IP | The Agent's IP address. |
CPU Speed GHz | The Agent's CPU speed. |