Skip to content

Commit

Permalink
fix: add missing pmie webhook action configuration functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
natoscott committed Nov 22, 2023
1 parent 3e661d0 commit 2b667c7
Show file tree
Hide file tree
Showing 6 changed files with 108 additions and 0 deletions.
4 changes: 4 additions & 0 deletions roles/pcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ Default location for [pmlogger(1)](http://man7.org/linux/man-pages/man1/pmlogger

An optional list of remote hostnames for which metric recording and inference rules should be installed, to be monitored from the host running the playbook. By default, all performance rules evaluating to true will be logged to the local system log (for both the local host and remote hosts in the target hosts list), and daily archives will be created below *pcp_archive_dir*/*hostname* locally, again for each host listed in the target hosts list.

pcp_pmie_endpoint: ''

Send inference events to the given webhook endpoint (URL) from [pmie(1)](http://man7.org/linux/man-pages/man1/pmie.1.html) performance rules. The default is to log these events into the local system log only.

pcp_single_control: 0

Specifies whether the pcp_target_hosts configuration file(s) for pmie and pmlogger are in control.d form (the default) or in the single file form where /*etc*/*pcp*/*pmlogger*/*control* and /*etc*/*pcp*/*pmie*/*control* are used to setup the target hosts list for monitoring.
Expand Down
1 change: 1 addition & 0 deletions roles/pcp/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ pcp_rest_api: false
pcp_pmlogger_discard: 14
pcp_pmlogger_interval: 60
pcp_archive_dir: /var/log/pcp/pmlogger
pcp_pmie_endpoint: ''
pcp_pmcd_localonly: 0
pcp_pmproxy_localonly: 0
pcp_pmlogger_localonly: 1
Expand Down
49 changes: 49 additions & 0 deletions roles/pcp/tasks/pmie.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,54 @@
loop: "{{ __pcp_pmieconf_rules | default([]) }}"
register: __pcp_register_changed_rules_for_hosts

- name: Ensure performance rule actions are installed for targeted hosts
tasks:
- name: Prepare localhost facts for webhook_action
set_fact:
local_pmie: "default"

- name: Check if global webhook_action is configured
lineinfile:
state: absent
path: "{{ __pcp_pmie_config_path }}/config.{{ item }}"
regexp: "//.*global webhook_action = yes"
check_mode: true
changed_when: false
register: __pcp_global_webhook_action_status
loop: "{{ pcp_target_hosts + [local_pmie] }}"
when:
- pcp_pmie_endpoint | d(false) | bool

# yamllint disable rule:line-length
- name: Configure global webhook_action
command: "pmieconf -f {{ __pcp_pmie_config_path }}/config.{{ item.item }} modify global webhook_action yes"
loop: "{{ __pcp_global_webhook_action_status.results }}"
when:
- pcp_pmie_endpoint | d(false) | bool
- item.found == 0
register: __pcp_register_changed_actions_for_hosts
# yamllint enable rule:line-length

- name: Check if global webhook_endpoint is configured
lineinfile:
state: absent
path: "{{ __pcp_pmie_config_path }}/config.{{ item }}"
regexp: "//.*global webhook_endpoint = \"{{ pcp_pmie_endpoint }}\""
check_mode: true
changed_when: false
register: __pcp_global_webhook_endpoint_status
loop: "{{ pcp_target_hosts + [local_pmie] }}"

# yamllint disable rule:line-length
- name: Configure global webhook_endpoint
command: "pmieconf -f {{ __pcp_pmie_config_path }}/config.{{ item.item }} modify global webhook_endpoint {{ pcp_pmie_endpoint }}"
loop: "{{ __pcp_global_webhook_endpoint_status.results }}"
when:
- pcp_pmie_endpoint | d(false) | bool
- item.found == 0
register: __pcp_register_changed_actions_for_hosts
# yamllint enable rule:line-length

Check failure on line 80 in roles/pcp/tasks/pmie.yml

View workflow job for this annotation

GitHub Actions / ansible_lint

yaml[comments-indentation]

Comment not indented like content

- name: Ensure extra rules symlinks have been created for targeted hosts
file:
src: "{{ __pcp_pmieconf_path }}/{{ item }}"
Expand Down Expand Up @@ -67,6 +115,7 @@
__pcp_register_changed_group_dir is changed or
__pcp_register_changed_group_link_dir is changed or
__pcp_register_changed_rules_for_hosts is changed or
__pcp_register_changed_actions_for_hosts is changed or
__pcp_register_changed_symlinks_for_hosts is changed or
__pcp_register_changed_target_hosts_controld is changed or
__pcp_register_changed_target_hosts_single is changed }}"
Expand Down
1 change: 1 addition & 0 deletions roles/pcp/vars/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ __pcp_pmlogger_control_path: /etc/pcp/pmlogger/control

