Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v2.0.0 Roadmap #17

Closed
Issif opened this issue May 9, 2019 · 0 comments
Closed

v2.0.0 Roadmap #17

Issif opened this issue May 9, 2019 · 0 comments
Labels
kind/feature New feature or request
Milestone

Comments

@Issif
Copy link
Member

Issif commented May 9, 2019

Before integrating new outputs I'm planning some changes (and possible breaks) for a v2.0.0. Here what and why.

Configuration

Until now, configuration is only possible through environment variables, I would like to add a config file as the number of option is increasing as long I'm adding new outputs. My idea is to use https://github.com/spf13/viper and use its capacity to handle different methods for configuration with a hierarchy "env vars > yaml config file > default values".

Add Test & Code Coverage

For that, I need to change some methods, some of outputs have endpoint of their services which are hard coded. For adding tests, I will add function to create Client object with as much modifiable parameters that needed.

Automatic code coverage test will run on https://coveralls.io/.

Remove useless handlers

✔️ #18

/checkpayload is not usefull anymore, DEBUG config option will print input and outputs in stdout.

✔️ #18

Change format of output configuration in logs

✔️ #18 #19

We have currently :

2018/10/11 08:53:25 [INFO] : Outputs configuration : Slack=enabled, Datadog=disabled, Alertmanager=disabled

That will be :

2018/10/11 08:53:25 [INFO] : Enabled Outputs : Slack
2018/10/11 08:53:25 [INFO] : Disabled Outputs : Datadog, Alertmanager

This syntax is more concise.

Add stats

Add /stats handler that will return a json with classic metrics (number of goroutines, heap, etc) from expvar package and custom ones :

  • number of inputs from falco
  • number of OK sents to different outputs
  • number of KO sents to different outputs

Enable/Disable detailed view for Slack output

✔️ #18

refer #15

Add an helm chart

refer #16

@Issif Issif added kind/feature New feature or request new feature labels May 9, 2019
@Issif Issif added this to the 2.0.0 milestone May 9, 2019
@Issif Issif mentioned this issue May 23, 2019
Issif added a commit that referenced this issue May 23, 2019
## 2.0.0 - 2019-05-23
#### New 
- New output : **Elasticsearch** ([issue #14](https://github.com/Issif/falcosidekick/issues/14))
- **New configuration method : we can now use a config file in YAML and/or env vars** (see *README*) ([issue #17](https://github.com/Issif/falcosidekick/issues/17))
- New endpoint : `/debug/vars` gives access to Golang + Custom metrics (see *README*) ([issue #17](https://github.com/Issif/falcosidekick/issues/17))
#### Enhancement
- Add a lot of unit tests for code coverage ([issue #17](https://github.com/Issif/falcosidekick/issues/17))
- Some log outputs have been reformated
- 💥 Some env variables have been renamed again to match fields in YAML config files (*see README*)
#### Fix
- Panic are now catched to avoid crashes
@Issif Issif closed this as completed May 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant