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

{,x-pack/}packetbeat: fix documentation for flows period #35009

Merged
merged 1 commit into from Apr 14, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Apr 4, 2023

What does this PR do?

This fixes documentation that misdirects users to use "-1" as a sentinel. This value causes packetbeat to fail to configure.

See

duration := func(s string, d time.Duration) (time.Duration, error) {
if s == "" {
return d, nil
}
return time.ParseDuration(s)
}
timeout, err := duration(config.Timeout, defaultTimeout)
if err != nil {
logp.Err("failed to parse flow timeout: %v", err)
return nil, err
}
period, err := duration(config.Period, defaultPeriod)
if err != nil {
logp.Err("failed to parse period: %v", err)
return nil, err
}
and https://play.golang.com/p/Z7Si8WEzDAL.

Why is it important?

The current documentation misleads users to use an invalid value.

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

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 self-assigned this Apr 4, 2023
@efd6 efd6 force-pushed the i5771-packetbeat-docs branch 3 times, most recently from da69def to 9783d09 Compare April 4, 2023 01:58
@elasticmachine
Copy link
Collaborator

elasticmachine commented Apr 4, 2023

💚 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: 2023-04-04T03:27:32.707+0000

  • Duration: 48 min 34 sec

Test stats 🧪

Test Results
Failed 0
Passed 1742
Skipped 19
Total 1761

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the 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!)

@efd6 efd6 changed the title {,x-pack}/packetbeat: fix documentation for flows period {,x-pack/}packetbeat: fix documentation for flows period Apr 4, 2023
@efd6 efd6 marked this pull request as ready for review April 4, 2023 04:29
@efd6 efd6 requested a review from a team as a code owner April 4, 2023 04:29
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@efd6 efd6 merged commit d043a69 into elastic:main Apr 14, 2023
26 checks passed
mergify bot pushed a commit that referenced this pull request Apr 14, 2023
mergify bot pushed a commit that referenced this pull request Apr 14, 2023
efd6 added a commit that referenced this pull request Apr 14, 2023
…5085)

(cherry picked from commit d043a69)

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
efd6 added a commit that referenced this pull request Apr 14, 2023
…5086)

(cherry picked from commit d043a69)

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.8-candidate backport-v7.17.0 Automated backport with mergify backport-v8.7.0 Automated backport with mergify bugfix docs Packetbeat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants