https://github.com/nomakcooper/sar_facts

Collect system activity report (SAR) data for system performance monitoring by Ansible Module
https://github.com/nomakcooper/sar_facts

ansible ansible-module facts python python3 sar

Last synced: 8 months ago
JSON representation

Collect system activity report (SAR) data for system performance monitoring by Ansible Module

Host: GitHub
URL: https://github.com/nomakcooper/sar_facts
Owner: NomakCooper
License: gpl-3.0
Created: 2025-02-07T03:14:33.000Z (8 months ago)
Default Branch: main
Last Pushed: 2025-02-07T22:14:33.000Z (8 months ago)
Last Synced: 2025-02-07T23:19:31.800Z (8 months ago)
Topics: ansible, ansible-module, facts, python, python3, sar
Language: Python
Homepage:
Size: 43 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![Ansible Custom Module][ansible-shield]
![python][python-shield]
![license][license-shield]

### sar_facts ansible custom module
#### Collect system activity report (SAR) data for system performance monitoring by Ansible Module

#### Description :information_source:

sar_facts is an ansible custom module that creates and adds a new dict to ansible_facts based on type selected
|fact name|type|
|---------|----|
|sar_cpu|cpu|
|sar_load|load|
|sar_mem|memory|
|sar_swap|swap|
|sar_net|network|
|sar_disk|disk|

#### Repo files :open_file_folder:

```
├── /library
│ └── sar_facts.py ##<-- python custom module
```

#### Requirements :heavy_check_mark:

* require [sar](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/introduction_to_system_administration/s3-resource-tools-sar-sar) command
* require Python >= 3.8

#### Options :

#### Attributes :

|Attribute |Support|Description |
|----------|-------|------------------------------------------------------------------------------------|
|check_mode|full |Can run in check_mode and return changed status prediction without modifying target.|
|facts |full |Action returns an ansible_facts dictionary that will update existing host facts. |