__pcp_pmie_control_d_path: /etc/pcp/pmie/control.d
__pcp_pmie_control_path: /etc/pcp/pmie/control
__pcp_pmie_config_path: /var/lib/pcp/config/pmie

__pcp_pmieconf_path: /etc/pcp/pmieconf
__pcp_pmieconf_link_path: /var/lib/pcp/config/pmieconf
Expand Down
26 changes: 26 additions & 0 deletions tests/check_pmie_webhook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# SPDX-License-Identifier: MIT
---
- name: Check if primary pmie is running
changed_when: false
shell: |
set -eu
if set -o | grep -q pipefail; then
set -o pipefail # no pipefail on debian, some ubuntu
fi
pmprobe -I pmcd.pmie.pmcd_host | grep '"primary"'
when: (ansible_facts['distribution'] in ['RedHat', 'CentOS'] and
ansible_facts['distribution_major_version'] | int > 6) or
ansible_facts['distribution'] not in ['Fedora', 'RedHat', 'CentOS']

- name: Check if primary pmie uses webhook
changed_when: false
shell: |
set -eu
if set -o | grep -q pipefail; then
set -o pipefail # no pipefail on debian, some ubuntu
fi
pmieconf -f /var/lib/pcp/config/pmie/config.default list global webhook_endpoint | grep '"example"'

Check failure on line 22 in tests/check_pmie_webhook.yml

View workflow job for this annotation

GitHub Actions / ansible_lint

yaml[line-length]

Line too long (103 > 80 characters)
pmieconf -f /var/lib/pcp/config/pmie/config.default list global webhook_action | grep '"yes"'

Check failure on line 23 in tests/check_pmie_webhook.yml

View workflow job for this annotation

GitHub Actions / ansible_lint

yaml[line-length]

Line too long (97 > 80 characters)
when: (ansible_distribution in ['RedHat', 'CentOS'] and
(ansible_facts['distribution_version'] is version('9.3', '<'))) or
ansible_distribution not in ['Fedora', 'RedHat', 'CentOS']
27 changes: 27 additions & 0 deletions tests/tests_verify_pmie_webhook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# SPDX-License-Identifier: MIT
---
- name: Test pmie webhook configuration
hosts: all

roles:
- role: performancecopilot.metrics.pcp
vars:
pcp_pmie_endpoint: https://example.com:12345/webhook

pre_tasks:
- name: Skip test if not supported by platform
meta: end_host
when: (ansible_distribution in ['RedHat', 'CentOS'] and
(ansible_facts['distribution_version'] is version('9.3', '<'))) or
ansible_distribution not in ['Fedora', 'RedHat', 'CentOS']

- name: Save state of services
import_tasks: get_services_state.yml

tasks:
- name: Check if configuring pmie webhook works
include_tasks: check_pmie_webhook.yml

post_tasks:
- name: Restore state of services
import_tasks: restore_services_state.yml

0 comments on commit 2b667c7

Please sign in to comment.