Updated dev guide instructions to work with master #30014

matschaffer · 2022-01-26T07:55:11Z

filebeat fails (hangs) on 8.0 due to Elasticsearch is too old. so updating to 8.1 as well as fixing up expectations around authentication and ssl.

I've also included a little extra information about how to run the tests, look for logs, and some options (including one that will be added by #30103)

Rel: #29880

filebeat fails (hangs) on 8.0 due to `Elasticsearch is too old.` so updating to 8.1 as well as fixing up expectations around authentication and ssl.

mergify · 2022-01-26T07:55:40Z

This pull request does not have a backport label. Could you fix it @matschaffer? 🙏
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 · 2022-01-26T07:55:46Z

Pinging @elastic/obs-docs (Team:Docs)

elasticmachine · 2022-01-26T08:15:10Z

💚 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

Reason: null
Start Time: 2022-02-01T02:46:14.532+0000
Duration: 22 min 30 sec
Commit: 88ba36a

❕ Flaky test report

No test was executed to be analysed.

🤖 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.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

matschaffer · 2022-01-27T03:19:10Z

Today I also found out that I could use tail -F build/system-tests/run/test_modules.Test.test_fileset_file_0_elasticsearch/output.log to watch the filebeat logs during system testing.

Might be good to update this to include something like that.

Additionally I'd like to link the modules dev doc to https://www.elastic.co/guide/en/beats/devguide/current/beats-contributing.html#running-testsuite somehow.

Today the "Testing guide" link just points to a stub page. The way I found the module dev guide was through searching Elastic internal slack history for other people learning how to run filebeat system tests.

jsoriano

👍

jsoriano · 2022-01-27T16:27:01Z

docs/devguide/modules-dev-guide.asciidoc

@@ -485,8 +485,10 @@ run.
 In order to test the filesets with the sample logs and/or generate the expected output one should run the tests
 locally for a specific module, using the following procedure under Filebeat directory:

-. Run an Elasticsearch instance locally using docker: `docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:8.0.0-SNAPSHOT`
+. Run an Elasticsearch instance locally using docker: `docker run --rm --name elasticsearch -p 9200:9200 -p 9300:9300 -e "ELASTIC_PASSWORD=changeme" -e "discovery.type=single-node" -e "xpack.security.http.ssl.enabled=false" docker.elastic.co/elasticsearch/elasticsearch:8.1.0-SNAPSHOT`


I think the idea of using 8.0.0-SNAPSHOT was to use the snapshot from master. Do you know if there is now any other snapshot following master? Otherwise we may need to update this on every minor release 🤔

Looks like master-SNAPSHOT works. Presumably this will switch to main-SNAPSHOT at some point but we can update when that happens and it should only happen once.

jsoriano · 2022-01-27T16:27:54Z

docs/devguide/modules-dev-guide.asciidoc

@@ -485,8 +485,10 @@ run.
 In order to test the filesets with the sample logs and/or generate the expected output one should run the tests
 locally for a specific module, using the following procedure under Filebeat directory:

-. Run an Elasticsearch instance locally using docker: `docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:8.0.0-SNAPSHOT`
+. Run an Elasticsearch instance locally using docker: `docker run --rm --name elasticsearch -p 9200:9200 -p 9300:9300 -e "ELASTIC_PASSWORD=changeme" -e "discovery.type=single-node" -e "xpack.security.http.ssl.enabled=false" docker.elastic.co/elasticsearch/elasticsearch:8.1.0-SNAPSHOT`
+. Create an "admin" user on that Elasticsearch instance: `curl -u elastic:changeme http://localhost:9200/_security/user/admin -X POST -H 'Content-Type: application/json' -d '{"password": "changeme", "roles": ["superuser"]}'`


Would these changes be also needed when running tests in CI? Let's see if this PR passes 🤔 #30012

You can also run these tests via mage pythonIntegTest TESTING_FILEBEAT_MODULES=elasticsearch which launches a number of docker-compose services and I suspect is where the admin user gets created and that CI is doing something similar.

That flow takes a very long time (15min) and has some local failures, so wasn't practical for module development.

elasticmachine · 2022-01-31T06:03:26Z

Pinging @elastic/integrations (Team:Integrations)

docs/devguide/modules-dev-guide.asciidoc

matschaffer · 2022-02-01T02:03:57Z

@elastic/obs-docs any idea why this fails? IntelliJ is able to resolve the <<testing>> when I have the file open.

What I'm trying to fix is how https://www.elastic.co/guide/en/beats/devguide/current/beats-contributing.html#running-testsuite links to https://www.elastic.co/guide/en/beats/devguide/current/testing.html (part of the packetbeat guide) rather than https://github.com/elastic/beats/blob/8bdc6d2d38c8762582dd27be66dc3053b5e61346/docs/devguide/testing.asciidoc

matschaffer · 2022-02-01T02:33:32Z

Ahhh. I think I got it. I opened elastic/docs#2364 to avoid the stumbling block I hit.

Also I think we need to add @elastic/obs-docs as a writer to https://github.com/elastic/docs - I can't add it as a PR review target which means it lacks repo permissions.

