├── .gitignore ├── NOTICE ├── images ├── apitracker.1.png ├── apitracker.2.png ├── apitracker.3.png ├── apitracker.4.png ├── apitracker.5.png ├── apitracker.7.png ├── apitracker.8.png ├── api-tracker.1.png ├── api-tracker.10.png ├── api-tracker.11.png ├── api-tracker.2.png ├── api-tracker.3.png ├── api-tracker.4.png ├── api-tracker.5.png ├── api-tracker.6.png ├── api-tracker.7.png ├── api-tracker.8.png ├── api-tracker.9.png ├── apitracker.10.png ├── apitracker.13.png ├── apitracker.14.png ├── apitracker.15.png └── apitracker.16.png ├── nodejs ├── package.json └── app.js ├── sam.yaml ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules 3 | nodejs/node_modules 4 | sam-output.yaml 5 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | cloudwatch-api-tracker 2 | Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 | -------------------------------------------------------------------------------- /images/apitracker.1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.1.png -------------------------------------------------------------------------------- /images/apitracker.2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.2.png -------------------------------------------------------------------------------- /images/apitracker.3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.3.png -------------------------------------------------------------------------------- /images/apitracker.4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.4.png -------------------------------------------------------------------------------- /images/apitracker.5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.5.png -------------------------------------------------------------------------------- /images/apitracker.7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.7.png -------------------------------------------------------------------------------- /images/apitracker.8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.8.png -------------------------------------------------------------------------------- /images/api-tracker.1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.1.png -------------------------------------------------------------------------------- /images/api-tracker.10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.10.png -------------------------------------------------------------------------------- /images/api-tracker.11.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.11.png -------------------------------------------------------------------------------- /images/api-tracker.2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.2.png -------------------------------------------------------------------------------- /images/api-tracker.3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.3.png -------------------------------------------------------------------------------- /images/api-tracker.4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.4.png -------------------------------------------------------------------------------- /images/api-tracker.5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.5.png -------------------------------------------------------------------------------- /images/api-tracker.6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.6.png -------------------------------------------------------------------------------- /images/api-tracker.7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.7.png -------------------------------------------------------------------------------- /images/api-tracker.8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.8.png -------------------------------------------------------------------------------- /images/api-tracker.9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/api-tracker.9.png -------------------------------------------------------------------------------- /images/apitracker.10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.10.png -------------------------------------------------------------------------------- /images/apitracker.13.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.13.png -------------------------------------------------------------------------------- /images/apitracker.14.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.14.png -------------------------------------------------------------------------------- /images/apitracker.15.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.15.png -------------------------------------------------------------------------------- /images/apitracker.16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/cloudwatch-api-tracker/HEAD/images/apitracker.16.png -------------------------------------------------------------------------------- /nodejs/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cloudwatch-api-tracker", 3 | "version": "0.1.1", 4 | "description": "This lambda function will post CloudWatch metrics based on API usage data from CloudWatch Logs.", 5 | "main": "app.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "https://github.com/awslabs/cloudwatch-api-tracker.git" 12 | }, 13 | "keywords": [ 14 | "aws", 15 | "api", 16 | "tracker" 17 | ], 18 | "author": "Ho Ming Li, Jeremy Wallace, Joe Hsieh", 19 | "license": "Apache 2.0", 20 | "dependencies": {} 21 | } 22 | -------------------------------------------------------------------------------- /nodejs/app.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /** 4 | * Cloudwatch API Tracker 5 | * 6 | * This lambda function will publish CloudWatch metrics based on API usage. 7 | * It listens to a CloudWatch Log Stream that is associated with a CloudTrail log, 8 | * and publishes metrics in specified batches. 9 | * 10 | * Authors: Joe Hsieh, Uzi Ashkenazi, Ho Ming Li, Jeremy Wallace 11 | 12 | Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. 13 | 14 | Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at 15 | 16 | http://aws.amazon.com/apache2.0/ 17 | 18 | or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 19 | 20 | Note: Other license terms may apply to certain, identified software files contained within or 21 | distributed with the accompanying software if such terms are included in the directory containing 22 | the accompanying software. Such other license terms will then apply in lieu of the terms of the 23 | software license above. 24 | 25 | **/ 26 | 27 | const AWS = require('aws-sdk'); 28 | const cloudwatch = new AWS.CloudWatch(); 29 | const zlib = require('zlib'); 30 | 31 | const NAMESPACE = "API-COUNT"; 32 | const JITTER_MS = 3000; // spread "PutMetricData" calls to avoid throttling at scale 33 | const BATCH = 20; // batch size for "PutMetricData" call 34 | 35 | exports.handler = function (input, context, callback) { 36 | 37 | // API metrics array. 38 | let apiMetrics = {}; 39 | 40 | // decode input from base64 41 | const zippedInput = new Buffer(input.awslogs.data, 'base64'); 42 | 43 | // decompress the input 44 | zlib.gunzip(zippedInput, function (err, buffer) { 45 | 46 | if (err) { callback(err); } 47 | 48 | // Parse JSON from input. 49 | 50 | const awslogsData = JSON.parse(buffer.toString('utf8')); 51 | 52 | if (awslogsData.messageType === 'CONTROL_MESSAGE') { 53 | callback(null, "Successfully posted control message!"); 54 | } 55 | 56 | // Populate metrics params array from log events. 57 | 58 | console.log(awslogsData.logEvents.length + " events captured."); 59 | 60 | awslogsData.logEvents.forEach(function (logEvent, index, logEventsArr) { 61 | 62 | const event = JSON.parse(logEvent.message); 63 | 64 | const hash = [event.eventTime, event.eventName, event.awsRegion, event.eventSource]; 65 | 66 | // Filling any undefined values to prevent errors on "PutMetricData" call. 67 | 68 | for (index in hash) { 69 | if (!hash[index]) { hash[index] = '-' } 70 | } 71 | 72 | if (apiMetrics[hash]) { 73 | apiMetrics[hash].Value++; 74 | } else { 75 | apiMetrics[hash] = { 76 | Timestamp: hash[0], 77 | MetricName: hash[1], 78 | Dimensions: [{ 79 | Name: 'awsRegion', 80 | Value: hash[2] 81 | }, { 82 | Name: 'eventSource', 83 | Value: hash[3] 84 | }], 85 | Value: 1 86 | }; 87 | } 88 | 89 | }); 90 | 91 | let apiMetricParams = []; 92 | let promiseList = []; 93 | 94 | // Submit every 20 metric (BATCH size) 95 | 96 | for (const hash in apiMetrics) { 97 | apiMetricParams.push(apiMetrics[hash]); 98 | if (apiMetricParams.length == BATCH) { 99 | promiseList.push(postToCloudWatch(apiMetricParams)); 100 | apiMetricParams = []; 101 | } 102 | } 103 | 104 | // Submit final set of metric 105 | 106 | if (apiMetricParams.length > 0) promiseList.push(postToCloudWatch(apiMetricParams)); 107 | 108 | // Ensure all data posted before callback 109 | 110 | Promise.all(promiseList).then(function (val) { 111 | console.log("Successfully posted " + val + " events!"); 112 | callback(null, "Successfully posted " + val + " events!"); 113 | }).catch(function (err) { 114 | console.log('A promise failed to resolve', err); 115 | callback(err); 116 | }); 117 | }); 118 | }; 119 | 120 | /** 121 | * This function invokes "PutMetricData" and publishes an array of data 122 | * to CloudWatch. 123 | **/ 124 | function postToCloudWatch(chunkedDataArray) { 125 | return new Promise(function (resolve, reject) { 126 | const params = { 127 | MetricData: chunkedDataArray, 128 | Namespace: NAMESPACE 129 | }; 130 | 131 | setTimeout(function () { 132 | cloudwatch.putMetricData(params, function (err, data) { 133 | if (err) { 134 | console.log(err, err.stack); 135 | reject(err); 136 | } else { 137 | console.log(JSON.stringify(data)); 138 | resolve(chunkedDataArray.length); 139 | } 140 | }) 141 | }, Math.floor(Math.random() * JITTER_MS)); 142 | }); 143 | } 144 | -------------------------------------------------------------------------------- /sam.yaml: -------------------------------------------------------------------------------- 1 | AWSTemplateFormatVersion: "2010-09-09" 2 | Transform: "AWS::Serverless-2016-10-31" 3 | Description: Server-side API Tracker 4 | 5 | Parameters: 6 | ### NEW TRAIL IF CLOUDTRAIL LOG GROUP NOT DEFINED 7 | ### USE EXISTING TRAIL LOG GROUP IF DEFINED 8 | 9 | CloudTrailLogGroupName: 10 | Default: "" 11 | Type: String 12 | Description: Enter existing cloudtrail log group name (leave empty for new trail) 13 | 14 | Conditions: 15 | NeedsNewTrail: !Equals ["", !Ref CloudTrailLogGroupName] 16 | 17 | Resources: 18 | #### Resources for New Trail #### 19 | # S3 bucket, Role, Trail, Log Group 20 | 21 | NewTrail: 22 | Condition: NeedsNewTrail 23 | Type: AWS::CloudTrail::Trail 24 | Properties: 25 | CloudWatchLogsLogGroupArn: !GetAtt NewTrailCWLogGroup.Arn 26 | CloudWatchLogsRoleArn: !GetAtt NewTrailRole.Arn 27 | S3BucketName: 28 | Ref: NewTrailBucket 29 | IsLogging: true 30 | IsMultiRegionTrail: true 31 | IncludeGlobalServiceEvents: true 32 | 33 | NewTrailRole: 34 | Condition: NeedsNewTrail 35 | Type: "AWS::IAM::Role" 36 | Properties: 37 | AssumeRolePolicyDocument: 38 | Version: "2012-10-17" 39 | Statement: 40 | - Effect: "Allow" 41 | Principal: 42 | Service: "cloudtrail.amazonaws.com" 43 | Action: 44 | - "sts:AssumeRole" 45 | Policies: 46 | - PolicyName: "CTtoLogs" 47 | PolicyDocument: 48 | Version: "2012-10-17" 49 | Statement: 50 | - Effect: "Allow" 51 | Action: 52 | - "logs:PutLogEvents" 53 | - "logs:CreateLogStream" 54 | Resource: 55 | !Join [ 56 | ":", 57 | [ 58 | "arn:aws:logs", 59 | !Ref "AWS::Region", 60 | !Ref "AWS::AccountId", 61 | "log-group", 62 | !Ref NewTrailCWLogGroup, 63 | "log-stream:*", 64 | ], 65 | ] 66 | 67 | NewTrailCWLogGroup: 68 | Condition: NeedsNewTrail 69 | Type: "AWS::Logs::LogGroup" 70 | Properties: 71 | RetentionInDays: 7 72 | 73 | NewTrailBucket: 74 | Condition: NeedsNewTrail 75 | Type: "AWS::S3::Bucket" 76 | Properties: 77 | LifecycleConfiguration: 78 | Rules: 79 | - ExpirationInDays: 7 80 | Status: "Enabled" 81 | 82 | NewTrailBucketPolicy: 83 | Condition: NeedsNewTrail 84 | Type: "AWS::S3::BucketPolicy" 85 | Properties: 86 | Bucket: 87 | Ref: NewTrailBucket 88 | PolicyDocument: 89 | Version: "2012-10-17" 90 | Statement: 91 | - Sid: "AWSCloudTrailAclCheck" 92 | Effect: "Allow" 93 | Principal: 94 | Service: "cloudtrail.amazonaws.com" 95 | Action: "s3:GetBucketAcl" 96 | Resource: !Sub |- 97 | arn:aws:s3:::${NewTrailBucket} 98 | - Sid: "AWSCloudTrailWrite" 99 | Effect: "Allow" 100 | Principal: 101 | Service: "cloudtrail.amazonaws.com" 102 | Action: "s3:PutObject" 103 | Resource: !Sub |- 104 | arn:aws:s3:::${NewTrailBucket}/AWSLogs/${AWS::AccountId}/* 105 | Condition: 106 | StringEquals: 107 | s3:x-amz-acl: "bucket-owner-full-control" 108 | 109 | #### Resources related to Lambda Function #### 110 | # Log Group, Function 111 | 112 | APITrackerCWLogs: 113 | Type: "AWS::Logs::LogGroup" 114 | Properties: 115 | LogGroupName: !Join ["/", ["/aws/lambda", !Ref APITrackerLambdaFunction]] 116 | RetentionInDays: 7 117 | 118 | APITrackerLambdaFunction: 119 | Type: "AWS::Serverless::Function" 120 | Properties: 121 | Runtime: "nodejs14.x" 122 | CodeUri: nodejs 123 | Handler: app.handler 124 | Description: "Send CloudTrail Event Counts to CloudWatch Metrics" 125 | MemorySize: 128 126 | Timeout: 10 127 | Policies: 128 | - CloudWatchPutMetricPolicy: {} 129 | 130 | #### Resources for CW Logs to Lambda #### 131 | # CW Log Filter, Lambda Permission 132 | 133 | CloudTrailLogFilter: 134 | Type: "AWS::Logs::SubscriptionFilter" 135 | Properties: 136 | DestinationArn: !GetAtt [APITrackerLambdaFunction, Arn] 137 | LogGroupName: 138 | !If [ 139 | NeedsNewTrail, 140 | !Ref NewTrailCWLogGroup, 141 | !Ref CloudTrailLogGroupName, 142 | ] 143 | FilterPattern: "" 144 | DependsOn: LambdaPermission 145 | 146 | LambdaPermission: 147 | Type: "AWS::Lambda::Permission" 148 | Properties: 149 | Action: "lambda:InvokeFunction" 150 | FunctionName: !GetAtt [APITrackerLambdaFunction, Arn] 151 | Principal: !Join [".", ["logs", !Ref "AWS::Region", "amazonaws.com"]] 152 | SourceAccount: !Ref AWS::AccountId 153 | SourceArn: 154 | !Join [ 155 | ":", 156 | [ 157 | "arn:aws:logs", 158 | !Ref "AWS::Region", 159 | !Ref "AWS::AccountId", 160 | "log-group", 161 | !If [ 162 | NeedsNewTrail, 163 | !Ref NewTrailCWLogGroup, 164 | !Ref CloudTrailLogGroupName, 165 | ], 166 | "*", 167 | ], 168 | ] 169 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AWS API Usage Tracker 2 | 3 | This application was designed to give customers greater insight into their AWS API usage by generating custom CloudWatch Metrics based on CloudTrail logs. 4 | 5 | **VERSION:** 0.1.1 6 | 7 | **AUTHORS:** Joe Hsieh, Uzi Ashkenazi, Ho Ming Li, Jeremy Wallace 8 | 9 | ## Design 10 | 11 | Here is the data flow: 12 | - Amazon CloudTrail is configured to send API logs to Amazon CloudWatch Logs. 13 | - AWS Lambda is triggered by new records that are written to the CloudWatch Log Stream. 14 | - AWS Lambda aggregates the number of API requests and publishes custom Amazon CloudWatch Metrics. 15 | 16 | By default, if an existing Cloudwatch Log Group is not specified during deployment, a new multi-region trail is created for the purpose of tracking Cloudtrail events. If you would like to use an existing trail, specify it as the `CloudTrailLogGroupName` parameter for CloudFormation. 17 | 18 | # Installation 19 | 20 | Below are two different ways of configuring your AWS environment to collect metrics on API usage using this lambda function. You could configure the AWS environment with the command line, or through the web console. 21 | 22 | ## Quick Start - Command Line Installation (Recommended) 23 | 24 | 1. If you do not have an s3 bucket you can use, create one. 25 | 26 | ``` 27 | $ aws s3 mb s3:// 28 | ``` 29 | 30 | 2. Define the S3 bucket and prefix for SAM artifacts 31 | 32 | ``` 33 | $ export S3_BUCKET= 34 | $ export S3_PREFIX=cloudwatch-api-tracker-sam-artifacts 35 | ``` 36 | 37 | 3. Transform the SAM template to get the output template for CloudFormation 38 | 39 | ``` 40 | $ aws cloudformation package --template-file sam.yaml --output-template-file sam-output.yaml --s3-bucket $S3_BUCKET --s3-prefix $S3_PREFIX 41 | ``` 42 | 43 | 4. Deploy the SAM output template 44 | 45 | a. creates a new trail 46 | 47 | ``` 48 | $ aws cloudformation deploy --template-file sam-output.yaml --stack-name cloudwatch-api-tracker --capabilities CAPABILITY_IAM 49 | ``` 50 | 51 | b. using an existing trail - ensure you have CloudTrail logs sent to CloudWatch Logs. [Follow the guide here](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html). Replace $CloudWatchLogGroupName with your own. 52 | ``` 53 | $ aws cloudformation deploy --template-file sam-output.yaml --stack-name cloudwatch-api-tracker --capabilities CAPABILITY_IAM --parameter-overrides CloudTrailLogGroupName=$CloudWatchLogGroupName 54 | ``` 55 | 56 | 5. Soon after CloudFromation stack creation completes, verify that the lambda function is being invoked and that no errors are produced. 57 | 58 | Congratulations! You have set up API tracker. You will now start to see metrics in CloudWatch. 59 | 60 | ## Console Installation 61 | 62 | Please follow the instructions below to configure API tracker. 63 | 64 | ### Part One: Enable CloudTrail and CloudWatch Logs 65 | 66 | 1. Create an AWS account and sign in to the *AWS Management Console*. 67 | 2. Click Services in the top navigation then under Management & Governance, click on **CloudTrail**. 68 | 69 | ![CloudTrail trails](images/api-tracker.1.png) 70 | 71 | 3. Click **Trails** on the left menu bar. 72 | 4. Click the orange **Add Trail** button. 73 | 74 | ![CloudTrail trails](images/api-tracker.2.png) 75 | 76 | 5. Name the trail and pick an *S3* bucket location to store the logs. 77 | 6. Provide a *Customer managed AWS KMS key* alias or choose an existing one. 78 | 7. In the section *CloudWatch Logs*, tick the **Enabled** and provide an *IAM Role* name. 79 | 80 | ![CloudTrail trails](images/api-tracker.3.png) 81 | 82 | 8. A *CloudWatch Log Group* will be created, adjust or accept the default name. 83 | 9. Review the *IAM* policy and add any tags (optional). 84 | 85 | ![CloudTrail trails](images/api-tracker.4.png) 86 | 87 | 10. Click next. Select log event type (Management Events is selected by default). 88 | 89 | ![CloudTrail trails](images/api-tracker.5.png) 90 | 91 | 11. Click Next review the settings and click the *Create trail* orange button. 92 | 93 | ### Part Two: Configure and Upload the Lambda function 94 | 95 | 1. Locally on your machine, run **npm install** inside the **nodejs** directory (cloudwatch-api-tracker). 96 | 2. Create a new zip file based on the contents of this directory (cloudwatch-api-tracker). 97 | 3. Open the *Lambda* Console page. 98 | 99 | ![CloudTrail trails](images/api-tracker.6.png) 100 | 101 | 4. Create a new lambda function. 102 | 103 | ![CloudTrail trails](images/api-tracker.7.png) 104 | 105 | 5. Select the **Author from scratch** option provide a function name and select **Node.js** as the runtime. 106 | 6. Click create function. 107 | 7. Add a CloudWatch Logs Trigger. 108 | 109 | ![CloudTrail trails](images/api-tracker.8.png) 110 | 7. Name the filter and use the CloudTrail Log Group created at trail creation. 111 | 112 | ![CloudTrail trails](images/api-tracker.9.png) 113 | 114 | 8. Press Add. 115 | 9. Upload the ZIP file that you created above. 116 | 117 | ![CloudTrail trails](images/api-tracker.10.png) 118 | 119 | 10. Set the handler to app.handler. 120 | 121 | ![CloudTrail trails](images/api-tracker.11.png) 122 | 123 | 11. Create a new IAM role for the Lambda function with the following IAM policy. 124 | ``` 125 | { 126 | "Version": "2012-10-17", 127 | "Statement": [ 128 | { 129 | "Effect": "Allow", 130 | "Action": [ 131 | "logs:CreateLogGroup", 132 | "logs:CreateLogStream", 133 | "logs:PutLogEvents" 134 | ], 135 | "Resource": "arn:aws:logs:*:*:*" 136 | }, 137 | { 138 | "Effect": "Allow", 139 | "Action": [ 140 | "cloudwatch:PutMetricData" 141 | ], 142 | "Resource": [ 143 | "*" 144 | ] 145 | } 146 | ] 147 | } 148 | ``` 149 | 150 | Congratulations! You have set up API tracker. You will now start to see metrics in CloudWatch. 151 | 152 | ## Things you can do with the metrics 153 | 154 | - Create a CloudWatch Alarm on a particular API. 155 | - Create a CloudWatch Dashboard with the most commonly used APIs. 156 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------