Rename `XxxData` to `XxxTelemetry`

[tiyash-basu-frequenz]

What's needed?

The ComponentData message contains metrics and states sampled from a component. This could create confusion with the Component message, which contains static data about a component.

The same problem exists with Sensor and SensorData.

Proposed solution

Renaming ComponentData to ComponentDataSample makes its purpose clearer. This could resolve the issue.

Similarly, SensorData could be renamed to SensorDataSample.

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

[llucax]

Since these messages contains many samples, I would recommend renaming to SensorDataSamples and ElectricalComponentDataSamples (in plural) to avoid further confusion with SensorMetricSample and MetricSamples/ElectricalComponentMetricSample (see #324).

[tiyash-basu-frequenz]

Given the changes proposed in #326 , suffixing Samples or Snapshots to the *Data messages is probably not enough. We need something more generic that covers both cases.

Suggestion 1

I would propose the term Telemetry, broadly refers to data transmitted from a remote source, which perfectly fits sensor and electrical data being sent from a microgrid.

So, I'd propose SensorTelemetry, ElectricalComponentTelemetry, and CommunicationComponentTelemetry.

Note that telemetry already refers to data, so we do not need to explain things further.

Suggestion 2

My second suggestion would be Timeseries. Similar to Telemetry but more closely tied to the nature of the data in these messages. But it could be confusing since these messages do not represent the complete timeseries, but only parts of it.

[llucax]

I don't mind the new names, but I don't understand why DataSamples and Snapshot are not good enough.

Also since you mentioned snapshots, I'm not sure if this covers states too, as recently they were changed to have the snapshot suffix to differentiate them from numerical data. Does this propose to bring them together again?

[tiyash-basu-frequenz]

I don't mind the new names, but I don't understand why DataSamples and Snapshot are not good enough.

Samples and Snapshots are good names for their respective fields. But the challenge is that when renaming the wrapper that contains both of these, either one is not suitable because the wrapper name needs to generic enough to cover both.

Also since you mentioned snapshots, I'm not sure if this covers states too, as recently they were changed to have the snapshot suffix to differentiate them from numerical data. Does this propose to bring them together again?

Oh no no, this issue is just concerned with the wrappers.

[llucax]

Oh, I see now, sorry for the confusion. In that sense using the same name for both numeric data and states would have simplified things here 😆

Then I'm also more inclined towards Telemetry.