Skip to content

Commit

Permalink
Added github links to npm page + absolute image refs in README
Browse files Browse the repository at this point in the history
  • Loading branch information
lmammino committed Jun 18, 2021
1 parent a4537f1 commit 9073cb2
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 26 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ Lambda dashboard widgets show:

|Errors|Throttles|Duration Average, P95 and Maximum|
|--|--|--|
|![Errors](/docs/lambdaErrors.png)|![Throttles](/docs/lambdaThrottles.png) |![Throttles](/docs/lambdaDurationP95.png) |
|![Errors](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/lambdaErrors.png)|![Throttles](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/lambdaThrottles.png) |![Throttles](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/lambdaDurationP95.png) |
|**Invocations**|**Concurrent Executions**|**Iterator Age**|
|![Invocations](/docs/lambdaInvocations.png) |![concurrent executions](/docs/lambdaConcurrentExecutions.png) |![Iterator Age](/docs/lambdaIteratorAge.png) |
|![Invocations](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/lambdaInvocations.png) |![concurrent executions](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/lambdaConcurrentExecutions.png) |![Iterator Age](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/lambdaIteratorAge.png) |

### API Gateway

Expand All @@ -56,7 +56,7 @@ API Gateway dashboard widgets show:

|5XX Errors|4XX Errors|Latency|Count|
|--|--|--|--|
|![5XX Errors](/docs/api5xx.png)|![4XX Errors](/docs/api4xx.png) |![Latency](/docs/apiLatency.png) |![Count](/docs/apiCount.png) |
|![5XX Errors](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/api5xx.png)|![4XX Errors](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/api4xx.png) |![Latency](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/apiLatency.png) |![Count](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/apiCount.png) |

### DynamoDB

Expand All @@ -71,9 +71,9 @@ dynamodbGSIReadThrottle.png dynamodbGSIWriteThrottle.png dynamodbTableWri

|ReadThrottleEvents (Table)| WriteThrottleEvent (Table)|
|---|---|
|![WriteThrottleEvents Table](/docs/dynamodbTableWriteThrottle.png)|![WriteThrottleEvents Table](/docs/dynamodbTableWriteThrottle.png)|
|![WriteThrottleEvents Table](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/dynamodbTableWriteThrottle.png)|![WriteThrottleEvents Table](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/dynamodbTableWriteThrottle.png)|
|**ReadThrottleEvents (GSI)**|**WriteThrottleEvent (GSI)**|
|![WriteThrottleEvents GSI](/docs/dynamodbGSIWriteThrottle.png)|![WriteThrottleEvents GSI](/docs/dynamodbGSIWriteThrottle.png)|
|![WriteThrottleEvents GSI](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/dynamodbGSIWriteThrottle.png)|![WriteThrottleEvents GSI](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/dynamodbGSIWriteThrottle.png)|

### Kinesis Data Streams
Kinesis data stream alarms are created for:
Expand All @@ -88,7 +88,7 @@ Kinesis data stream dashboard widgets show:

|Iterator Age|Read Provisioned Throughput Exceeded|Write Provisioned Throughput Exceeded|
|--|--|--|
|![Iterator Age](/docs/kinesisIteratorAge.png)|![Provisioned Throughput Exceeded](/docs/kinesisProvisionedThroughput.png) |![Put/Get Success](/docs/kinesisPutGetSuccess.png) |
|![Iterator Age](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/kinesisIteratorAge.png)|![Provisioned Throughput Exceeded](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/kinesisProvisionedThroughput.png) |![Put/Get Success](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/kinesisPutGetSuccess.png) |

### SQS Queues

Expand All @@ -100,7 +100,7 @@ SQS queue dashboard widgets show:

|Messages Sent, Received and Deleted|Messages Visible|Age of Oldest Message|
|--|--|--|
|![Messages](/docs/sqsMessages.png)|![Messages Visible](/docs/sqsMessagesInQueue.png) |![Oldest Message](/docs/sqsOldestMessage.png) |
|![Messages](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/sqsMessages.png)|![Messages Visible](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/sqsMessagesInQueue.png) |![Oldest Message](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/sqsOldestMessage.png) |

### Step Functions

Expand All @@ -112,7 +112,7 @@ Step Function alarms are created for:
The dashboard contains one widget per Step Function:
|ExecutionsFailed ExecutionThrottled, ExecutionsTimedOut|
|--|
|![Step Function widget](/docs/stepFunctions.png)
|![Step Function widget](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/stepFunctions.png)

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"serverless-plugin",
"serverless-test-project"
],
"version": "1.0.0-beta.2"
"version": "1.0.0-beta.3"
}
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"name": "slic-watch",
"version": "1.0.0-beta.2",
"version": "1.0.0-beta.3",
"description": "Root project for SLIC Watch",
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/fourTheorem/slic-watch.git"
},
"scripts": {
"install": "lerna bootstrap",
"audit": "npm audit --omit dev && lerna exec npm audit -- --omit dev",
Expand Down
4 changes: 2 additions & 2 deletions serverless-plugin/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion serverless-plugin/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
{
"name": "serverless-slic-watch-plugin",
"version": "1.0.0-beta.2",
"version": "1.0.0-beta.3",
"description": "Serverless plugin for automatic alarms and dashboards",
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/fourTheorem/slic-watch.git",
"directory": "serverless-plugin"
},
"scripts": {
"test": "tap --coverage-report=html --no-browser --no-check-coverage tests/**/*.test.js",
"prepublish": "cp ../README.md README.md"
Expand Down
18 changes: 9 additions & 9 deletions serverless-test-project/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions serverless-test-project/package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
{
"name": "serverless-test-project",
"version": "1.0.0-beta.2",
"version": "1.0.0-beta.3",
"description": "Test project for SLIC Watch serverless plugin",
"main": "basic-handler.js",
"repository": {
"type": "git",
"url": "https://github.com/fourTheorem/slic-watch.git",
"directory": "serverless-test-project"
},
"license": "ISC",
"devDependencies": {
"ajv": "^6.12.6",
"serverless": "^2.38.0",
"serverless-slic-watch-plugin": "^1.0.0-beta.2",
"serverless-slic-watch-plugin": "^1.0.0-beta.3",
"serverless-step-functions": "^2.30.0"
},
"scripts": {
Expand Down

0 comments on commit 9073cb2

Please sign in to comment.