Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanfreitag/csv-to-heartbeat-yml
https://github.com/stefanfreitag/csv-to-heartbeat-yml
aws cdk elastic heartbeat
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stefanfreitag/csv-to-heartbeat-yml
- Owner: stefanfreitag
- License: apache-2.0
- Created: 2020-11-26T18:53:03.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T14:22:51.000Z (3 months ago)
- Last Synced: 2024-10-09T13:41:36.756Z (2 months ago)
- Topics: aws, cdk, elastic, heartbeat
- Language: Ruby
- Homepage:
- Size: 1.11 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Convert CVS file to HeartBeat configuration files
I was working on the installation and configuration of Elasti.co [Heartbeat](https://www.elastic.co/guide/en/beats/heartbeat/current/heartbeat-overview.html) and found
it quite boring to create the required YAML files for all the services that required monitoring. Hence I decided to automate this tasks:
- As input a CSV file is used. The first row of this file is treated as header. Its format is
| Column | Meaning |
| --- | --- |
| 0 | Type of check (either `tcp` or `http`) |
| 1 | Name of support unit (team owning the monitored service, can be used for alarming)|
| 2 | Name of application |
| 3 | Environment (e.g. production, staging, test, development) |
| 4 | Name of service |
| 5 | Endpoints to monitor (comma-separated) |
| 6 | Tags (comma-separated) |
| 7 | Schedule in seconds|
| 8 | Check timeout in seconds|
- The output is a zip archive containing all the YAML files for the services.
After unzipping the archive the YAML files may require an update on ownership (to the user running heartbeat) and permissions (0x644).
## Deploying the CDK stack
This [CDK](https://github.com/aws/aws-cdk) application deploys the [Ruby](https://www.ruby-lang.org/en/) application as a [Lambda](https://aws.amazon.com/lambda/) function and makes it available via an [API Gateway](https://aws.amazon.com/api-gateway/).
### Preparing the Lambda layer
The [Lambda](https://aws.amazon.com/lambda/) layer contains these libraries
- [rubyzip](https://github.com/rubyzip/rubyzip)
- csv
```bash
$ cd assets
$ mkdir -p ./vendor/bundle
$ bundle config set path ./vendor/bundle
$ bundle install
Fetching gem metadata from https://rubygems.org/..
Resolving dependencies...
Using bundler 2.1.4
Using csv 3.1.9
Using rubyzip 2.3.0
Bundle complete! 2 Gemfile dependencies, 3 gems now installed.
Bundled gems are installed into `./vendor/bundle`
```
## Deploy/ Undeploy the application
- Installing all dependencies required to build the CDK application.
```bash
$ npm install
$ npm run build
```
- Deploying the stack
```bash
$ cdk deploy --profile
```
- Undeploying the stack
```bassh
$ cdk destroy --profile
```
## Usage
The CSV file containing the information can be uploaded e.g. via curl.
```sh
curl -X POST --data-binary @data.csv -H 'Content-Type:text/csv' https://.eu-central-1.amazonaws.com/prod/converter --output test.zip
```
## Links
- [AWS CDK](https://github.com/aws/aws-cdk)
- [curl](https://curl.se/)
- [API Gateway Payload Encodings Workflow](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings-workflow.html)
- [HeartBeat Reference YML](https://www.elastic.co/guide/en/beats/heartbeat/current/heartbeat-reference-yml.html)
## ToDos
- Investigate on [fastercsv](https://rubygems.org/gems/fastercsv)