octoperf-report-item-editing

Editing OctoPerf bench-report items

This skill covers changing the metrics/filters of a bench report item (a BenchReportItem) — not reading its values (see octoperf://skills/bench-reports for the read side). A report item's metrics are constrained: only certain sample types, metric ids and tag filters are valid for a given report item type. The backend exposes that contract; use it instead of guessing.

The model

A metric-bearing report item (StatisticTableReportItem, LineChartReportItem, PercentilesChartReportItem, SummaryReportItem, PieChartReportItem, StatisticTreeReportItem, BarChartReportItem, AreaRangeChartReportItem) holds a list of ReportItemMetric:

• id — the MetricId (e.g. RESPONSE_TIME_AVG, HITS_TOTAL).
• type — the SampleType (BASIC, WEB, LOAD, NUMBER_COUNTER, …).
• filters — a set of SingleTermFilter{field,term} / MultiTermFilter{field,terms} narrowing the query by tag (region, injectorId, virtualUserName, actionPath, subSampleType, …). AND-combined.
• benchResultId, configs.

Which type/id/filter is legal depends on the report item type, the report's bench results and whether it is a trend report. That is the allow-select descriptor.

Workflow

1. Read the report — get_bench_report(reportId) to see items and their ids/@type.
2. Resolve what's allowed — get_report_item_allow_select(reportId, itemId) returns:
   • sampleTypes — allowed sample types for the item.
   • metricIdsBySampleType — selectable metric ids per sample type.
   • tagKeyConstraints — per tag key: whether it's offered/required, allowedValues (a closed whitelist when non-empty, e.g. subSampleType ∈ {Hit, Container}), single (single vs multi select), and dependsOn (parent keys, e.g. injectorId depends on region).
3. Discover filter values (for open-ended tag keys):
   • get_report_tag_keys(reportId, sampleType) — the filterable tag keys.
   • get_report_tag_values(reportId, sampleType, tagKeys, filters?) — the concrete values, optionally scoped by already-selected filters (e.g. restrict injectorId values to a chosen region by passing {"region":["eu-west-1"]}).
4. Build the metric(s) using only allowed types/ids/fields/values.
5. Validate — validate_report_item(reportId, itemId) returns ReportItemValidation (valid + violations). Fix every violation before persisting.
6. Persist — patch_bench_report(reportId, patch) with an RFC 6902 JSON Patch (consult octoperf://schema/bench-report for the item shape). The server runs the same allow-select validation as a pre-flight and rejects the patch (with the violation messages) if any metric is invalid, so a green patch_bench_report means the edit was both structurally and semantically valid.