Add sonoff s31 docs for prom units mismatch #1283
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
As mentioned in this issue, on the Sonoff S31, the prometheus metrics
energy_power_kilowatts_daily
andenergy_power_kilowatts_total
report values whose units are kilowatt hours rather than kilowatts, as implied by the naming convention.This change adds an update to the Sonoff S31 device documentation to point this out.
Notes
Ideally, we'd update the metric names, but those metrics are shared across quite a few devices so implementing the name change would be quite a bit of effort for a pedantic fix. In the mean time, folks running into this issue can work around it with metric relabeling.