[Heartbeat] One shot mode #25972

andrewvc · 2021-05-27T19:04:01Z

In this mode heartbeat runs a single monitor once, writes all events to its output, then exits. See the included docs for examples and testing it. This is useful internally mostly as an experiment for now.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

Check the sample config

Related issues

Use cases

Screenshots

Logs

In this mode heartbeat runs a single monitor once, writes all events to its output, then exits.

botelastic · 2021-05-27T19:04:07Z

This pull request doesn't have a Team:<team> label.

elasticmachine · 2021-05-27T19:20:25Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2021-10-14T01:51:54.809+0000
Duration: 67 min 25 sec
Commit: 79251a9

Test stats 🧪

Test	Results
Failed	0
Passed	3543
Skipped	80
Total	3623

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.

spalger · 2021-06-09T19:55:34Z

While using this I plan to do setup logic outside of the process before telling heartbeat to execute a synthetic suite in one-shot mode. I'm planning on informing the "services" I am starting up in my journeys where ES and Kibana are via the environment, and it seems like https://github.com/elastic/beats/blob/master/x-pack/heartbeat/monitors/browser/synthexec/synthexec.go#L112 suggests this should work well, do you think it's safe to rely on this behavior?

andrewvc · 2021-08-17T22:13:36Z

@Mergifyio update

mergify · 2021-08-17T22:13:41Z

Command update: failure

Base branch update has failed
merge conflict between base and head
err-code: 209C6

BenB196 · 2021-09-21T17:19:56Z

I don't mean to pester, but are there any plans to move this forward? This would be a really good feature for things like automated CI/CD tests.

andrewvc · 2021-09-21T21:56:45Z

@BenB196 we have some internal use cases for this, but didn't think any external users would have cause to use it. Can you let us know more about what sort of testing you'd use this for? Normally you want tests run on a schedule, which is what heartbeat does.

BenB196 · 2021-09-21T22:14:25Z

@andrewvc sure. The main use case I see from this feature is the ability to abstract some "infrastructure" stuff from people writing test cases, while also giving them access to built in Elastic features; like the browser Observability features in Kibana, and machine learning for things like anomalously long response times on loading specific tests to detect regressions pre-production. All without having to do any custom integrations between playwright/synethics/elastic.

A bit more detail on the "infrastructure" part. It's far easier to provide someone a docker-compose file or a Kubernetes manifest with all of the base settings already set for Heartbeat, and then just tell them to insert their inline playwright script, or tell them to replace their zip_url information, than it is to have to essentially reinvent what Heartbeat does minus the scheduled run part.

andrewvc · 2021-09-21T22:20:03Z

That's really helpful @BenB196 , so, as I understand it, you're missing the Kibana side of what synthetics does, and being able to run one-offs would be helpful.

IMHO that's a good reason to finish off this PR (which is 80% done really, just needs docs, tests, cleanup etc.).

I would say, however, that Kibana/Uptime itself is really oriented around scheduled runs, monitors that occasionally run will be.... weird. How do you handle this? Do you ask your users to pop into Kibana and wait for the monitor to appear? Is this roughness OK?

BenB196 · 2021-09-21T22:36:40Z

@andrewvc yeah, you've pretty much got the gist of it. I think the Kibana roughness is fine honestly. It just requires a small amount of education on the user end about either having to wait a bit for the results to show up, or to expand the timeframe back further to see old/past runs for a monitor id/environment.

Also, a bit more of a technical/implementation side, from how I would see this being used. Is it would be more or less part of a jenkins (or similar) pipeline, where this would just be one part of a testing process. So most likely the pipeline would run, and by the time it is complete, the data will already be in Kibana/Elasticsearch for the user to review if needed. It was also allow for the user to use the Heartbeat/synthetic debug logs to track any kind of issues that may arise during the pipeline.

BenB196 · 2021-09-21T22:44:50Z

The one thing that I can't tell from the PR of whether it does this or not, but it would be nice for Heartbeat to exit with a code similar to how the monitor run exited. i.e. If browser run succeeds exit with 0, if it fails exit with 1, etc. That way from a jenkins (or similar) pipeline, it would be easy to tell right away if the test failed without having to do much looking around.

mergify · 2021-09-22T12:53:07Z

This pull request does not have a backport label. Could you fix it @andrewvc? 🙏
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 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

elasticmachine · 2021-10-13T16:00:27Z

Pinging @elastic/uptime (Team:Uptime)

vigneshshanmugam

LGTM

heartbeat/_meta/config/beat.yml.tmpl

vigneshshanmugam · 2021-10-13T17:20:47Z

heartbeat/beater/heartbeat.go

+		}
+		return nil
+	}
+
 	groups, _ := syscall.Getgroups()


