Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Properly report cover positions to prometheus #110157

Merged
merged 1 commit into from Feb 12, 2024
Merged

Conversation

agoode
Copy link
Contributor

@agoode agoode commented Feb 10, 2024

This component was using the attributes for setting position and tilt instead of the attributes for getting them, resulting in no metrics. See https://developers.home-assistant.io/docs/core/entity/cover/#properties.

Proposed change

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Locally tested:

# HELP homeassistant_cover_state State of the cover (0/1)
# TYPE homeassistant_cover_state gauge
homeassistant_cover_state{domain="cover",entity="cover.garage_door",friendly_name="test cover",state="closed"} 0.0
homeassistant_cover_state{domain="cover",entity="cover.garage_door",friendly_name="test cover",state="closing"} 0.0
homeassistant_cover_state{domain="cover",entity="cover.garage_door",friendly_name="test cover",state="open"} 1.0
homeassistant_cover_state{domain="cover",entity="cover.garage_door",friendly_name="test cover",state="opening"} 0.0
# HELP homeassistant_cover_position Position of the cover (0-100)
# TYPE homeassistant_cover_position gauge
homeassistant_cover_position{domain="cover",entity="cover.garage_door",friendly_name="test cover"} 47.0
# HELP homeassistant_cover_tilt_position Tilt Position of the cover (0-100)
# TYPE homeassistant_cover_tilt_position gauge
homeassistant_cover_tilt_position{domain="cover",entity="cover.garage_door",friendly_name="test cover"} 32.0

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @agoode

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant
Copy link

Hey there @knyar, mind taking a look at this pull request as it has been labeled with an integration (prometheus) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of prometheus can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign prometheus Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Contributor

@knyar knyar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the fix - it looks good!

Hopefully one of the Home Assistant maintainers will be able to review and merge this soon.

This component was using the attributes for setting position and tilt
instead of the attributes for getting them, resulting in no metrics. See
https://developers.home-assistant.io/docs/core/entity/cover/#properties.
Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @agoode 👍

@edenhaus edenhaus added this to the 2024.2.2 milestone Feb 12, 2024
@edenhaus edenhaus merged commit 5cdc3ce into home-assistant:dev Feb 12, 2024
23 checks passed
@agoode agoode deleted the cover branch February 12, 2024 14:58
@github-actions github-actions bot locked and limited conversation to collaborators Feb 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cover position not exported to prometheus
4 participants