filebeat fails (hangs) on 8.0 due to `Elasticsearch is too old.` so updating to 8.1 as well as fixing up expectations around authentication, ssl, and information about options and where to find logs. (cherry picked from commit 3ed5763)

filebeat fails (hangs) on 8.0 due to `Elasticsearch is too old.` so updating to 8.1 as well as fixing up expectations around authentication, ssl, and information about options and where to find logs. (cherry picked from commit 3ed5763) Co-authored-by: Mat Schaffer <[email protected]>

Updated dev guide instructions to work with master

33ecc24

filebeat fails (hangs) on 8.0 due to `Elasticsearch is too old.` so updating to 8.1 as well as fixing up expectations around authentication and ssl.

matschaffer self-assigned this Jan 26, 2022

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jan 26, 2022

matschaffer requested review from jsoriano, ChrsMark and klacabane and removed request for jsoriano January 26, 2022 07:55

mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jan 26, 2022

matschaffer added docs release-note:dev_docs Contains a Dev Docs section Team:Docs Label for the Observability docs team and removed backport-skip Skip notification from the automated backport with mergify labels Jan 26, 2022

botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jan 26, 2022

mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jan 26, 2022

matschaffer mentioned this pull request Jan 26, 2022

[Filebeat] Update handling of elasticsearch server logs #30018

Merged

6 tasks

matschaffer requested a review from kvch January 27, 2022 03:18

jsoriano reviewed Jan 27, 2022

View reviewed changes

matschaffer mentioned this pull request Jan 31, 2022

Filebeat pytest improvements #30103

Merged

3 tasks

matschaffer added 3 commits January 31, 2022 14:52

Add a note about log file tailing

93c0f56

Prefix packetbeat testing to avoid conflict with beats testing page

8cba85c

Linking the filebeat module guide to the test docs

8bdc6d2

matschaffer requested review from ph and ruflin January 31, 2022 06:02

matschaffer added backport-v8.0.0 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Jan 31, 2022

matschaffer added the Team:Integrations Label for the Integrations team label Jan 31, 2022

ruflin reviewed Jan 31, 2022

View reviewed changes

docs/devguide/modules-dev-guide.asciidoc Show resolved Hide resolved

matschaffer added 4 commits February 1, 2022 11:22

Fix trailing space

5d502c1

Include testing doc in index

0f177e2

Fix protocol testing link reference

ff386c6

Cleaner link wording

c9dff1b

matschaffer mentioned this pull request Feb 1, 2022

Note that the full path is required for local doc build elastic/docs#2364

Merged

Document TESTING_FILEBEAT_ALLOW_OLDER

88ba36a

kvch approved these changes Feb 1, 2022

View reviewed changes

ph approved these changes Feb 1, 2022

View reviewed changes

matschaffer merged commit 3ed5763 into elastic:master Feb 1, 2022

matschaffer deleted the devguide-update-filebeat-test-instructions branch February 1, 2022 13:36

mergify bot mentioned this pull request Feb 1, 2022

[8.0](backport #30014) Updated dev guide instructions to work with master #30138

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated dev guide instructions to work with master #30014

Updated dev guide instructions to work with master #30014

matschaffer commented Jan 26, 2022 •

edited

Loading

mergify bot commented Jan 26, 2022

elasticmachine commented Jan 26, 2022

elasticmachine commented Jan 26, 2022 •

edited by jenkins-beats-ci bot

Loading

Build stats

matschaffer commented Jan 27, 2022 •

edited

Loading

jsoriano left a comment

jsoriano Jan 27, 2022

matschaffer Jan 31, 2022

jsoriano Jan 27, 2022

matschaffer Jan 31, 2022 •

edited

Loading

elasticmachine commented Jan 31, 2022

matschaffer commented Feb 1, 2022

matschaffer commented Feb 1, 2022

Updated dev guide instructions to work with master #30014

Updated dev guide instructions to work with master #30014

Conversation

matschaffer commented Jan 26, 2022 • edited Loading

mergify bot commented Jan 26, 2022

elasticmachine commented Jan 26, 2022

elasticmachine commented Jan 26, 2022 • edited by jenkins-beats-ci bot Loading

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

matschaffer commented Jan 27, 2022 • edited Loading

jsoriano left a comment

Choose a reason for hiding this comment

jsoriano Jan 27, 2022

Choose a reason for hiding this comment

matschaffer Jan 31, 2022

Choose a reason for hiding this comment

jsoriano Jan 27, 2022

Choose a reason for hiding this comment

matschaffer Jan 31, 2022 • edited Loading

Choose a reason for hiding this comment

elasticmachine commented Jan 31, 2022

matschaffer commented Feb 1, 2022

matschaffer commented Feb 1, 2022

matschaffer commented Jan 26, 2022 •

edited

Loading

elasticmachine commented Jan 26, 2022 •

edited by jenkins-beats-ci bot

Loading

matschaffer commented Jan 27, 2022 •

edited

Loading

matschaffer Jan 31, 2022 •

edited

Loading