feat: validate benchmark type #583

olegsu · 2022-12-15T14:25:25Z

What does this PR do?
This will use the new config.v1 structure to validate that the cloudbeat knows how to run the selected benchmark.
In case the benchmark is not supported it may fail fast or ignore and update the status.

When cloudbeat just started and the given configuration is based on a benchmark that is not supported, fail fast as there is nothing to do.
When a reconfiguration comes with an unsupported benchmark ignore it and update the status

This PR only uses config.v1.benchmark to not deal with the new structure that integrations pr adding ( cc @kfirpeled)

Related Issues
Related #239
Related elastic/integrations#4752

Checklist

I have added tests that prove my fix is effective or that my feature works
I have added the necessary README/documentation (if appropriate)

mergify · 2022-12-15T14:26:00Z

This pull request does not have a backport label. Could you fix it @olegsu? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-v./d./d./d is the label to automatically backport to the 8./d branch. /d is the digit
NOTE: backport-skip has been added to this pull request.

github-actions · 2022-12-15T15:34:18Z

Cloudbeat CI 🤖

Allure Report: http://csp-allure-reports.s3.amazonaws.com/allure_reports/cloudbeat/prs/583/index.html

amirbenun

Nice!

amirbenun · 2022-12-18T10:29:39Z

scripts/common.sh

-    # exec_pod $POD "elastic-agent restart" # https://github.com/elastic/cloudbeat/pull/458#issuecomment-1308837098
-  # done
+  for P in $(get_agents); do
+    exec_pod $POD "elastic-agent restart" # https://github.com/elastic/cloudbeat/pull/458#issuecomment-1308837098


You can remove the comment.
Also, I just noticed we are missing POD=$(echo $P | cut -d '/' -f 2).
Can you verify that it works?

You are right, will verify

amirbenun · 2022-12-18T10:47:03Z

config/config.go

 	Period     time.Duration           `config:"period"`
 	Processors processors.PluginConfig `config:"processors"`
 	BundlePath string                  `config:"bundle_path"`
+	Benchmark  string                  `config:"config.v1.benchmark"`


This change requires a matching change to the integration, isn't it?

We already have it https://github.com/elastic/integrations/pull/4752/files#diff-721297d41d05ea41cf84e1ee80fdda5ac230452caef26678a37e752e43fbb466R11

amirbenun · 2022-12-18T10:50:17Z