#### Examples dict in ansible_facts :arrow_forward:
#### cpu TYPE
```json
"ansible_facts.sar_cpu": [
{
"%idle": "99.84",
"%iowait": "0.00",
"%nice": "0.00",
"%steal": "0.00",
"%system": "0.07",
"%user": "0.09",
"AM": "AM",
"cpu": "all",
"date": "2025-02-07",
"time": "04:10:01"
}
]
```
#### load TYPE
```json
"ansible_facts.sar_load": [
{
"AM": "AM",
"blocked": "0",
"date": "2025-02-07",
"ldavg-1": "0.00",
"ldavg-15": "0.05",
"ldavg-5": "0.01",
"plist-sz": "116",
"runq-sz": "1",
"time": "04:10:01"
}
]
```
#### memory TYPE
```json
"ansible_facts.sar_mem": [
{
"%commit": "7.24",
"%memused": "81.82",
"AM": "AM",
"date": "2025-02-07",
"kbactive": "614788",
"kbbuffers": "4076",
"kbcached": "1135156",
"kbcommit": "288172",
"kbdirty": "0",
"kbinact": "595776",
"kbmemfree": "342208",
"kbmemused": "1539660",
"time": "04:10:01"
}
]
```
#### swap TYPE
```json
"ansible_facts.sar_swap": [
{
"%swpcad": "0.00",
"%swpused": "0.00",
"AM": "AM",
"date": "2025-02-07",
"kbswpcad": "0",
"kbswpfree": "2097148",
"kbswpused": "0",
"time": "04:10:01"
}
]
```
#### network TYPE
```json
"ansible_facts.sar_net": [
{
"AM": "AM",
"IFACE": "enp0s3",
"date": "2025-02-07",
"rxcmp/s": "0.00",
"rxkB/s": "0.43",
"rxmcst/s": "0.00",
"rxpck/s": "0.45",
"time": "04:10:01",
"txcmp/s": "0.00",
"txkB/s": "0.23",
"txpck/s": "0.29"
},
{
"AM": "AM",
"IFACE": "enp0s8",
"date": "2025-02-07",
"rxcmp/s": "0.00",
"rxkB/s": "0.01",
"rxmcst/s": "0.02",
"rxpck/s": "0.16",
"time": "04:10:01",
"txcmp/s": "0.00",
"txkB/s": "0.00",
"txpck/s": "0.02"
},
{
"AM": "AM",
"IFACE": "lo",
"date": "2025-02-07",
"rxcmp/s": "0.00",
"rxkB/s": "0.00",
"rxmcst/s": "0.00",
"rxpck/s": "0.00",
"time": "04:10:01",
"txcmp/s": "0.00",
"txkB/s": "0.00",
"txpck/s": "0.00"
}
]
```
#### disk TYPE
```json
"ansible_facts.sar_disk": [
{
"%util": "0.01",
"AM": "AM",
"DEV": "dev8-0",
"avgqu-sz": "0.00",
"avgrq-sz": "14.54",
"await": "2.15",
"date": "2025-02-07",
"rd_sec/s": "0.00",
"svctm": "0.66",
"time": "04:10:01",
"tps": "0.18",
"wr_sec/s": "2.57"
},
{
"%util": "0.01",
"AM": "AM",
"DEV": "dev253-0",
"avgqu-sz": "0.00",
"avgrq-sz": "14.26",
"await": "2.18",
"date": "2025-02-07",
"rd_sec/s": "0.00",
"svctm": "0.61",
"time": "04:10:01",
"tps": "0.19",
"wr_sec/s": "2.71"
},
{
"%util": "0.00",
"AM": "AM",
"DEV": "dev253-1",
"avgqu-sz": "0.00",
"avgrq-sz": "0.00",
"await": "0.00",
"date": "2025-02-07",
"rd_sec/s": "0.00",
"svctm": "0.00",
"time": "04:10:01",
"tps": "0.00",
"wr_sec/s": "0.00"
}
]
```
#### disk TYPE Partitioned
```json
"ansible_facts.sar_disk": [
{
"%util": "0.01",
"AM": "AM",
"DEV": "sda",
"avgqu-sz": "0.00",
"avgrq-sz": "14.54",
"await": "2.15",
"date": "2025-02-07",
"rd_sec/s": "0.00",
"svctm": "0.66",
"time": "04:10:01",
"tps": "0.18",
"wr_sec/s": "2.57"
},
{
"%util": "0.01",
"AM": "AM",
"DEV": "centos-root",
"avgqu-sz": "0.00",
"avgrq-sz": "14.26",
"await": "2.18",
"date": "2025-02-07",
"rd_sec/s": "0.00",
"svctm": "0.61",
"time": "04:10:01",
"tps": "0.19",
"wr_sec/s": "2.71"
},
{
"%util": "0.00",
"AM": "AM",
"DEV": "centos-swap",
"avgqu-sz": "0.00",
"avgrq-sz": "0.00",
"await": "0.00",
"date": "2025-02-07",
"rd_sec/s": "0.00",
"svctm": "0.00",
"time": "04:10:01",
"tps": "0.00",
"wr_sec/s": "0.00"
}
]
```
#### Tasks example :arrow_forward:
#### Collect data
```yaml
- name: Collect disk data for all partitions from 2025-02-06 to 2025-02-07
sar_facts:
type: "disk"
date_start: "2025-02-06"
date_end: "2025-02-07"
partition: true
```
```yaml
- name: Get cpu data between 08:00:00 and 12:00:00 for all stored days
sar_facts:
type: "cpu"
time_start: "08:00:00"
time_end: "12:00:00"
```
```yaml
- name: Fetch memory usage data for 2025-02-07
sar_facts:
type: "memory"
date_start: "2025-02-07"
```
```yaml
- name: Get only average disk data for 2025-02-06
sar_facts:
type: "disk"
date_start: "2025-02-06"
average: true
```
```yaml
- name: Retrieve system load average for today
sar_facts:
type: "load"
```
#### Filter data
```yaml
- name: Extract all await values for centos-root ( from disk type partitioned )
set_fact:
root_await: >-
{{ ansible_facts.sar_data.disk
| selectattr('DEV', 'equalto', 'centos-root')
| map(attribute='await')
| list
}}
```
```yaml
- name: Extract all rxpck/s values for enp0s3 net interface
set_fact:
enp0s3_rxpck: >-
{{ ansible_facts.sar_data.network
| selectattr('IFACE', 'equalto', 'enp0s3')
| map(attribute='rxpck/s')
| list
}}
```
## Integration

1. Assuming you are in the root folder of your ansible project.

Specify a module path in your ansible configuration file.

```shell
$ vim ansible.cfg
```
```ini
[defaults]
...
library = ./library
...
```

Create the directory and copy the python modules into that directory

```shell
$ mkdir library
$ cp path/to/module library
```

2. If you use Ansible AWX and have no way to edit the control node, you can add the /library directory to the same directory as the playbook .yml file

```
├── root repository
│ ├── /playbooks
│ │ ├── /library
│ │ │ └── sar_facts.py ##<-- python custom module
│ │ └── your_playbook.yml ##<-- you playbook
```
2.1 Or create and edit an ansible.cfg file and create a library dir on top of your repo:
```ini
[defaults]
library = library/
```
```
├── root repository
│ ├── ansible.cfg
│ ├── /library
│ │ └── sar_facts.py ##<-- python custom module
│ ├── /playbooks
│ │ └── your_playbook.yml ##<-- you playbook
```
[ansible-shield]: https://img.shields.io/badge/Ansible-custom%20module-blue?style=for-the-badge&logo=ansible&logoColor=lightgrey
[python-shield]: https://img.shields.io/badge/python-blue?style=for-the-badge&logo=python&logoColor=yellow
[license-shield]: https://img.shields.io/github/license/nomakcooper/svcs_facts?style=for-the-badge&label=LICENSE

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/nomakcooper/sar_facts

Awesome Lists containing this project

README