| Table of Content Zone |
|---|
|
Agents PageThe Agents page shows information about the utilization of IncrediBuild how IncrediBuild is being utilized on various Agent machines in your deployment. This helps you to gauge how effectively the IncrediBuild infrastructure is being used across your entire deployment process as well as on information for specific Agents. You can set filters to specify the parameters for the data represented in the measures displayed on this page. FiltersFilters allow you to set the parameters for the data that is represented on the Agents page. | Panel |
|---|
|
| borderColor | black |
|---|
| borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
Note: All measures displayed on this page represent only the data within the parameters set from the Agent Filter
Image Removed
In the Page Header, below the TitleImage Added
In the Page Header, below "Agent Utilization", the Valid For information is displayed. This shows the date and time that 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. The data refreshes automatically every hour, assuming that the Time Filter is set for a time range that is dependent on the current time.
| Panel |
|---|
| borderColor | black |
|---|
| borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
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. |
Time Filter
The Time Filter enables you to filter the data represented
Filters
Filters allow you to set the parameters for the data that is shown on the Agents page to include only data for the specified time period.
Image Removed
You can set the time filter | black | | borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
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.
Image Added
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:
| Panel |
|---|
| borderColor | black |
|---|
| borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
Note: In the descriptions below, the Current time refers to the time that the data on the page was last refreshed. |
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:1.Click
- Click on Custom
2.- 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 The 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. The agent group profiles Agents groups must first be created in the Agents Configuration page the Agents Configuration page before they can be applied to the Agents page (see Configuration Link tbdPage).
To set the Agents filter:
- Click on the Agents fieldthe Agents field.
A multi-select list of the Agents Groups is displayed.{pic}
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.
| Panel |
|---|
| borderColor | black |
|---|
| borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
Note: - The default is set to display all AgentsAgents Groups.The default is to display all Agents, not all Agents Groups. There is a difference as a user can create 2 Agent groups in which only 4 Agents out of his 400 will be defined…
If no Agents Agents available in the IncrediBuild infrastructure. - If no Agents Groups have been created an option to Add Agents Group is to Add Agents Group is displayed in the Agents drop-down menu.
|
Agents KPI | Agentskpisummary |
|---|
| Agentskpisummary |
|---|
|
Agents Key Performance Indicator Summary
The Agents KPI Summary shows aggregated statistics for the KPI measures related to agent Agent usage of 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 (relevancy without previous section?). That This means that data for a build Agents, not "a build"is only represented in the measures on this page if the agent was availablebuild was run during the selected time periodThe Agent was available during…, and is included in one of the selected was initiated by the selected Agents Groupsand is included as part of a selected Agents Group.
All measures on this page that measure amounts of time are given in reference to an individual core and not to the agent as a whole. For example, if an agent has 4 cores and executes a task using all 4 cores for one hour the amount of time given for the task execution is 4 hours of core usage, or 4 core-hours.Why is this emphasized here and not in the relevant places? There aren't that many of them…I use the term core-hours throughout the document, which enables me to simplify the definitions. I thought it was important to clarify this point at the beginning of the document?
The information displayed in the KPI display is explained in the following table:
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 AgentsI think it's important to add this because it explains how the calculation is made.)If they had been executed without IncrediBuild. The 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.
Since this calculation is based on a series of assumptions and approximations, the result should be viewed as a rough estimate of the actual time saved.
Note: This measure indicates the Time Saved for the initiator Agents. This measure relates only to the data of the initiator AgentsAs 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.
Note: If the duration of a build extended beyond the time range designated in the filter then the data from that build is represented proportionally to the percentage of the build that was run within the time range. For example, if the designated time range is from 10:00 AM to 11:00 AM and a build ran from 9:00 AM to 11:00 AM then half of the values for that build are represented in the data.These notes are from the dashboard doc for the Agents page, do they also apply to the builds page? Should they be added there? | the data presented here may show aggregated of only specific Agents.
The information displayed in the KPI display is explained in the following table:
| Anchor |
|---|
| KPIUtiization |
|---|
| KPIUtiization |
|---|
|
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 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.
| Panel |
|---|
| borderColor | black |
|---|
| borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
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 graph lines – 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 DisplayAgent Utilization
This section shows three bar charts representing either the top or bottom Agents for each of the three measures Processing Time, 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 agentAgent.
For each chart, you can interact with the display in the following manner:
You can interact with the display in the following manner:
Agents Number Filter
Image Removed
Image Added
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.
| Anchor |
|---|
| Processing Time |
|---|
| Processing Time |
|---|
|
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 Agent as a Local (i.e. initiatorInitiator) agent Agent and for Distributed tasks (i.e. as a remote, Helper Agent).
| Panel |
|---|
| borderColor | black |
|---|
| borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
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:
Available Time | The number of core-hours that the agent was subscribed and connected to the Coordinator. |
Usage Agent bar) is explained in the following table:
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 Agent was available (i.e. subscribed and connected to the Coordinator) and the number of core-hours that it was utilized for by IncrediBuild tasks.
- 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 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 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 Agent is being used by IncrediBuild is not taken into consideration for the Avg. Cores Utilized measure
.
Example:
- if an agent Agent has 4 cores and during the entire selected time range, and there were was only 10 minutes of agent 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 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. I believe it is highly important to note here as well that any row is clickable to show a chart with additional data on the AgentYou 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 Agent shown graphically over time, by clicking on the agent Agent in the grid.
The data can be accessed in a manner that enables more in-depth analyses by entering Analysis Mode.
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.
| Panel |
|---|
| borderColor | black |
|---|
| borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
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).
| Panel |
|---|
| borderColor | black |
|---|
| borderWidth | 1 |
|---|
| borderStyle | dashed |
|---|
|
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 DisplayUtilization Over Time Graphs - Per Agent
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 Agent to display various graphs showing the Agent's processing time, time saved (if the Agent was used as an Initiator) and avg cores utilized. This per-Agent 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