{"id":22477181,"url":"https://github.com/base2services/monitorable","last_synced_at":"2025-08-02T13:30:54.741Z","repository":{"id":45313047,"uuid":"227258994","full_name":"base2Services/monitorable","owner":"base2Services","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-07T03:36:09.000Z","size":56,"stargazers_count":1,"open_issues_count":3,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2023-12-08T02:53:41.289Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/base2Services.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-11T02:30:09.000Z","updated_at":"2021-12-22T02:38:06.000Z","dependencies_parsed_at":"2023-01-21T09:47:35.457Z","dependency_job_id":null,"html_url":"https://github.com/base2Services/monitorable","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/base2Services%2Fmonitorable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/base2Services%2Fmonitorable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/base2Services%2Fmonitorable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/base2Services%2Fmonitorable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/base2Services","download_url":"https://codeload.github.com/base2Services/monitorable/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228476046,"owners_count":17926134,"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":[],"created_at":"2024-12-06T14:09:46.206Z","updated_at":"2024-12-06T14:09:46.294Z","avatar_url":"https://github.com/base2Services.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Monitorable\n\nQuery an AWS account for resources monitorable by cloudwatch alarms and report on alarm coverage of those resources\n\n## Getting started\n\nExport IAM credentials with read only permissions to the AWS account you want to query \n\n### Access Keys\n\n```bash\nexport AWS_ACCESS_KEY_ID=\"XXXXXXXXXXXXXXXXXXXXX\"\nexport AWS_SECRET_ACCESS_KEY=\"XXXXXXXXXXXXXXXXXXXXX\"\nexport AWS_SESSION_TOKEN=\"XXXXXXXXXXXXXXXXXXXXX\"\n```\n\n### Profile reference\n\nUsing the appropriate name from ```~/.aws/credentials```\n```bash\nexport AWS_PROFILE=\"XXXXXXXXXXXXXXXXXXXXX\"\n```\n\n## Usage\n\n```bash\n./monitorable.py -h\nusage: monitorable.py [-h] [--format FORMAT] [--regions REGIONS]\n\noptional arguments:\n  -h, --help         show this help message and exit\n  --format FORMAT    output format\n  --regions REGIONS  comma seperated list of regions to query\n```\n\n## Available options\n\nargument | example value | description\n--- | --- | ---\nformat | audit | query monitorable resources and cloudwatch alarms in each region and report on alarm coverage of resources\nformat | cfn-monitor | query monitorable resources and output in cfn-monitor alarms config format with default templates\nformat | cfn-guardian | query monitorable resources and output in cfn-guardian alarms config format with default templates\nformat | tags | shows all tags on monitorable resources and lists which resources have each tag. useful to discover 'tag coverage' and to help to choose good candidates to use with the --tag argument\ntag | Environment | groups output by different tag values. e.g. `--tag Environment` will group resources by those tagged with `Environment:prod` and `Environment:stage`\nformat | json | query monitorable resources and output in json format\nformat | yaml | query monitorable resources and output in yaml format\nregions | ap-southeast-2,us-west-2 | query monitorable resources only within the regions provided\n\n## Default options\n\nargument | value\n--- | ---\nformat | audit\nregions | all\n\n## Config file\n\nIn addtion to CLI args, you can also provide a config file. The file must be named `config.yaml` and reside in the same directory as monitorable.py\n\n#### Example config file\n\n```yaml\nformat: yaml\nregions:\n - ap-southeast-2\n - us-west-2\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbase2services%2Fmonitorable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbase2services%2Fmonitorable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbase2services%2Fmonitorable/lists"}