Skip to content

Commit

Permalink
HPCC-31972 Update Docs for Cost Tracking improvements
Browse files Browse the repository at this point in the history
Signed-off-by: Panagiotatos <[email protected]>
  • Loading branch information
Panagiotatos committed Sep 3, 2024
1 parent 17c5b7b commit ac48215
Showing 1 changed file with 41 additions and 23 deletions.
64 changes: 41 additions & 23 deletions docs/EN_US/ContainerizedHPCC/ContainerizedMods/CustomConfig.xml
Original file line number Diff line number Diff line change
Expand Up @@ -865,35 +865,43 @@ thor: []
using cloud native HPCC Systems platform instances in a cloud setting
where some planning and configuration can help reduce expenses.</para>

<para>Two new columns have been added to the workunits page in ECL Watch.
The columns may be sorted by either cost column, just like the other
columns in ECL Watch, by clicking at the top of the column.</para>

<para>New columns have been added to the workunits and the logical files pages in ECL Watch.
These columns can be sorted by any cost columns, just like the other
columns in ECL Watch, by clicking at the top of the column.
In addition, file operation costs executed by workunits are provided in the workunit’s metrics. </para>
<para>
As the cost tracking matures, the cost calculations also improve significantly providing more accurate cost tracking.
For example, data that was accessed from page cache doesn’t incur any file access cost. HPCC Systems cost tracking now detects data that has been returned from the page cache and adjusts cost calculations appropriately resulting in more accurate cost calculations. </para>
<sect2 id="TypesOfCosts">
<title>Types of Costs</title>

<para>There are three types of costs that are tracked.</para>
<para>There are several types of costs that are tracked.</para>

<para><itemizedlist>
<listitem>
<para>Execution Cost</para>
</listitem>

<listitem>
<para>Storage Cost</para>
<listitem>
<para>Compile Cost</para>
</listitem>

<listitem>
<para>File Access Cost</para>
</listitem>

<listitem>
<para>File Cost at Rest</para>
</listitem>
</itemizedlist></para>

<variablelist>
<varlistentry>
<term>NOTE:</term>

<listitem>
<para>All cost values calculated and displayed are approximate.
<para>While reporting accuracy has significantly improved,
all cost values calculated and displayed remain approximate.
There are many variables that can result in inaccuracies. These
cost values are only intended to be used as a guide.</para>
</listitem>
Expand Down Expand Up @@ -961,7 +969,15 @@ thor: []
<graphic fileref="../../images/SCOST_img3_1.jpg"><!--ADD-IMAGE--></graphic>
</sect4>
</sect3>
<sect3 id="Compile_Costs">
<title>Compile Cost</title>

<para>Compile costs are the costs of compiling the ECL code. The cost
of compiling the ECL code is included as a column in the workunit list. In the workunit summary page
there is a compile cost field.</para>


</sect3>
<sect3 id="StorageCOsts">
<title>Storage Cost</title>

Expand All @@ -985,33 +1001,35 @@ thor: []
Watch. They can only be viewed as part of a cost field in a logical
file’s summary page. That cost field includes other file related
costs.</para>
</sect3>
<para> For logical files, the costs calculated are based on two types of file access. </para>
<itemizedlist>
<listitem>File Access Cost
</listitem>
<listitem>File Cost at Rest
</listitem>
</itemizedlist>

<sect3 id="FileAccessCosts">
<title>File Access Cost</title>

<para>File access costs are the costs of reading and writing to the
files. Many storage planes do have a separate charge for data
operations. The cost of reading and writing to the file will be
operations. The cost of reading and writing to the file is
included in the file access cost value. Any other cost associated with
file operations (such as delete or copy) will not be tracked or
included as part of file access cost at this time.</para>

<para>The file access cost displays as part of the cost field on the
Logical File’s summary page in ECL Watch.</para>


<para>The costs incurred by a workunit for accessing logical files is
also recorded in the workunit’s statistics and attributes. The
read/write cost is recorded at the activity record and cumulated at
the graph, the subgraph and the workflow scope level. The total file
access cost for a workunit is recorded with the workunit and displayed
in the summary page.</para>
the graph, the subgraph, and the workflow scope level.
Cost Tracking detects data that has been returned from the page cache and adjusts cost calculations appropriately to produce more accurate cost calculations.
These file access costs for a workunit are recorded with the workunit and displayed
in the summary page and in the workunit’s metrics.</para>

<para>The new cost field is shown in the Logical File summary page. It
is the combined cost of storing and accessing the data.</para>
<sect4 id="FileCostAtRest"> <title>File Cost at Rest</title>

<para>The cost information is currently only generated for Thor and
hThor jobs.</para>
<para>The File Cost at Rest field is shown in the Logical File summary page. It
is the cost of storing the file without accessing the data. Only the storage costs associated with housing the file in the cloud. This value has been added to better differentiate between file storage costs. </para>
</sect4>
</sect3>
</sect2>

Expand Down

0 comments on commit ac48215

Please sign in to comment.