This Ansible collection contains modules for assisting in the automation of the Healthchecks.io monitoring service. To learn more about this service, please read https://healthchecks.io/about/.
From their site:
Healthchecks.io is an online service for monitoring regularly running tasks such as cron jobs. It uses the Dead man's switch technique: the monitored system must "check in" with Healthchecks.io at regular, configurable time intervals. When Healthchecks.io detects a missed check-in, it sends out alerts.
The service documentation is located at https://healthchecks.io/docs/ and the API documentation is located at https://healthchecks.io/docs/api/. This Ansible module strives for API parity.
We follow the Ansible Code of Conduct in all our interactions within this project.
If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.
Join us in the #ansible-healthchecksio channel of Libera Chat.
We take part in the global quarterly Ansible Contributor Summit virtually or in-person. Track The Bullhorn newsletter and join us.
For more information about communication, refer to the Ansible Communication guide.
The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.
We are actively accepting new contributors.
Any kind of contribution is very welcome.
You don't know how to start? Refer to our contribution guide!
We use the following guidelines:
- CONTRIBUTING.md
- REVIEW_CHECKLIST.md
- Ansible Community Guide
- Ansible Development Guide
- Ansible Collection Development Guide
The current maintainers are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.
To learn how to maintain / become a maintainer of this collection, refer to the Maintainer guidelines.
The process of decision making in this collection is based on discussing and finding consensus among participants.
Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!
Tested with the current Ansible 2.9 and 2.10 releases and the current development version of Ansible. Ansible versions before 2.9.10 are not supported.
An account (and API token) for Healthchecks.io.
N/A
community.healthchecksio.badges_info- Returns a map of all tags in the project, with badge URLs for each tag.community.healthchecksio.channels_info- Returns a list of integrations belonging to the project.community.healthchecksio.checks_flips_info- Get a list of check's status changes.community.healthchecksio.checks_info- Returns a list of checks belonging to the user, optionally filtered by one or more tags.community.healthchecksio.checks_pings_info- Returns a list of pings this check has received.community.healthchecksio.checks- Create, delete, update, and pause checks.
community.healthchecksio.ping- Signal success, fail, and start events.
- name: Get the project badges
community.healthchecksio.badges_info:
state: present
api_key: "{{ api_key }}"- name: Get a list of integrations
community.healthchecksio.channels_info:
state: present
api_key: "{{ api_key }}"- name: Create a check named "test"
community.healthchecksio.checks:
state: present
api_key: "{{ api_key }}"
name: test
unique: ["name"]- name: Create a check named "test hourly"
community.healthchecksio.checks:
state: present
api_key: "{{ api_key }}"
name: "test hourly"
unique: ["name"]
tags: ["test", "hourly"]
desc: "my hourly test check"
schedule: "0 * * * *"- name: Returns all of the checks
community.healthchecksio.checks_info:
state: present
api_key: "{{ api_key }}"- name: Pause a check by uuid
community.healthchecksio.checks:
state: pause
api_key: "{{ api_key }}"
uuid: "{{ check_uuid }}"- name: Delete a check by uuid
community.healthchecksio.checks:
state: absent
api_key: "{{ api_key }}"
uuid: "{{ check_uuid }}"- name: Get a list of checks pings
community.healthchecksio.checks_pings_info:
state: pings
api_key: "{{ api_key }}"
uuid: "{{ check_uuid }}"- name: Get a list of checks flips
community.healthchecksio.checks_flips_info:
state: flips
api_key: "{{ api_key }}"
uuid: "{{ check_uuid }}"- name: Send a success signal
community.healthchecksio.ping:
state: present
uuid: "{{ check_uuid }}"
signal: success- name: Send a fail signal
community.healthchecksio.ping:
state: present
uuid: "{{ check_uuid }}"
signal: fail- name: Send a start signal
community.healthchecksio.ping:
state: present
uuid: "{{ check_uuid }}"
signal: startBefore using this collection, you need to install it with the Ansible Galaxy command-line tool:
ansible-galaxy collection install community.healthchecksioYou can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:
---
collections:
- name: community.healthchecksioNote that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the ansible package. To upgrade the collection to the latest available version, run the following command:
ansible-galaxy collection install community.healthchecksio --upgradeYou can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 0.1.0:
ansible-galaxy collection install community.healthchecksioSee Ansible Using collections for more details.
See the changelog.
There's a pinboard issue here and we can have discussions here.
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Collections Checklist
- Ansible Community code of conduct
- The Bullhorn (the Ansible Contributor newsletter)
- Changes impacting Contributors
GNU General Public License v3.0 or later.
See LICENSE to see the full text.