{"id":20678224,"url":"https://github.com/codecentric/serverless-plugin-cloudwatch-dashboard","last_synced_at":"2025-04-19T21:16:46.205Z","repository":{"id":33870348,"uuid":"162565266","full_name":"codecentric/serverless-plugin-cloudwatch-dashboard","owner":"codecentric","description":null,"archived":false,"fork":false,"pushed_at":"2022-06-01T09:05:15.000Z","size":406,"stargazers_count":14,"open_issues_count":5,"forks_count":7,"subscribers_count":113,"default_branch":"master","last_synced_at":"2025-03-29T13:34:46.273Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/codecentric.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-20T10:40:29.000Z","updated_at":"2023-06-02T01:49:00.000Z","dependencies_parsed_at":"2022-09-05T16:41:35.164Z","dependency_job_id":null,"html_url":"https://github.com/codecentric/serverless-plugin-cloudwatch-dashboard","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecentric%2Fserverless-plugin-cloudwatch-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecentric%2Fserverless-plugin-cloudwatch-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecentric%2Fserverless-plugin-cloudwatch-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecentric%2Fserverless-plugin-cloudwatch-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codecentric","download_url":"https://codeload.github.com/codecentric/serverless-plugin-cloudwatch-dashboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249805627,"owners_count":21327901,"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-11-16T21:19:27.893Z","updated_at":"2025-04-19T21:16:46.177Z","avatar_url":"https://github.com/codecentric.png","language":"JavaScript","readme":"Serverless CloudWatch Dashboards Plugin\n=============================\n[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)\n[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png)](https://raw.githubusercontent.com/codecentric/serverless-plugin-cloudwatch-dashboard/master/LICENSE)\n\nServerless plugin to generate AWS CloudWatch dashboard for deployed lambdas\n\n**Requirements:**\n* Serverless *v1.12.x* or higher\n* AWS provider\n\n## Setup\n\n\n### Installation\n\nInstall via npm in the root of your Serverless service:\n\n```sh\nnpm install serverless-plugin-cloudwatch-dashboard\n```\n\nAdd the plugin to the `plugins` array of your Serverless service in `serverless.yml`:\n\n```yml\nplugins:\n  - serverless-plugin-cloudwatch-dashboard\n```\n\n### Configuration\n\nThe plugin can be configured by adding a property called `dashboard` to the custom properties of the Serverless\nservice. Following dashboards are currently supported:\n- [Lambda Dashboards](#lambda-dashboards)\n- [DynamoDB Dashboards](#dynamoDB-dashboards)\n\n#### Lambda Dashboards\n\nThe configuration can specify the lambda `metrics` together with the `stats` of the metrics to \nbe added. The plugin will then generate one dashboard for each metric, with each dashboard containing the \nspecified statistics for each lambda function.\n\nLambda dashboards can be globally activated/deactivated for all functions by adding an `enabled` flag to the configuration.\n\nThis is the minimum required configuration:\n```yaml\ndashboard:\n  lambda:\n    enabled: true\n```\n\nThe default configuration looks like this:\n```yaml\ndashboard:\n  lambda:\n    metrics: [ Duration, Errors, Invocations, Throttles ]\n    stats: [p99, p95, p90, p50]\n    enabled: true\n```\n\nTo gain maximum control over which functions to be included, you can disable lambda dashboards globally,\n```yaml\ndashboard:\n  lambda:\n    enabled: false\n```\nand enable it only for specific functions, by setting the `dashboard` flag for those functions to `true`:\n```yaml\nfunctions:\n    myFunction:\n      handler: some_handler\n      dashboard: true\n```\n#### DynamoDB Dashboards\n\nThe configuration can specify the `metrics` for DynamoDB Tables and GlobalSecondaryIndexes to be added. The plugin will \nthen generate a new dashboard containing one widget for each metric.\n\nDynamoDB dashboards can be globally activated/deactivated for all tables by adding an `enabled` flag to the \nconfiguration.\n\nThis is the minimum required configuration:\n```yaml\ndashboard:\n  dynamoDB:\n    enabled: true\n```\n\nThe default configuration looks like this:\n```yaml\ndashboard:\n  dynamoDB:\n    enabled: true\n    metrics:\n      - ProvisionedReadCapacityUnits\n      - ConsumedReadCapacityUnits\n      - ProvisionedWriteCapacityUnits\n      - ConsumedWriteCapacityUnits\n```\n\n## Contribute\nAny contribution is more than welcome. \n\n* Clone the code\n* Install the dependencies with `npm install`\n* Create a feature branch `git checkout -b new_feature`\n* Lint with standard `npm run lint`\n* Create a pull request\n\n## License\n\nThis software is released under the MIT license. See [the license file](LICENSE) for more details.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecentric%2Fserverless-plugin-cloudwatch-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodecentric%2Fserverless-plugin-cloudwatch-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecentric%2Fserverless-plugin-cloudwatch-dashboard/lists"}