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.

Sign up for GitHub

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

Jump to bottom

Adjust the documentation of backoff options in filestream input #30552

Merged
merged 1 commit into from
Feb 23, 2022
Merged

Adjust the documentation of backoff options in filestream input #30552

merged 1 commit into from
Feb 23, 2022

Conversation

kvch
Copy link
Contributor

@kvch kvch commented Feb 23, 2022

What does this PR do?

This PR cleans up the backoff section of filestream documentation. The information was outdated in a few places. It stated that filestream backs of linearly, however, it does backoff exponentially.

References to scan_frequency was updated to prospector.scanner.check_interval.

The default value of backoff.init is set to 2s, so Filebeat can really back off exponentially.

Why is it important?

Address confusion, update docs.

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.

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Feb 23, 2022
@mergify mergify bot assigned kvch Feb 23, 2022
@mergify
Copy link
Contributor

mergify bot commented Feb 23, 2022

This pull request does not have a backport label. Could you fix it @kvch? 🙏
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.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Feb 23, 2022
@kvch kvch added backport-v7.16.0 Automated backport with mergify backport-7.17 Automated backport to the 7.17 branch with mergify backport-v8.0.0 Automated backport with mergify backport-v8.1.0 Automated backport with mergify Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team and removed backport-skip Skip notification from the automated backport with mergify labels Feb 23, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Feb 23, 2022
@kvch kvch removed their assignment Feb 23, 2022
@mergify mergify bot assigned kvch Feb 23, 2022
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-02-23T10:49:13.886+0000

  • Duration: 102 min 4 sec

Test stats 🧪

Test Results
Failed 0
Passed 8673
Skipped 1122
Total 9795

💚 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.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@kvch kvch merged commit dc8ed37 into elastic:main Feb 23, 2022
mergify bot pushed a commit that referenced this pull request Feb 23, 2022
@kvch
Adjust the documentation of backoff options in filestream input (#3…
6aea152 
…0552)

(cherry picked from commit dc8ed37)
@mergify mergify bot mentioned this pull request Feb 23, 2022
Merged
mergify bot pushed a commit that referenced this pull request Feb 23, 2022
@kvch
Adjust the documentation of backoff options in filestream input (#3…
aa8cf9d 
…0552)

(cherry picked from commit dc8ed37)
@mergify mergify bot mentioned this pull request Feb 23, 2022
Merged
mergify bot pushed a commit that referenced this pull request Feb 23, 2022
@kvch
Adjust the documentation of backoff options in filestream input (#3…
b469079 
…0552)

(cherry picked from commit dc8ed37)
@mergify mergify bot mentioned this pull request Feb 23, 2022
Merged
mergify bot pushed a commit that referenced this pull request Feb 23, 2022
@kvch
Adjust the documentation of backoff options in filestream input (#3…
f10c215 
…0552)

(cherry picked from commit dc8ed37)
@mergify mergify bot mentioned this pull request Feb 23, 2022
Merged
kvch added a commit that referenced this pull request Feb 23, 2022
@mergify @kvch
Adjust the documentation of backoff options in filestream input (#3…
1d05ba8 
…0552) (#30555)

(cherry picked from commit dc8ed37)

Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com>
kvch added a commit that referenced this pull request Feb 23, 2022
@mergify @kvch
Adjust the documentation of backoff options in filestream input (#3…
6e9dd49 
…0552) (#30556)

(cherry picked from commit dc8ed37)

Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com>
kvch added a commit that referenced this pull request Feb 23, 2022
@mergify @kvch
Adjust the documentation of backoff options in filestream input (#3…
7b50258 
…0552) (#30557)

(cherry picked from commit dc8ed37)

Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com>
kvch added a commit that referenced this pull request Feb 23, 2022
@mergify @kvch
Adjust the documentation of backoff options in filestream input (#3…
2580bcd 
…0552) (#30554)

(cherry picked from commit dc8ed37)

Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com>
v1v added a commit that referenced this pull request Mar 2, 2022
@v1v
Merge branch '8.1' of github.com:elastic/beats into mergify/bp/8.1/pr…
0112148 
…-29710

* '8.1' of github.com:elastic/beats: (51 commits)
  refactor pushDockerImages (#30414) (#30624)
  ci: add windows-2022 in the extended meta-stage (#30528) (#30630)
  Curate k8s testing versions to only keep the actively maintained (#30619) (#30625)
  [8.1](backport #30355) Add Beats upgrade docs for 8.0 (#30612)
  Remove references to gcp from the Functionbeat docs (#30579) (#30609)
  x-pack/auditbeat/module/system/socket: defend against exec with zero arguments (#30586) (#30597)
  [MySQL Enterprise] Adding default paths values to manifest.yml (#30598) (#30604)
  metricbeat - fix elasticsearch and kibana integration tests failures in 8.0 (#30566) (#30594)
  Install gawk as a replacement for mawk in Docker containers. (#30452) (#30465)
  [Filebeat] Remove RecordedFuture dataset from Threat Intel module (#30564) (#30568)
  Adjust the documentation of `backoff` options in filestream input (#30552) (#30557)
  packetbeat/beater: help the GC clean up the Npcap installer if it's not used (#30513) (#30546)
  Osquerybeat: Add install verification for osquerybeat (#30388) (#30404)
  Update docker/distribution to 2.8.0 (#30462) (#30540)
  Add `parsers` examples to `filestream` reference configuration (#30529) (#30537)
  [8.1](backport #30068) ZooKeeper module: Adapt to ZooKeeper 3.6+ `mntr` response fields' changes. (#30360)
  [8.1](backport #30512) Switch skip to use `CI` (#30525)
  Forward-port 8.0.1 changelog to 8.1 (#30517)
  packetbeat/beater: don't attempt to install npcap when already installed (#30509) (#30511)
  Add drop and explicit tests to avoid duplicate ingest of elasticsearch logs (#30440) (#30488)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@P1llus P1llus P1llus approved these changes

Assignees

@kvch kvch

Labels
backport-7.17 Automated backport to the 7.17 branch with mergify backport-v7.16.0 Automated backport with mergify backport-v8.0.0 Automated backport with mergify backport-v8.1.0 Automated backport with mergify Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kvch @elasticmachine @P1llus