Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/forter/cloudtrailbeat
An Elastic beat for cloudtrail w/ S3 -> SNS -> SQS
https://github.com/forter/cloudtrailbeat
beats cloudtrail cloudtrail-consumer cloudtrail-logs elasticbeats go golang
Last synced: about 1 month ago
JSON representation
An Elastic beat for cloudtrail w/ S3 -> SNS -> SQS
- Host: GitHub
- URL: https://github.com/forter/cloudtrailbeat
- Owner: forter
- License: other
- Created: 2019-05-05T12:06:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-21T19:22:08.000Z (over 1 year ago)
- Last Synced: 2024-08-03T23:27:25.793Z (4 months ago)
- Topics: beats, cloudtrail, cloudtrail-consumer, cloudtrail-logs, elasticbeats, go, golang
- Language: Go
- Size: 32.9 MB
- Stars: 1
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-golang-repositories - cloudtrailbeat - > SNS -> SQS (Repositories)
README
# Cloudtrailbeat
An Elastic beat for cloudtrail w/ S3 -> SNS -> SQS
Welcome to Cloudtrailbeat.
Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/forter/cloudtrailbeat`
## Getting Started with Cloudtrailbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.7
### Init Project
To get running with Cloudtrailbeat and also install the
dependencies, run the following command:
```
make setup
```
It will create a clean git history for each major step. Note that you can always rewrite the history if you wish before pushing your changes.
To push Cloudtrailbeat in the git repository, run the following commands:
```
git remote set-url origin https://github.com/forter/cloudtrailbeat
git push origin master
```
For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
### Build
To build the binary for Cloudtrailbeat run the command below. This will generate a binary
in the same directory with the name cloudtrailbeat.
```
make
```
### Run
To run Cloudtrailbeat with debugging output enabled, run:
```
./cloudtrailbeat -c cloudtrailbeat.yml -e -d "*"
```
### Test
To test Cloudtrailbeat, run the following command:
```
make testsuite
```
alternatively:
```
make unit-tests
make system-tests
make integration-tests
make coverage-report
```
The test coverage is reported in the folder `./build/coverage/`
### Update
Each beat has a template for the mapping in elasticsearch and a documentation for the fields
which is automatically generated based on `fields.yml` by running the following command.
```
make update
```
### Cleanup
To clean Cloudtrailbeat source code, run the following command:
```
make fmt
```
To clean up the build directory and generated artifacts, run:
```
make clean
```
### Clone
To clone Cloudtrailbeat from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/src/github.com/forter/cloudtrailbeat
git clone https://github.com/forter/cloudtrailbeat ${GOPATH}/src/github.com/forter/cloudtrailbeat
```
For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
## Packaging
The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires [docker](https://www.docker.com/) and vendoring as described above. To build packages of your beat, run the following command:
```
make release
```
This will fetch and create all images required for the build process. The whole process to finish can take several minutes.
=======