# CloudWatch Golden Signals Dashboard AWS CDK Construct
Create Amazon CloudWatch Dashboards for monitoring CloudWatch Metrics of AWS Resources partitioned in golden signals. *Latency, Traffic, Errors, Saturation*
You can create tag based CloudWatch dashbord solution out of the box using this construct! [Here](https://github.com/cdklabs/cdk-golden-signals-dashboard/tree/main/dashboard-images) are some screen captures of CloudWatch dashboards created using this cdk construct.
# Supported Resource Types
* AWS::DynamoDB::Table
* AWS::Lambda::Function
* AWS::RDS::DBInstance
* AWS::SNS::Topic
* AWS::AutoScaling::AutoScalingGroup
# Usage
<summary>Including in a CDK application</summary>
```python
# Example automatically generated from non-compiling source. May contain errors.
from aws_cdk import App, Stack, StackProps
from constructs import Construct
from golden_signals_dashboard import GoldenSignalDashboard
class MyStack(Stack):
def __init__(self, scope, id, *, description=None, env=None, stackName=None, tags=None, synthesizer=None, terminationProtection=None, analyticsReporting=None):
super().__init__(scope, id, description=description, env=env, stackName=stackName, tags=tags, synthesizer=synthesizer, terminationProtection=terminationProtection, analyticsReporting=analyticsReporting)
GoldenSignalDashboard(self, "dynamodbDashboard",
resource_type="AWS::DynamoDB::Table",
dashboard_name="myGSDashboard",
resource_dimensions=[{"resource_region": "us-east-1", "resources": ["Table1", "Table2"]}],
create_alarms=True
)
app = App()
MyStack(app, "golden-signals-sample-app-dev")
app.synth()
```
# Contributing
See [CONTRIBUTING](./CONTRIBUTING.md) for more information.
# License Summary
This project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file for our project's licensing.
Raw data
{
"_id": null,
"home_page": "https://github.com/cdklabs/cdk-golden-signals-dashboard.git",
"name": "cdk-golden-signals-dashboard",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services<aws-cdk-dev@amazon.com>",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/50/3a/708c9ba7907a7c9405952ac3a3958deb0f2c217c5add9f39fda406d05154/cdk-golden-signals-dashboard-1.0.0.tar.gz",
"platform": null,
"description": "# CloudWatch Golden Signals Dashboard AWS CDK Construct\n\nCreate Amazon CloudWatch Dashboards for monitoring CloudWatch Metrics of AWS Resources partitioned in golden signals. *Latency, Traffic, Errors, Saturation*\n\nYou can create tag based CloudWatch dashbord solution out of the box using this construct! [Here](https://github.com/cdklabs/cdk-golden-signals-dashboard/tree/main/dashboard-images) are some screen captures of CloudWatch dashboards created using this cdk construct.\n\n# Supported Resource Types\n\n* AWS::DynamoDB::Table\n* AWS::Lambda::Function\n* AWS::RDS::DBInstance\n* AWS::SNS::Topic\n* AWS::AutoScaling::AutoScalingGroup\n\n# Usage\n\n<summary>Including in a CDK application</summary>\n\n```python\n# Example automatically generated from non-compiling source. May contain errors.\nfrom aws_cdk import App, Stack, StackProps\nfrom constructs import Construct\nfrom golden_signals_dashboard import GoldenSignalDashboard\n\n\nclass MyStack(Stack):\n def __init__(self, scope, id, *, description=None, env=None, stackName=None, tags=None, synthesizer=None, terminationProtection=None, analyticsReporting=None):\n super().__init__(scope, id, description=description, env=env, stackName=stackName, tags=tags, synthesizer=synthesizer, terminationProtection=terminationProtection, analyticsReporting=analyticsReporting)\n GoldenSignalDashboard(self, \"dynamodbDashboard\",\n resource_type=\"AWS::DynamoDB::Table\",\n dashboard_name=\"myGSDashboard\",\n resource_dimensions=[{\"resource_region\": \"us-east-1\", \"resources\": [\"Table1\", \"Table2\"]}],\n create_alarms=True\n )\napp = App()\nMyStack(app, \"golden-signals-sample-app-dev\")\napp.synth()\n```\n\n# Contributing\n\nSee [CONTRIBUTING](./CONTRIBUTING.md) for more information.\n\n# License Summary\n\nThis project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file for our project's licensing.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "cdk-golden-signals-dashboard",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/cdklabs/cdk-golden-signals-dashboard.git",
"Source": "https://github.com/cdklabs/cdk-golden-signals-dashboard.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0243cdef7c6ae87dac1f76eadad954a9b9f9d445ec7d7a9dac7f568b23c5a270",
"md5": "badef7bfff51deadd294481a1ec0965a",
"sha256": "6ad40d36f359eb3ec4956887cd514be4d084316288ee4e47fa053d8034dc98fd"
},
"downloads": -1,
"filename": "cdk_golden_signals_dashboard-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "badef7bfff51deadd294481a1ec0965a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 2109878,
"upload_time": "2023-09-04T04:27:15",
"upload_time_iso_8601": "2023-09-04T04:27:15.281760Z",
"url": "https://files.pythonhosted.org/packages/02/43/cdef7c6ae87dac1f76eadad954a9b9f9d445ec7d7a9dac7f568b23c5a270/cdk_golden_signals_dashboard-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "503a708c9ba7907a7c9405952ac3a3958deb0f2c217c5add9f39fda406d05154",
"md5": "8480fee702efe3c2bd50cfe2016ec692",
"sha256": "a57a1988ec80bf2e485c2395e83e7343fd70d411d7e007f891e960eb9eb848cc"
},
"downloads": -1,
"filename": "cdk-golden-signals-dashboard-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8480fee702efe3c2bd50cfe2016ec692",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 2110970,
"upload_time": "2023-09-04T04:27:17",
"upload_time_iso_8601": "2023-09-04T04:27:17.197893Z",
"url": "https://files.pythonhosted.org/packages/50/3a/708c9ba7907a7c9405952ac3a3958deb0f2c217c5add9f39fda406d05154/cdk-golden-signals-dashboard-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-04 04:27:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cdklabs",
"github_project": "cdk-golden-signals-dashboard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cdk-golden-signals-dashboard"
}
JSON
