Lead your team forward
OCT 24 / 9AM ET Register nowPerformance File
A plan performance file lets you pass individual Runtime Properties to specific steps in a plan.
A performance file has a .perf
extension and must have the same name as the plan file to which it is applied.
Concept
Each step can use different properties and many properties are shared among the steps. However, you often want to use different values for different instances of steps. Therefore, the performance settings file makes it possible to define rules which contain properties and can be applied only to selected steps.
If several rules can be applied to a step, then the last rule in the file is applied first. In some more complicated steps, it might be necessary to set different values for one property. This means that properties can have named subproperties.
File format
The first element <defaultSettings>
contains default rules and then specific rules are listed in the <rules>
element.
The parallelism level for the Filter step can be expressed either as fixed number of threads or as a relative float number. For the relative value, the number of threads is computed as the number of CPUs multiplied by the relative value.
Each rule except the default ones is matched either by the ID step matcher or class step matcher or both. The matcher is defined by a regular expression.
.perf
file format<?xml version="1.0"?>
<performanceSettings version="1.0">
<defaultSettings>
<fixedParallelismLevel>2</fixedParallelismLevel>
<runtimeProperties>
<property name="prop1" value="1000k" />
<property name="prop2" value="val" />
</runtimeProperties>
</defaultSettings>
<rules>
<stepRule classMatch=".*Test.*Step" idMatch="(s2|s3)">
<runtimeProperties>
<relativeParallelismLevel>2</relativeParallelismLevel>
<property name="prop1" value="10m" />
<property name="prop3" value="10kB" />
</runtimeProperties>
</stepRule>
<stepRule idMatch="s2">
<runtimeProperties>
<property name="prop1" value="1_000" />
<subProperties elementNameMatch="a">
<property name="prop1" value="10" />
<subProperties elementNameMatch="b">
<property name="prop2" value="val_b" />
</subProperties>
</subProperties>
</runtimeProperties>
</stepRule>
</rules>
</performanceSettings>
Errors and debugging
The performance settings file must be a well-formed XML file.
Errors in the performance settings file (except XML errors) do not prevent the plan from running, but they are reported in the logs (see Logging Configuration).
To report the properties used by particular steps, logging must be set up to display DEBUG
messages.
Was this page useful?