launcher/launcher.go

 				err := l.validator.Validate(update)
 				if err != nil {
 					l.log.Errorf("Config update validation failed: %v", err)
+					if errors.Is(err, cloudbeat_config.ErrBenchmarkNotSupported) {


The launcher was designed in a way it is agnostic to cloudbeat or any Beater implementation.
In that case, we can extend the Validator to support a special kind of error that will send that degraded message.
The only difference will be that the Validator accepts config.C instead of our struct.

In that case, we can update the validator behavior to return a boolean whether the configuration is valid or not.
So the validator will also receive the management.Manager to update the status.

I am not sure it's better as we still have a coupling between the launcher and the validator.

amirbenun · 2022-12-18T14:15:10Z

errors/errors.go

+// can help to end user to operate cloudbeat
+// for example when a cloudbeat configuration is invalid, this error will include
+// more information about what is missing/expected and maybe links to external sources as well
+type CloudbeatError struct {


I liked it, since I still don't want the launcher to be aware of cloudbeat I would just rename it.
Maybe BeaterDegradeError / BeaterUnhealthyError or some other name that indicates what is about to happen once this error is returned.
Also, it should reside near the launcher IMO.

This is good naming, will change the name.

Also, it should reside near the launcher IMO.

This might be an issue with imports

amirbenun

Last touch

amirbenun · 2022-12-19T08:13:10Z

launcher/launcher.go

 				if err != nil {
 					l.log.Errorf("Config update validation failed: %v", err)
+					heatlhErr := &cb_errors.BeaterUnhealthyError{}
+					if errors.As(err, heatlhErr) {


Let's test this new functionality, it can be a part of TestLauncherValidator

Also, note that you are checking the error that returned from the Validator but BeaterUnhealthyError error is actually returned from config.New and wrapped in the validator and probably won't get detected here.

Let's test this new functionality, it can be a part of TestLauncherValidator

I dont think we have an easy way to mock the Manager.UpdateStatus tbh.

Also, note that you are checking the error that returned from the Validator but BeaterUnhealthyError error is actually returned from config.New and wrapped in the validator and probably won't get detected here.

The test for the errors pkg checking exactly this. First, create the BeaterUnhealthyError and then wrap it, later test that using errors.As it will get the original error.

From golang https://pkg.go.dev/errors#As

As finds the first error in err's chain that matches target, and if one is found, sets target to that error value and returns true. Otherwise, it returns false.

amirbenun · 2022-12-19T08:23:31Z

errors/errors.go

+	msg string
+}
+
+func New(msg string) BeaterUnhealthyError {


Nit, rename the function to indicate the error type, maybe errors.NewBeaterUnhealthy(...)?

mergify · 2022-12-19T14:19:21Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b health-status-agent-v2 upstream/health-status-agent-v2
git merge upstream/main
git push upstream health-status-agent-v2

gurevichdmitry

@olegsu LGTM. scripts/common.sh approved.

mergify · 2022-12-19T15:37:13Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b health-status-agent-v2 upstream/health-status-agent-v2
git merge upstream/main
git push upstream health-status-agent-v2

…s-agent-v2

olegsu requested review from a team as code owners December 15, 2022 14:25

olegsu requested a review from gurevichdmitry December 15, 2022 14:25

mergify bot assigned olegsu Dec 15, 2022

mergify bot added the backport-skip label Dec 15, 2022

feat: validate benchmark type

4fa50cf

olegsu force-pushed the health-status-agent-v2 branch from 1dc08a6 to 4fa50cf Compare December 15, 2022 14:26

olegsu force-pushed the health-status-agent-v2 branch from d98fccb to aa9af3a Compare December 15, 2022 16:02

olegsu linked an issue Dec 18, 2022 that may be closed by this pull request

Support health status interface #239

Closed

3 tasks

olegsu force-pushed the health-status-agent-v2 branch from aa9af3a to 2ab04f5 Compare December 18, 2022 08:32

oren-zohar requested a review from amirbenun December 18, 2022 08:36

olegsu force-pushed the health-status-agent-v2 branch 4 times, most recently from 2ba924e to f9a9517 Compare December 18, 2022 09:56

amirbenun requested changes Dec 18, 2022

View reviewed changes

olegsu force-pushed the health-status-agent-v2 branch 2 times, most recently from 16fcd2b to 9daf134 Compare December 18, 2022 14:03

amirbenun reviewed Dec 18, 2022

View reviewed changes

olegsu force-pushed the health-status-agent-v2 branch from 9daf134 to 9f2c7b1 Compare December 18, 2022 18:40

Merge branch 'main' into health-status-agent-v2

1ebe7b9

olegsu force-pushed the health-status-agent-v2 branch from 9f2c7b1 to 1ebe7b9 Compare December 18, 2022 18:40

olegsu enabled auto-merge (squash) December 19, 2022 07:56

amirbenun reviewed Dec 19, 2022

View reviewed changes

Merge branch 'main' into health-status-agent-v2

db6084f

olegsu force-pushed the health-status-agent-v2 branch from fc5eda9 to db6084f Compare December 19, 2022 10:06

amirbenun approved these changes Dec 19, 2022

View reviewed changes

gurevichdmitry approved these changes Dec 19, 2022

View reviewed changes

olegsu force-pushed the health-status-agent-v2 branch 2 times, most recently from 90b3186 to 36d98fb Compare December 19, 2022 15:31

olegsu disabled auto-merge December 19, 2022 15:32

olegsu force-pushed the health-status-agent-v2 branch from 36d98fb to db6084f Compare December 19, 2022 15:36

Merge branch 'main' of github.com:elastic/cloudbeat into health-statu…

4bd0a5d

…s-agent-v2

olegsu merged commit d2638ce into elastic:main Dec 19, 2022

olegsu deleted the health-status-agent-v2 branch December 19, 2022 17:31

feat: validate benchmark type #583

feat: validate benchmark type #583

Uh oh!

Conversation

olegsu commented Dec 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mergify bot commented Dec 15, 2022

Uh oh!

github-actions bot commented Dec 15, 2022

Cloudbeat CI 🤖

Uh oh!

amirbenun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

olegsu Dec 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amirbenun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

olegsu Dec 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Dec 19, 2022

Uh oh!

gurevichdmitry left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Dec 19, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

olegsu commented Dec 15, 2022 •

edited

Loading

olegsu Dec 18, 2022 •

edited

Loading

olegsu Dec 19, 2022 •

edited

Loading