RiskRanking-Metric¶
Impact of a finding, taken from a metric of the code it is reported in
Required inputs: IR
Adding this rule to the list of active RiskRanking actions creates a rank factor column in the Dashboard. The name of the list entry is shown as the column name.
Which metric is chosen decides what the column expresses: Metric.Fan.In.Call counts call edges while Metric.Number_Of_Calling_Routines counts distinct calling routines.
Possible Messages
This rule has no predefined messages.
Options¶
The following places define options that affect this rule: Analysis-GlobalOptions
max_value¶
max_value : float = 1.0
A maximum below the minimum inverts the scale, for a metric whose high values mean
little impact. The scale is monotonic either way, so a metric that is in range
between two bounds and a violation outside them, the way the min_value
and max_value options of the metric rules mean it, cannot be
expressed.
metric¶
metric : str = ''
rfg_metric_name option of the rule computing it rather than by that
rule's name, for example Metric.Fan.In.Call to rank a finding by how
much code depends on the routine it is in. That rule has to be active, otherwise
the value does not exist and every finding falls back to
missing_value.
min_value¶
min_value : float = 0.0
missing_value¶
missing_value : float | None = 0.5
show_by_default¶
show_by_default : bool = False