{"id":16280962,"url":"https://github.com/anaynayak/aws-cloudwatch-annotations","last_synced_at":"2025-06-21T04:41:55.908Z","repository":{"id":32837072,"uuid":"142463126","full_name":"anaynayak/aws-cloudwatch-annotations","owner":"anaynayak","description":"Add Cloudwatch horizontal/vertical annotations e.g. deployment annotations","archived":false,"fork":false,"pushed_at":"2023-10-17T07:22:24.000Z","size":1309,"stargazers_count":12,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-17T21:26:25.335Z","etag":null,"topics":["annotations","aws","aws-cloudwatch","cloudwatch","dashboard","deployment"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/anaynayak.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2018-07-26T15:56:38.000Z","updated_at":"2024-05-10T06:19:33.000Z","dependencies_parsed_at":"2023-01-16T22:45:11.812Z","dependency_job_id":null,"html_url":"https://github.com/anaynayak/aws-cloudwatch-annotations","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anaynayak%2Faws-cloudwatch-annotations","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anaynayak%2Faws-cloudwatch-annotations/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anaynayak%2Faws-cloudwatch-annotations/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anaynayak%2Faws-cloudwatch-annotations/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anaynayak","download_url":"https://codeload.github.com/anaynayak/aws-cloudwatch-annotations/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221733328,"owners_count":16871848,"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":["annotations","aws","aws-cloudwatch","cloudwatch","dashboard","deployment"],"created_at":"2024-10-10T19:04:13.721Z","updated_at":"2024-10-27T21:07:02.213Z","avatar_url":"https://github.com/anaynayak.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aws-cloudwatch-annotations ![Build](https://travis-ci.org/anaynayak/aws-cloudwatch-annotations.svg?branch=master) ![Downloads](https://img.shields.io/npm/dw/aws-cloudwatch-annotations) ![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/aws-cloudwatch-annotations)\n\n\n\u003e Annotate Cloudwatch dashboards with horizontal/vertical annotations\n\n## Install \n```\n$ npm install --global aws-cloudwatch-annotations\n```\n\n## Usage\n```\n$ aws-cloudwatch-annotations help\nUsage:\n    aws-cloudwatch-annotations dashboard_name\nOptions:\n    --fill, -f              Fill value for annotation (before/after/between)\n    --color, -c             Annotation color\n    --widget-title, -w      Update only widgets whose title matching specified regex\n    --limit, -l             Max number of annotations to maintain\n    --title, -t             Annotation title. Default: 'Deployment'\n    --value, -v             Annotation value. Default: Current time\n    --horizontal, -h        Add horizontal annotation instead of vertical (default)\n```\n\nInitial setup for AWS credentials available via environment variables or via the shared credentials file is necessary. Please look at [AWS credentials documentation](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) for details.\n\nIf `aws-cloudwatch-annotations` is run on an EC2 instance add the following permissions to the instance role. Adapt it with the correct AWS account ID and dashboard name(s).\n```json\n{\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"cloudwatch:PutDashboard\",\n                \"cloudwatch:GetDashboard\"\n            ],\n            \"Resource\": [\n                \"arn:aws:cloudwatch::123456789123:dashboard/annotations\"\n            ]\n        }\n    ]\n}\n```\n\n## Examples\n\n```\n# Vertical annotation between two timestamps\naws-cloudwatch-annotations api-metrics --widget-title annotations --title 'Deployment #42' --value '2018-08-28T11:56:47Z' --upto '2018-08-29T11:59:47Z'\n\n# Vertical annotation at a single timestamp\naws-cloudwatch-annotations api-metrics --widget-title annotations --title 'Enable feature toggle' --value '2018-08-28T11:56:47Z' \n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanaynayak%2Faws-cloudwatch-annotations","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanaynayak%2Faws-cloudwatch-annotations","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanaynayak%2Faws-cloudwatch-annotations/lists"}