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/filebeat/input/cel: add execution budget and relax CSV mime name #35409

Merged
merged 1 commit into from
May 10, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented May 10, 2023

What does this PR do?

This adds two features to improve user experience. The first is a guard rail to prevent users unwittingly constructing a CEL program that enters an infinite loop and blocking further processing. While CEL is not Turing complete, there is a Turing escape hatch in the form of the want_more field. If a user sets want_more to true and returns an event the inner execution loop will be re-run. If an error in the CEL program results in non-progress, this would result in an infinite loop. By providing a bound on the number of executions each periodic invocation can run, and warning when the budget is exceeded, this is mitigated.

The second is a change to the look-up table for MIME types. While the documentation says that CSV MIME types are accessed via the name "text/csv; header=absent" and "text/csv; header=present" (with a space), it is probable that at some point someone will type this without a space and get a failure to parse. So add the no-space variants to the table.

Why is it important?

Improved user experience and reduced support load.

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 added Filebeat Filebeat Team:Security-External Integrations backport-skip Skip notification from the automated backport with mergify 8.8-candidate labels May 10, 2023
@efd6 efd6 self-assigned this May 10, 2023
@botelastic 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 10, 2023
@efd6 efd6 force-pushed the cel_exec_mime branch from 74597bb to be86dbe Compare May 10, 2023 04:12
@elasticmachine
Copy link
Collaborator

elasticmachine commented May 10, 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-05-10T11:13:35.457+0000

  • Duration: 76 min 57 sec

Test stats 🧪

Test Results
Failed 0
Passed 2902
Skipped 175
Total 3077

💚 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 marked this pull request as ready for review May 10, 2023 06:06
@efd6 efd6 requested a review from a team as a code owner May 10, 2023 06:07
@elasticmachine
Copy link
Collaborator

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

@mergify

This comment was marked as outdated.

This adds two features to improve user experience. The first is a guard
rail to prevent users unwittingly constructing a CEL program that enters
an infinite loop and blocking further processing. While CEL is not
Turing complete, there is a Turing escape hatch in the form of the
want_more field. If a user sets want_more to true and returns an event
the inner execution loop will be re-run. If an error in the CEL program
results in non-progress, this would result in an infinite loop. By
providing a bound on the number of executions each periodic invocation
can run, and warning when the budget is exceeded, this is mitigated.

The second is a change to the look-up table for MIME types. While the
documentation says that CSV MIME types are accessed via the name
"text/csv; header=absent" and "text/csv; header=present" (with a space),
it is probable that at some point someone will type this without a space
and get a failure to parse. So add the no-space variants to the table.
@efd6 efd6 force-pushed the cel_exec_mime branch from be86dbe to afa7d3a Compare May 10, 2023 11:13
@efd6 efd6 merged commit 139b305 into elastic:main May 10, 2023
chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
…me (#35409)

This adds two features to improve user experience. The first is a guard
rail to prevent users unwittingly constructing a CEL program that enters
an infinite loop and blocking further processing. While CEL is not
Turing complete, there is a Turing escape hatch in the form of the
want_more field. If a user sets want_more to true and returns an event
the inner execution loop will be re-run. If an error in the CEL program
results in non-progress, this would result in an infinite loop. By
providing a bound on the number of executions each periodic invocation
can run, and warning when the budget is exceeded, this is mitigated.

The second is a change to the look-up table for MIME types. While the
documentation says that CSV MIME types are accessed via the name
"text/csv; header=absent" and "text/csv; header=present" (with a space),
it is probable that at some point someone will type this without a space
and get a failure to parse. So add the no-space variants to the table.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.8-candidate backport-skip Skip notification from the automated backport with mergify Filebeat Filebeat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants