eclipse-cdt-cloud / eclipse-cdt-cloud/trace-server-protocol

Consolidate input query parameters across views for time ranges

Open
#131 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
26
Forks
21
PR merge metrics
No merged PRs in 30d

Description

### Bug Description:

Consolidate input query parameters across views for time ranges.

Any time-based views uses the `requested_timerange` as input parameter to query the data for a give time range. Other views which don't have the trace time as x-axis don't always use `requested_timerange` for that.

For example, the GANTT_CHART data provider uses the requested_timerange to specify the start duration and end duration if the x-axis is duration. If the x-axis would be other data, e.g. bytes this input parameter would make even less sense. For the GANTT_CHART another query parameter exists in the Trace Compass to specify the time range to apply (see [here](https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/blob/d487cf2e11795a2680d3333677f443e98724bcb9/analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/internal/analysis/profiling/core/flamegraph/FlameGraphDataProvider.java#L506).

Another example are the Latency views, where it's possible to add the query parameter `requested_times` to specify start time (value at index 0) and end time (value at index 1). Additionally it is required to add the filter flag `isFiltered` with value true in the query parameters. Adding this will add total statistics and the time range based statistics in one query.

A third example is the generic xy chart implementation under development (see [here](https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/pull/291#pullrequestreview-3055341970)) where the parameter `requested_timerange` is used for querying the data provider for specific time range.

This ticket is to align the input parameters and behaviour across data providers.

### Additional Information
N/A

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.