Do we need to care about the permission model in one shot mode? or we are skipping it for now?

Good point, yes. FYI, that's just a log line, there's no impact on functionality, the actual perms are reset elsewhere. But I'll move the logline up higher.

vigneshshanmugam · 2021-10-13T17:25:03Z

heartbeat/config/config.go

@@ -27,7 +27,7 @@ import (

 // Config defines the structure of heartbeat.yml.
 type Config struct {
-	// Modules is a list of module specific configuration data.
+	OneShot         []*common.Config     `config:"one_shot"`


Dont want to deviate this PR in to some other direction, but are we okay with this naming or change it to something like RunOnce mode?

I like that idea, I think it's more clear, will change to run_once

heartbeat/monitors/plugin/plugin.go

CHANGELOG.next.asciidoc

vigneshshanmugam · 2021-10-13T23:39:16Z

heartbeat/docs/heartbeat-options.asciidoc

@@ -109,3 +109,37 @@ include::monitors/monitor-tcp.asciidoc[]
 include::monitors/monitor-http.asciidoc[]

 include::monitors/monitor-browser.asciidoc[]
+
+[float]
+[[one-shot-mode]]


Suggested change

[[one-shot-mode]]

[[run-once-mode]

vigneshshanmugam · 2021-10-13T23:39:48Z

heartbeat/beater/heartbeat.go

+	logp.Info("Starting run_once run. This is an experimental feature and may be changed or removed in the future!")
+	cfgs := bt.config.RunOnce
+
+	publishClient, err := core.NewSyncClient(logp.NewLogger("oneshot mode"), b.Publisher, beat.ClientConfig{})


Suggested change

publishClient, err := core.NewSyncClient(logp.NewLogger("oneshot mode"), b.Publisher, beat.ClientConfig{})

publishClient, err := core.NewSyncClient(logp.NewLogger("runonce mode"), b.Publisher, beat.ClientConfig{})

andrewvc · 2021-10-14T03:27:18Z

@Mergifyio backport 7.x

(cherry picked from commit 6d09457)

mergify · 2021-10-14T03:27:48Z

Command backport 7.x: success

Backports have been created

#28421 [Heartbeat] One shot mode (backport #25972) has been created for branch 7.x

Fixes elastic#28437. This is an improvement over elastic#25972 which had a more complicated config interface.

* [Heartbeat] Make run_once syntax a boolean Fixes #28437. This is an improvement over #25972 which had a more complicated config interface. * Fix python tests * Fix python

* [Heartbeat] Make run_once syntax a boolean Fixes #28437. This is an improvement over #25972 which had a more complicated config interface. * Fix python tests * Fix python (cherry picked from commit d31cae9)

* [Heartbeat] Make run_once syntax a boolean Fixes elastic#28437. This is an improvement over elastic#25972 which had a more complicated config interface. * Fix python tests * Fix python

[Heartbeat] One shot mode

da3ac63

In this mode heartbeat runs a single monitor once, writes all events to its output, then exits.

andrewvc added enhancement Heartbeat Team:obs-ds-hosted-services Label for the Observability Hosted Services team labels May 27, 2021

andrewvc requested a review from vigneshshanmugam May 27, 2021 19:04

andrewvc self-assigned this May 27, 2021

botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels May 27, 2021

spalger mentioned this pull request Jun 15, 2021

[discuss] Build on top of synthetics or use playwright directly? elastic/kibana#102279

Closed

andrewvc added 2 commits August 17, 2021 17:17

Merge remote-tracking branch 'origin/master' into oneshotoneop

304e766

Fix close

8124cb7

mergify bot added the backport-skip Skip notification from the automated backport with mergify label Sep 22, 2021

andrewvc added 6 commits October 12, 2021 20:17

Merge remote-tracking branch 'origin/master' into oneshotoneop

6356b52

Use a list of configs

d76408c

Handle lists of configs

a2c1029

Add integration tests for oneshot

e947a5b

Cleanup

aaca9ee

Add docs

415ec53

andrewvc added 2 commits October 13, 2021 10:35

Fixup x-pack

3caba44

Lint

fd1f054

andrewvc marked this pull request as ready for review October 13, 2021 16:00

andrewvc requested a review from a team as a code owner October 13, 2021 16:00

Changelog

c46d206

vigneshshanmugam approved these changes Oct 13, 2021

View reviewed changes

andrewvc added 2 commits October 13, 2021 15:21

Lint

0e1702e

incorporate PR feedback

b240496

vigneshshanmugam approved these changes Oct 13, 2021

View reviewed changes

andrewvc added 3 commits October 13, 2021 20:48

Update CHANGELOG.next.asciidoc

7913a18

PR feedback

b516061

Merge remote-tracking branch 'andrewvc/oneshotoneop' into oneshotoneop

79251a9

andrewvc merged commit 6d09457 into elastic:master Oct 14, 2021

mergify bot pushed a commit that referenced this pull request Oct 14, 2021

[Heartbeat] One shot mode (#25972)

36b34d6

(cherry picked from commit 6d09457)

mergify bot mentioned this pull request Oct 14, 2021

[Heartbeat] One shot mode (backport #25972) #28421

Merged

andrewvc pushed a commit that referenced this pull request Oct 14, 2021

[Heartbeat] One shot mode (#25972) (#28421)

e54d1f7

andrewvc deleted the oneshotoneop branch October 14, 2021 12:29

andrewvc mentioned this pull request Oct 14, 2021

[Heartbeat] Run Once mode #28437

Closed

andrewvc added a commit to andrewvc/beats that referenced this pull request Oct 19, 2021

[Heartbeat] Make run_once syntax a boolean

f1fa7f4

Fixes elastic#28437. This is an improvement over elastic#25972 which had a more complicated config interface.

andrewvc mentioned this pull request Oct 19, 2021

[Heartbeat] Make run_once syntax a boolean #28548

Merged

6 tasks

Icedroid pushed a commit to Icedroid/beats that referenced this pull request Nov 1, 2021

[Heartbeat] One shot mode (elastic#25972)

3f4409a

BenB196 mentioned this pull request Jan 19, 2022

[Heartbeat][Browser] Heartbeat as a Load Tester #29822

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Heartbeat] One shot mode #25972

[Heartbeat] One shot mode #25972

andrewvc commented May 27, 2021 •

edited

Loading

botelastic bot commented May 27, 2021

elasticmachine commented May 27, 2021 •

edited by jenkins-beats-ci bot

Loading

Build stats

Test stats 🧪

spalger commented Jun 9, 2021

andrewvc commented Aug 17, 2021

mergify bot commented Aug 17, 2021

BenB196 commented Sep 21, 2021

andrewvc commented Sep 21, 2021

BenB196 commented Sep 21, 2021 •

edited

Loading

andrewvc commented Sep 21, 2021

BenB196 commented Sep 21, 2021

BenB196 commented Sep 21, 2021 •

edited

Loading

mergify bot commented Sep 22, 2021

elasticmachine commented Oct 13, 2021

vigneshshanmugam left a comment

vigneshshanmugam Oct 13, 2021

andrewvc Oct 13, 2021

vigneshshanmugam Oct 13, 2021

andrewvc Oct 13, 2021

vigneshshanmugam Oct 13, 2021

vigneshshanmugam Oct 13, 2021

andrewvc commented Oct 14, 2021

mergify bot commented Oct 14, 2021

	publishClient, err := core.NewSyncClient(logp.NewLogger("oneshot mode"), b.Publisher, beat.ClientConfig{})
	publishClient, err := core.NewSyncClient(logp.NewLogger("runonce mode"), b.Publisher, beat.ClientConfig{})

[Heartbeat] One shot mode #25972

[Heartbeat] One shot mode #25972

Conversation

andrewvc commented May 27, 2021 • edited Loading

Checklist

Author's Checklist

Related issues

Use cases

Screenshots

Logs

botelastic bot commented May 27, 2021

elasticmachine commented May 27, 2021 • edited by jenkins-beats-ci bot Loading

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

spalger commented Jun 9, 2021

andrewvc commented Aug 17, 2021

mergify bot commented Aug 17, 2021

BenB196 commented Sep 21, 2021

andrewvc commented Sep 21, 2021

BenB196 commented Sep 21, 2021 • edited Loading

andrewvc commented Sep 21, 2021

BenB196 commented Sep 21, 2021

BenB196 commented Sep 21, 2021 • edited Loading

mergify bot commented Sep 22, 2021

elasticmachine commented Oct 13, 2021

vigneshshanmugam left a comment

Choose a reason for hiding this comment

vigneshshanmugam Oct 13, 2021

Choose a reason for hiding this comment

andrewvc Oct 13, 2021

Choose a reason for hiding this comment

vigneshshanmugam Oct 13, 2021

Choose a reason for hiding this comment

andrewvc Oct 13, 2021

Choose a reason for hiding this comment

vigneshshanmugam Oct 13, 2021

Choose a reason for hiding this comment

vigneshshanmugam Oct 13, 2021

Choose a reason for hiding this comment

andrewvc commented Oct 14, 2021

mergify bot commented Oct 14, 2021

andrewvc commented May 27, 2021 •

edited

Loading

elasticmachine commented May 27, 2021 •

edited by jenkins-beats-ci bot

Loading

BenB196 commented Sep 21, 2021 •

edited

Loading

BenB196 commented Sep 21, 2021 •

edited

Loading