{"id":19825247,"url":"https://github.com/tes3awy/vetr-summarizer","last_synced_at":"2025-05-01T13:32:18.799Z","repository":{"id":255438403,"uuid":"850698242","full_name":"Tes3awy/vetr-summarizer","owner":"Tes3awy","description":"ACI vetR (Health Check) summarizer tool","archived":false,"fork":false,"pushed_at":"2025-02-05T14:50:52.000Z","size":247,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T19:44:36.858Z","etag":null,"topics":["aci","cisco","datacenter","devnet","python","vetr-collector"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/vetr-summarizer/","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tes3awy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-01T14:29:28.000Z","updated_at":"2025-02-05T14:50:56.000Z","dependencies_parsed_at":"2025-01-24T12:34:40.143Z","dependency_job_id":null,"html_url":"https://github.com/Tes3awy/vetr-summarizer","commit_stats":null,"previous_names":["tes3awy/vetr-summarizer"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tes3awy%2Fvetr-summarizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tes3awy%2Fvetr-summarizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tes3awy%2Fvetr-summarizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tes3awy%2Fvetr-summarizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tes3awy","download_url":"https://codeload.github.com/Tes3awy/vetr-summarizer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251881765,"owners_count":21659165,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aci","cisco","datacenter","devnet","python","vetr-collector"],"created_at":"2024-11-12T11:07:06.505Z","updated_at":"2025-05-01T13:32:18.787Z","avatar_url":"https://github.com/Tes3awy.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/Tes3awy/vetr-summarizer)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vetr-summarizer)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat-square\u0026labelColor=ef8336)](https://pycqa.github.io/isort/)\n![PyPI - License](https://img.shields.io/pypi/l/vetr-summarizer)\n![PyPI - Version](https://img.shields.io/pypi/v/vetr-summarizer)\n![PyPI - Status](https://img.shields.io/pypi/status/vetr-summarizer)\n![Pepy Total Downlods](https://img.shields.io/pepy/dt/vetr-summarizer)\n![Commit Activity](https://img.shields.io/github/commit-activity/m/Tes3awy/vetr-summarizer/main?logo=github)\n[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/Tes3awy)\n\n# vetR Summarizer\n\nA Python package for visualizing ACI vetR JSON data from [vetr-collector](https://github.com/brightpuddle/vetr-collector)\n\n# Table of Contents\n\n- [What is vetR Summarizer?](#what-is-vetr-summarizer)\n- [Objective](#objective)\n- [How it works](#how-it-works)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Use Case](#use-case)\n- [Author(s)](#authors)\n- [Contributions](#contributions)\n\n![ACI](https://github.com/Tes3awy/vetr-summarizer/raw/main/assets/aci.jpg)\n\n## What is vetR Summarizer?\n\nThis tool summarizes data from any APIC collected by [vetr-collector](https://github.com/brightpuddle/vetr-collector).\n\n## Objective\n\nThis tool processes data collected by [vetr-collector](https://github.com/brightpuddle/vetr-collector) for the ACI health check and displays it in a pretty HTML tabluar format. This tool can also be run from any computer having `aci-vetr-data` collected from any APIC.\n\nIn `vetr-collector` v3.3.0, the `aci-vetr-data` directory you get from includes around **91** JSON files.\n\n```bash\n$ ls aci-vetr-data\napPlugin.json\nbgpRRNodePEp.json\nconfigRsRemotePath.json\ncoopPol.json\nctxClassCnt.json\ndatetimeNtpProv.json\ndatetimePol.json\nepControlP.json\nepIpAgingP.json\nepLoopProtectP.json\n...\n\u003coutput_truncated\u003e\n```\n\n_A sample preview of the output HTML_\n\n![Preview](https://github.com/Tes3awy/vetr-summarizer/raw/main/assets/preview.jpg)\n\n## How it works\n\nThis tool visualizes data collection for the ACI health check from [vetr-collector](https://github.com/brightpuddle/vetr-collector).\n\nOnce the analysis is complete, the tool creates a `vetr-summary.html` file. This file displays the raw JSON data in a [DataTable](https://datatables.net/) tabular format. DataTable adds the ability to easily search for properties in concern.\n\nAlmost all [MOs](https://www.cisco.com/c/en/us/td/docs/switches/datacenter/aci/apic/sw/policy-model-guide/b-Cisco-ACI-Policy-Model-Guide.html#id_107445__d54e1142) include unnecessary configuration properties. Some of these  properties: `extMngdBy`, `childAction`, `userdom`, etc. These unnecessary properties (key-value pairs) are excluded from the report for a neater representation of the output in the HTML file. \n\n\u003e All excluded keys can be found in [`config/excluded_keys`](https://github.com/Tes3awy/vetr-summarizer/tree/main/src/vetr_summarizer/config) file. You can also customize these keys-to-exclude according to your own case. _An empty excluded\\_keys file will not exclude any keys_.\n\n\u003e Raw JSON files with empty `imdata` (i.e. `\"[]\"`) and `totalCount` equal to `\"0\"` are not presented in the HTML `vetr-summary.html` summary report.\n\n## Installation\n\nInstall from [PyPi](https://pypi.org/project/vetr-summarizer/)\n\n\u003e System-wide\n\n```bash\n$ pip install --user vetr-summarizer\n```\n\n\u003e  Virtual Environment\n\n```bash\n$ python3 -m venv .venv\n$ source .venv/bin/activate .\n(.venv)$ pip install vetr-summarizer\n```\n\n## Usage\n\n\u003e Both keyword arguments are optional. _Currently `html` is the only supported output format_.\n\n```bash\n$ vetr-summarizer --help\nusage: vetr-summarizer [-h] [-f {html}] [-x EXCLUDED_KEYS_FILE] [-v] directory\n\nProcess and summarize aci-vetr-data JSON files into HTML reports.\n\npositional arguments:\n  directory             A path to the directory containing the JSON files.\n\noptions:\n  -h, --help            show this help message and exit\n  -f {html}, --format {html}\n                        Output format (default: html)\n  -x EXCLUDED_KEYS_FILE, --excluded-keys-file EXCLUDED_KEYS_FILE\n                        File with keys to exclude from raw JSON files. (default: excluded_keys)\n  -v, --version         show program's version number and exit\n\nThanks for using vetr-summarizer! :)\n```\n\n```bash\n$ vetr-summarizer \"/path/to/aci-vetr-data\"\n\nHTML output is written to /path/to/vetr-summary.html\n```\n\n\u003e With custom excluded keys\n\n```bash\n$ vetr-summarizer -x custom_excluded_keys \"/path/to/aci-vetr-data\"\n\nHTML output is written to '/path/to/vetr-summary.html'\n```\n\n## Use Case\n\nI was once going through the Cisco Community searching for an answer to my ACI fabric issue, and I came across that question: [VetR Zip logs](https://community.cisco.com/t5/application-centric-infrastructure/vetr-zip-logs/td-p/4804529), what is actually vetr zip logs?\n\n![Question](https://github.com/Tes3awy/vetr-summarizer/raw/main/assets/q.jpg)\n\nSo, I decided to try `vetr-collector` on an environment. But, I had to open each JSON file to check whether it has objects or not and read the entire JSON file if it has valuable data, and that was time-consuming. So, I made this package to summarize the output from `vetr-collector` in a pretty HTML tabular format.\n\n## Author(s)\n\n[Osama Abbas](https://www.linkedin.com/in/oabbas/)\n\n## Contributions\n\nAs there is always a room for imporovment, you are welcome to contribute to `vetr-summarizer`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftes3awy%2Fvetr-summarizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftes3awy%2Fvetr-summarizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftes3awy%2Fvetr-summarizer/lists"}