[PCP] Add annotations to plots

This commit introduces a feature that explores the Ansible
log files from within the ci-framework-data directory
and annotates the plots generated from PCP metrics
with details, such as when some EDPM stages were executed
and at what time there were testing frameworks launched.

Author: sdatko

hooks/playbooks/pcp-metrics-post.yml

@@ -19,6 +19,11 @@
 - name: Process metrics
   hosts: localhost
   tasks:
+    - name: Gather annotations
+      ansible.builtin.include_role:
+        name: pcp_metrics
+        tasks_from: annotations
+
     - name: Generate figures
       ansible.builtin.include_role:
         name: pcp_metrics

roles/pcp_metrics/files/plot.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 import csv
+from datetime import datetime
 from glob import glob
 from os import getenv
 import os.path
@@ -19,6 +20,7 @@
 #
 # Parameters
 #
+ANNOTATIONS_FILE = getenv('ANNOTATIONS_FILE', 'metrics/annotations.txt')
 METRICS_SRC = (sys.argv[1:] if len(sys.argv) > 1
                else [getenv('METRICS_SRC', 'metrics/*.csv')])
 OUTPUT_DIR = getenv('OUTPUT_DIR', 'metrics/')
@@ -376,6 +378,41 @@ def subplot(ax: plt.Axes,
               yscale=yscale)
 
 
+def annotate(axs: Iterable[plt.Axes]) -> None:
+    '''Draws vertical annotation lines on the interesting time marks.
+
+    Parameters
+    ----------
+    axs : Iterable[plt.Axes]
+        A collection of subplot objects in which the data were plotted.
+    '''
+    if not os.path.isfile(ANNOTATIONS_FILE):
+        print('WARNING No annotations dafa found in file:', ANNOTATIONS_FILE)
+        return
+
+    with open(ANNOTATIONS_FILE) as file:
+        data = file.read().strip().split('\n')
+
+    for annotation in data:
+        time, details = annotation.split(' | ', maxsplit=1)
+        time = datetime.strptime(time, '%Y-%m-%d %H:%M:%S,%f')
+
+        if details.startswith('PLAY'):
+            color = 'darkred'
+
+        elif details.startswith('TASK [kustomize_deploy'):
+            color = 'navy'
+
+        elif details.startswith('TASK [test_operator'):
+            color = 'darkgreen'
+
+        else:  # generic
+            color = 'grey'
+
+        for ax in axs:
+            ax.axvline(time, color=color, ls='--', alpha=0.5)
+
+
 def plot(df: pd.DataFrame,
          output: str,
          title: Union[str, None] = None,
@@ -416,6 +453,8 @@ def plot(df: pd.DataFrame,
     if title:
         fig.suptitle(title, fontsize=16)
 
+    annotate(axs)
+
     # NOTE: the argument of Pandas query() & eval() is expected to be a valid
     #       Python expression, which does not allow any special characters
     #       (e.g. dots); the backticks can be used to specify column names

roles/pcp_metrics/tasks/annotations.yaml

@@ -0,0 +1,32 @@
+---
+- name: Extract annotations
+  ansible.builtin.shell: >-
+    grep
+    --no-filename
+    --regexp 'PLAY \['
+    --regexp 'TASK \[kustomize_deploy : Apply generated content for'
+    --regexp 'TASK \[test_operator : Run'
+    $( find "{{ ansible_user_dir }}" -iname 'ansible*.log' 2>/dev/null )
+    | sed
+    --regexp-extended
+    --expression 's#p=[0-9]+ u=[^ ]+ n=[^ ]+ |##g'
+    --expression 's# (_raw_params|msg|chdir)=.*#]#g'
+    --expression 's#[ *]*$##g'
+    | sort
+    --numeric-sort
+    --key=1,2
+    | uniq
+  ignore_errors: true
+  changed_when: false
+  register: _annotations_shell
+
+- name: Ensure the output directory exist
+  file:
+    path: "{{ pcp_metrics_output_dir }}"
+    state: directory
+    mode: '0755'
+
+- name: Save annotations
+  copy:
+    content: "{{ _annotations_shell.stdout }}"
+    dest: "{{ pcp_metrics_output_dir }}/annotations.txt"

roles/pcp_metrics/tasks/plot.yaml

@@ -21,6 +21,7 @@
   ansible.builtin.shell: >-
     . "{{ pcp_metrics_venv_dir }}/bin/activate"
     && export OUTPUT_DIR="{{ pcp_metrics_output_dir }}"
+    && export ANNOTATIONS_FILE="{{ pcp_metrics_output_dir }}/annotations.txt"
     && python3 "{{ pcp_metrics_venv_dir }}/plot.py" "{{ pcp_metrics_output_dir }}/*.csv"
   register: _pcp_shell
   failed_when: