Skip to content

Commit b0662b5

Browse files
committed
Updated README.md
1 parent 67e8c67 commit b0662b5

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# Derive Application Log Insights Using Amazon CloudWatch Connector for Automated Data Analytics on AWS
22

33
## Background
4-
This repository provides an AWS CDK solution that is used to demonstrate the capabilities of ADA on AWS Solution. [Automated Data Analytics on AWS (ADA)](https://aws.amazon.com/solutions/implementations/automated-data-analytics-on-aws/) is an AWS Solution that enables users to derive meaningful insights from data in a matter of minutes through a simple and intuitive user interface. Using this repository, we will demonstrate how an Application Developer or an Application Tester is able to leverage ADA to derive operational insights of applications running in AWS. ADA’s data products allows users to connect to a wide range of data sources so that users can query the datasets as if they are querying Relational Database Tables.
4+
This repository provides an AWS CDK solution that is used to demonstrate the capabilities of ADA on AWS Solution. [Automated Data Analytics on AWS (ADA)](https://aws.amazon.com/solutions/implementations/automated-data-analytics-on-aws/) is an AWS Solution that enables users to derive meaningful insights from data in a matter of minutes through a simple and intuitive user interface. Using this repository, we will demonstrate how an Application Developer or an Application Tester is able to leverage ADA to derive operational insights of applications running in AWS. ADA’s data products allows users to connect to a wide range of data sources so that users can query the datasets as if they are querying Relational Database Tables.
5+
6+
## Solution overview
7+
Refer to the diagram below to get an overview of the architecture and workflow of using ADA to gain insights into application logs.
8+
![CDK Deployment.](./image/SA.png "solution overview")
59

610
## Prerequisites
711
1. Install the [AWS Command Line Interface](https://aws.amazon.com/cli/)
812
1. AWS CDK [prerequisites](https://docs.aws.amazon.com/cdk/v2/guide/work-with.html)
913
1. TypeScript-specific [prerequisites](https://docs.aws.amazon.com/cdk/v2/guide/work-with-cdk-typescript.html)
10-
1. [git] (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
14+
1. [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
1115

1216
## Setting up the Sample Application Infrastructure using AWS CDK
1317
The steps to clone the repo and to set up AWS CDK project are listed below. Before running the commands below, be sure to [configure](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) your AWS Credentials by choosing the North Virginia (us-east-1) region for the deployment. Create a folder, open Terminal and navigate to the folder where the AWS CDK solution needs to be installed.
@@ -28,36 +32,28 @@ These steps perform the following:
2832
1. Deploy the stack using AWS CloudFormation in the user’s AWS account.
2933

3034
The following resources are provisioned in the user’s AWS Account in the North Virginia (us-east-1) region:
31-
1. An Amazon Lambda Function that simulates the logging application and an Amazon EventBridge rule that invokes the Application Amazon Lambda function at a 2-minute interval.
32-
1. An Amazon S3 Bucket with the relevant bucket policies and a .csv file that contains the historical application logs.
33-
1. An Amazon DynamoDB table with the lookup data.
34-
1. Relevant IAM roles and permissions required for the services.
35+
1. An Amazon Lambda Function that simulates the logging application and an Amazon EventBridge rule that invokes the Application Amazon Lambda function at a 2-minute interval.
36+
1. An Amazon S3 Bucket with the relevant bucket policies and a .csv file that contains the historical application logs.
37+
1. An Amazon DynamoDB table with the lookup data.
38+
1. Relevant IAM roles and permissions required for the services.
3539

3640
The deployment takes about 1-2 minutes and creates the Amazon DynamoDB lookup table, Application Lambda function and Amazon S3 bucket containing the historical log files as outputs.
37-
![CDK Deployment.](./image/cdk_deploy.jpg "CDK Deployment.")
41+
![Solution overview](./image/cdk_deploy.jpg "Solution overview")
3842

3943
## Tear Down
40-
4144
Tearing down the sample application infrastructure is a two-step process. First, to remove the infrastructure provisioned for the purposes of this demo, execute the following command in the Terminal.
42-
4345
```
4446
cdk destroy
4547
```
46-
4748
For the following question, enter ‘y’ and CDK will delete the resources deployed for the demo.
48-
4949
```
5050
Are you sure you want to delete: CdkStack (y/n)? y
5151
```
52-
5352
Alternatively, the resources can be removed from the AWS Console by navigating the ‘CloudFormation’ service, selecting the ‘CdkStack’ and selecting ‘Delete’ option.
5453
![CloudFormation Destroy.](./image/cf_destroy.jpg "CloudFormation Destroy.")
5554

56-
5755
## Security
58-
5956
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
6057

6158
## License
62-
6359
This library is licensed under the MIT-0 License. See the LICENSE file.

0 commit comments

Comments
 (0)