docs/layouts/shortcodes/generated/trace_configuration.html

<table class="configuration table table-bordered">
    <thead>
        <tr>
            <th class="text-left" style="width: 20%">Key</th>
            <th class="text-left" style="width: 15%">Default</th>
            <th class="text-left" style="width: 10%">Type</th>
            <th class="text-left" style="width: 55%">Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><h5>traces.checkpoint.span-detail-level</h5></td>
            <td style="word-wrap: break-word;">SPAN_PER_CHECKPOINT</td>
            <td><p>Enum</p></td>
            <td>Detail level for reporting checkpoint spans. Possible values:
<ul><li>'<code class="highlighter-rouge">SPAN_PER_CHECKPOINT</code>' (default): Single span per checkpoint. Aggregated sum/max for sub-metrics from all tasks and subtasks per checkpoint.</li><li>'<code class="highlighter-rouge">SPAN_PER_CHECKPOINT_WITH_TASKS</code>': Single span per checkpoint. Same as '<code class="highlighter-rouge">SPAN_PER_CHECKPOINT</code>', plus arrays of aggregated values per task.</li><li>'<code class="highlighter-rouge">CHILDREN_SPANS_PER_TASK</code>': Same as '<code class="highlighter-rouge">SPAN_PER_CHECKPOINT</code>' plus children spans per each task. Each task span with aggregated sum/max sub-metrics from subtasks.</li><li>'<code class="highlighter-rouge">CHILDREN_SPANS_PER_SUBTASK</code>': Same as '<code class="highlighter-rouge">CHILDREN_SPANS_PER_TASK</code>' plus children spans per each subtask. Child spans for tasks and grand-child spans for subtasks.</li></ul><br /><br />Possible values:<ul><li>"SPAN_PER_CHECKPOINT"</li><li>"SPAN_PER_CHECKPOINT_WITH_TASKS"</li><li>"CHILDREN_SPANS_PER_TASK"</li><li>"CHILDREN_SPANS_PER_SUBTASK"</li></ul></td>
        </tr>
        <tr>
            <td><h5>traces.reporter.&lt;name&gt;.&lt;parameter&gt;</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>Configures the parameter &lt;parameter&gt; for the reporter named &lt;name&gt;.</td>
        </tr>
        <tr>
            <td><h5>traces.reporter.&lt;name&gt;.factory.class</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>The reporter factory class to use for the reporter named &lt;name&gt;.</td>
        </tr>
        <tr>
            <td><h5>traces.reporter.&lt;name&gt;.filter.excludes</h5></td>
            <td style="word-wrap: break-word;"></td>
            <td>List&lt;String&gt;</td>
            <td>The spans that should be excluded for the reporter named &lt;name&gt;. The format is identical to <code class="highlighter-rouge">filter.includes</code><br /></td>
        </tr>
        <tr>
            <td><h5>traces.reporter.&lt;name&gt;.filter.includes</h5></td>
            <td style="word-wrap: break-word;">"*:*:*"</td>
            <td>List&lt;String&gt;</td>
            <td>The spans that should be included for the reporter named &lt;name&gt;. Filters are specified as a list, with each filter following this format:<br /><code class="highlighter-rouge">&lt;scope&gt;[:&lt;name&gt;[,&lt;name&gt;]]</code><br />A span matches a filter if the scope pattern and at least one of the name patterns match.<br /><ul><li>scope: Filters based on the logical scope.<br />Specified as a pattern where <code class="highlighter-rouge">*</code> matches any sequence of characters and <code class="highlighter-rouge">.</code> separates scope components.<br /><br />For example:<br /> "<code class="highlighter-rouge">jobmanager.job</code>" matches any job-related spans on the JobManager,<br /> "<code class="highlighter-rouge">*.job</code>" matches all job-related spans and<br /> "<code class="highlighter-rouge">*.job.*</code>" matches all spans below the job-level (i.e., task/operator spans etc.).<br /><br /></li><li>name: Filters based on the span name.<br />Specified as a comma-separate list of patterns where <code class="highlighter-rouge">*</code> matches any sequence of characters.<br /><br />For example, "<code class="highlighter-rouge">*Records*,*Bytes*</code>" matches any span where the name contains <code class="highlighter-rouge">"Records" or "Bytes"</code>.</li></ul></td>
        </tr>
        <tr>
            <td><h5>traces.reporter.&lt;name&gt;.scope.delimiter</h5></td>
            <td style="word-wrap: break-word;">"."</td>
            <td>String</td>
            <td>The delimiter used to assemble the metric identifier for the reporter named &lt;name&gt;.</td>
        </tr>
        <tr>
            <td><h5>traces.reporter.&lt;name&gt;.scope.variables.additional</h5></td>
            <td style="word-wrap: break-word;"></td>
            <td>Map</td>
            <td>The map of additional variables that should be included for the reporter named &lt;name&gt;.</td>
        </tr>
        <tr>
            <td><h5>traces.reporter.&lt;name&gt;.scope.variables.excludes</h5></td>
            <td style="word-wrap: break-word;">"."</td>
            <td>String</td>
            <td>The set of variables that should be excluded for the reporter named &lt;name&gt;. Only applicable to tag-based reporters.</td>
        </tr>
        <tr>
            <td><h5>traces.reporters</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>An optional list of trace reporter names. If configured, only reporters whose name matches any of the names in the list will be started. Otherwise, all reporters that could be found in the configuration will be started.</td>
        </tr>
    </tbody>
</table>