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

x-pack/filebeat/input/cel: improve user docs #34831

Merged
merged 5 commits into from Mar 16, 2023
Merged

x-pack/filebeat/input/cel: improve user docs #34831

merged 5 commits into from Mar 16, 2023
+54 −25

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Mar 15, 2023

What does this PR do?

Improves documentation for the Filebeat CEL input.

Why is it important?

Improves clarity and adds docs for configuration fields that were omitted.

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

@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 Mar 15, 2023
@mergify mergify bot assigned efd6 Mar 15, 2023
@elasticmachine
Copy link
Collaborator

elasticmachine commented Mar 15, 2023 •
edited by jenkins-beats-ci bot

💚 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-03-15T01:21:30.846+0000

  • Duration: 8 min 49 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 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 March 15, 2023 01:48
@elasticmachine
Copy link
Collaborator

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

@efd6 efd6 mentioned this pull request Mar 15, 2023
Merged
6 tasks
@efd6 efd6 requested a review from a team March 16, 2023 02:12
ShourieG
ShourieG approved these changes Mar 16, 2023
View reviewed changes
Copy link
Contributor

@ShourieG ShourieG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@efd6 efd6 merged commit f20ce9d into elastic:main Mar 16, 2023
mergify bot pushed a commit that referenced this pull request Mar 16, 2023
@efd6 @mergify
x-pack/filebeat/input/cel: improve user docs (#34831)
e5887f4 
* include docs for state, program and regexp
* move state, program and regexp docs up
* clarify cursor number requirements

(cherry picked from commit f20ce9d)

# Conflicts:
#	x-pack/filebeat/docs/inputs/input-cel.asciidoc
@mergify mergify bot mentioned this pull request Mar 16, 2023
Merged
@efd6 efd6 added backport-v8.7.0 Automated backport with mergify 8.8-candidate and removed 8.7-candidate labels Mar 16, 2023
mergify bot pushed a commit that referenced this pull request Mar 16, 2023
@efd6 @mergify
x-pack/filebeat/input/cel: improve user docs (#34831)
6767c65 
* include docs for state, program and regexp
* move state, program and regexp docs up
* clarify cursor number requirements

(cherry picked from commit f20ce9d)
@mergify mergify bot mentioned this pull request Mar 16, 2023
Merged
efd6 added a commit that referenced this pull request Mar 16, 2023
@mergify @efd6
[8.6](backport #34831) x-pack/filebeat/input/cel: improve user docs (#…
af0ebf0 
…34836)

* x-pack/filebeat/input/cel: improve user docs (#34831)

* include docs for state, program and regexp
* move state, program and regexp docs up
* clarify cursor number requirements

(cherry picked from commit f20ce9d)

# Conflicts:
#	x-pack/filebeat/docs/inputs/input-cel.asciidoc

* resolve conflicts

---------

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
Co-authored-by: Dan Kortschak <dan.kortschak@elastic.co>
efd6 added a commit that referenced this pull request Mar 16, 2023
@mergify @efd6
[8.7](backport #34831) x-pack/filebeat/input/cel: improve user docs (#…
b86912d 
…34837)

* x-pack/filebeat/input/cel: improve user docs (#34831)

* include docs for state, program and regexp
* move state, program and regexp docs up
* clarify cursor number requirements

(cherry picked from commit f20ce9d)

* remove irrelevant changelog line

---------

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
Co-authored-by: Dan Kortschak <dan.kortschak@elastic.co>
chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
@efd6 @chrisberkhout
x-pack/filebeat/input/cel: improve user docs (#34831)
a600549 
* include docs for state, program and regexp
* move state, program and regexp docs up
* clarify cursor number requirements
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ShourieG ShourieG ShourieG approved these changes

Assignees

@efd6 efd6

Labels
8.8-candidate backport-v8.6.0 Automated backport with mergify backport-v8.7.0 Automated backport with mergify docs Filebeat Filebeat
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@efd6 @elasticmachine @ShourieG