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

Add state for alarm_control_panel in Prometheus #123753

Merged

Conversation

DeathCamel58
Copy link
Contributor

@DeathCamel58 DeathCamel58 commented Aug 12, 2024

Proposed change

Export alarm_control_panel state with Prometheus.

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

This adds support for exporting alarm_control_panel state with Prometheus.

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.

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 @DeathCamel58

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 submitting a PR! Looks good overall, just a couple of small comments from me.

Also, do you think you would also be able to add a simple test? You can look at the recent test changes to find a good example, like #119805.

@DeathCamel58 DeathCamel58 force-pushed the prometheus_alarm_control_panel branch from 4be8868 to 578d5c0 Compare August 13, 2024 12:23
@DeathCamel58 DeathCamel58 requested a review from a team as a code owner August 13, 2024 12:23
@DeathCamel58
Copy link
Contributor Author

I've added the requested unit tests.

@MartinHjelmare MartinHjelmare changed the title Prometheus: Add state for alarm_control_panel Add state for alarm_control_panel in Prometheus Aug 13, 2024
@home-assistant home-assistant bot marked this pull request as draft August 13, 2024 20:07
@DeathCamel58 DeathCamel58 force-pushed the prometheus_alarm_control_panel branch from e575650 to 28bf6ef Compare August 13, 2024 22:08
@DeathCamel58 DeathCamel58 marked this pull request as ready for review August 13, 2024 22:29
@MartinHjelmare MartinHjelmare requested review from knyar and removed request for knyar, MartinHjelmare and home-assistant[bot] August 14, 2024 00:10
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! Just one minor comment, otherwise lgtm.
Appreciate adding the test!

@DeathCamel58 DeathCamel58 requested a review from knyar August 14, 2024 13:33
@DeathCamel58 DeathCamel58 force-pushed the prometheus_alarm_control_panel branch from 28bf6ef to e828274 Compare August 14, 2024 13:34
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! Hopefully one of Home Assistant maintainers will be able to merge this soon.

@home-assistant home-assistant bot marked this pull request as draft August 16, 2024 22:27
@DeathCamel58 DeathCamel58 force-pushed the prometheus_alarm_control_panel branch 2 times, most recently from 462c1e5 to a33db1c Compare August 18, 2024 12:55
@DeathCamel58 DeathCamel58 force-pushed the prometheus_alarm_control_panel branch from a33db1c to 8565640 Compare August 18, 2024 12:59
@DeathCamel58 DeathCamel58 marked this pull request as ready for review August 18, 2024 12:59
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.

👍

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare
Copy link
Member

For the future, please don't amend or squash commits after review has started to make it easier for readers to track changes. Thanks!

@MartinHjelmare MartinHjelmare merged commit 02b26ac into home-assistant:dev Aug 18, 2024
26 checks passed
@MartinHjelmare
Copy link
Member

We missed to update the docs. Please update this list:

https://www.home-assistant.io/integrations/prometheus/#supported-metrics

@github-actions github-actions bot locked and limited conversation to collaborators Aug 19, 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.

3 participants