https://github.com/frodeaa/status-checker
check HTTP status/latency with lambda
https://github.com/frodeaa/status-checker
cloudwatch-metrics lambda serverless
Last synced: 3 months ago
JSON representation
check HTTP status/latency with lambda
- Host: GitHub
- URL: https://github.com/frodeaa/status-checker
- Owner: frodeaa
- License: mit
- Created: 2018-01-28T22:21:15.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-24T10:31:34.000Z (over 1 year ago)
- Last Synced: 2024-12-24T11:43:37.934Z (over 1 year ago)
- Topics: cloudwatch-metrics, lambda, serverless
- Language: TypeScript
- Homepage:
- Size: 564 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# status-checker
status-checker is a small service which checks
the HTTP status code and latency for one or more
endpoints
The result is saved to AWS CloudWatch, where you can use
the result to trigger other events.
Following metrics are pushed to AWS CloudWatch using
namespace `status-checker/HTTP` and dimension `Endpoint`
and `Method`.
| MetricName | Description | Unit |
| :----------- | :--------------------- | -----------: |
| Latency | request time | Milliseconds |
| HTTPCode | HTTP status code | None |
| HTTPCode_YXX | Number of 2XX, 3XX,... | None |
## Getting Started
status-checker is configured by providing a JSON list of objects
with following properties.
- `url`: fully qualified URI, the endpoint to check
- `method`: http method (default: "GET")
- `headers` - http headers (default: {})
### Example
```
[
{"url": "example.com"},
{"url": "post.example.com", "method": "POST"},
{"url": "test.example.com", "headers": {"Authorization": "Basic "}}
]
```
### Installing
The application can be deployed with aws cloudformation.
https://github.com/frodeaa/status-checker/blob/b1e69d419767b323e779bf6b34b3fc8ce9eece08/e2e/scripts/create-status-checker-stack.sh#L3-L11
#### Configure status checker
Setup the status checker for an URL by creating a configuration stack
https://github.com/frodeaa/status-checker/blob/b1e69d419767b323e779bf6b34b3fc8ce9eece08/e2e/scripts/create-status-checker-configuration-stack.sh#L2-L18
> The default schedule is every 5 minutes. It can be changed by using the
> `StatusCheckerScheduleExpression` parameter.
### View metrics
The metrics can be view in AWS console or by querying using `aws`.
```
aws cloudwatch get-metric-statistics \
--metric-name Latency \
--start-time 2020-07-25T20:00:00 \
--end-time 2020-07-26T04:00:00 \
--period 60 \
--statistics Average \
--namespace status-checker/HTTP \
--dimensions \
'Name=Method,Value=GET' \
'Name=Endpoint,Value=http://example.com'
{
"Label": "Latency",
"Datapoints": [
{
"Timestamp": "2020-07-25T21:55:00+00:00",
"Average": 249.07750599999986,
"Unit": "Milliseconds"
},
{
"Timestamp": "2020-07-25T21:50:00+00:00",
"Average": 235.51812300000006,
"Unit": "Milliseconds"
}
]
}
```
## Development
> You can use `make` to run build and testing
```
build lint test e2e/test e2e/create-stacks yarn scripts
down up docker compose commands
```