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

[DOCS] Advise users to migrate from Filebeat to Elastic Agent #36157

Merged

Conversation

natasha-moore-elastic
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic commented Jul 25, 2023

What does this PR do?

Adds a note to Modules to advise users to migrate to Elastic Agent.

Preview: Modules

Why is it important?

While Filebeat modules are still supported, we do not typically apply bug fixes or enhancements to these modules, or ship any new modules. Our focus is now entirely on Elastic Agent integrations.

Checklist

  • My code follows the style guidelines of this project
    - [ ] I have commented my code, particularly in hard-to-understand areas N/A
  • I have made corresponding changes to the documentation
    - [ ] I have made corresponding change to the default configuration files N/A
    - [ ] I have added tests that prove my fix is effective or that my feature works N/A
    - [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc. N/A

Related issues

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jul 25, 2023
@natasha-moore-elastic natasha-moore-elastic added Filebeat Filebeat Team:Docs Label for the Observability docs team labels Jul 25, 2023
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jul 25, 2023
@natasha-moore-elastic natasha-moore-elastic added needs_team Indicates that the issue/PR needs a Team:* label backport-v8.9.0 Automated backport with mergify labels Jul 25, 2023
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jul 25, 2023
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jul 25, 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-07-31T13:37:14.237+0000

  • Duration: 8 min 8 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!)

Copy link
Contributor

@jmikell821 jmikell821 left a comment

Choose a reason for hiding this comment

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

Hi @natasha-moore-elastic - I left a small tweak to @jamiehynds' suggestion. Please make sure all the attributes {surrounded in {}) render properly in the HTML preview. Thanks!

filebeat/docs/modules.asciidoc Outdated Show resolved Hide resolved
@jmikell821
Copy link
Contributor

@jamiehynds any idea of how far back you'd like us to backport this?

@jamiehynds
Copy link

@nimarezainia @SubhrataK @amitkanfer can you please review before we go ahead with this PR? The goal is to drive users towards agent integrations over Beats modules and raise awareness/recommend agent integrations. While this PR covers Filebeat, we'll probably have to do similar text for other modules pages for the other Beats too. Want to ensure we're aligned across ingest, security and o11y before proceeding.

@SubhrataK
Copy link

@jamiehynds I am fine with adding the note (with the text, as suggested by you).

@amitkanfer
Copy link
Collaborator

+1 from me.

@jamiehynds
Copy link

@jamiehynds any idea of how far back you'd like us to backport this?

is it possible to backport to 8.0 to ensure alignment across all 8.x releases? Also, could we expand this across all the Beats? I can raise issues for each Beat if needed (e.g. Winlogbeat, Packetbeat, Auditbeat). The text will differ slightly across each Beat.

@jmikell821
Copy link
Contributor

is it possible to backport to 8.0 to ensure alignment across all 8.x releases? Also, could we expand this across all the Beats? I can raise issues for each Beat if needed (e.g. Winlogbeat, Packetbeat, Auditbeat). The text will differ slightly across each Beat.

Hi @jamiehynds yes. Typically, these docs are handled by the Fleet team I believe, but @natasha-moore-elastic is happy to make these changes for the rest of the Beats docs. Can you please open issues for the rest of them in the beats repo and assign her? Thanks!

@natasha-moore-elastic natasha-moore-elastic added backport-v8.8.0 Automated backport with mergify backport-v8.7.0 Automated backport with mergify backport-v8.6.0 Automated backport with mergify backport-v8.5.0 Automated backport with mergify backport-v8.4.0 Automated backport with mergify backport-v8.3.0 Automated backport with mergify backport-v8.2.0 Automated backport with mergify backport-v8.1.0 Automated backport with mergify backport-v8.0.0 Automated backport with mergify labels Jul 27, 2023
@nimarezainia
Copy link
Contributor

thank you @natasha-moore-elastic adding @kilfoyle for awareness.

@natasha-moore-elastic
Copy link
Contributor Author

@jamiehynds @jmikell821, if everyone's happy with the updated text, can I get an approval, please? Thanks!

Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀
Thanks @natasha-moore-elastic!

@natasha-moore-elastic natasha-moore-elastic merged commit e1267be into elastic:main Aug 1, 2023
@natasha-moore-elastic natasha-moore-elastic deleted the issue-3576 branch August 1, 2023 13:18
mergify bot pushed a commit that referenced this pull request Aug 1, 2023
## What does this PR do?

Adds a note to
[Modules](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html)
to advise users to migrate to Elastic Agent.

Preview:
[Modules](https://beats_36157.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-modules.html)

## Why is it important?

While Filebeat modules are still supported, we do not typically apply
bug fixes or enhancements to these modules, or ship any new modules. Our
focus is now entirely on Elastic Agent integrations.

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [x] My code follows the style guidelines of this project
~~- [ ] I have commented my code, particularly in hard-to-understand
areas~~ N/A
- [x] I have made corresponding changes to the documentation
~~- [ ] I have made corresponding change to the default configuration
files~~ N/A
~~- [ ] I have added tests that prove my fix is effective or that my
feature works~~ N/A
~~- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or
`CHANGELOG-developer.next.asciidoc`.~~ N/A

## Related issues

* Resolves elastic/security-docs#3576

---------

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
(cherry picked from commit e1267be)
mergify bot pushed a commit that referenced this pull request Aug 1, 2023
## What does this PR do?

Adds a note to
[Modules](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html)
to advise users to migrate to Elastic Agent.

Preview:
[Modules](https://beats_36157.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-modules.html)

## Why is it important?

While Filebeat modules are still supported, we do not typically apply
bug fixes or enhancements to these modules, or ship any new modules. Our
focus is now entirely on Elastic Agent integrations.

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [x] My code follows the style guidelines of this project
~~- [ ] I have commented my code, particularly in hard-to-understand
areas~~ N/A
- [x] I have made corresponding changes to the documentation
~~- [ ] I have made corresponding change to the default configuration
files~~ N/A
~~- [ ] I have added tests that prove my fix is effective or that my
feature works~~ N/A
~~- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or
`CHANGELOG-developer.next.asciidoc`.~~ N/A

## Related issues

* Resolves elastic/security-docs#3576

---------

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
(cherry picked from commit e1267be)
mergify bot pushed a commit that referenced this pull request Aug 1, 2023
## What does this PR do?

Adds a note to
[Modules](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html)
to advise users to migrate to Elastic Agent.

Preview:
[Modules](https://beats_36157.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-modules.html)

## Why is it important?

While Filebeat modules are still supported, we do not typically apply
bug fixes or enhancements to these modules, or ship any new modules. Our
focus is now entirely on Elastic Agent integrations.

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [x] My code follows the style guidelines of this project
~~- [ ] I have commented my code, particularly in hard-to-understand
areas~~ N/A
- [x] I have made corresponding changes to the documentation
~~- [ ] I have made corresponding change to the default configuration
files~~ N/A
~~- [ ] I have added tests that prove my fix is effective or that my
feature works~~ N/A
~~- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or
`CHANGELOG-developer.next.asciidoc`.~~ N/A

## Related issues

* Resolves elastic/security-docs#3576

---------

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
(cherry picked from commit e1267be)
mergify bot pushed a commit that referenced this pull request Aug 1, 2023
## What does this PR do?

Adds a note to
[Modules](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html)
to advise users to migrate to Elastic Agent.

Preview:
[Modules](https://beats_36157.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-modules.html)

## Why is it important?

While Filebeat modules are still supported, we do not typically apply
bug fixes or enhancements to these modules, or ship any new modules. Our
focus is now entirely on Elastic Agent integrations.

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [x] My code follows the style guidelines of this project
~~- [ ] I have commented my code, particularly in hard-to-understand
areas~~ N/A
- [x] I have made corresponding changes to the documentation
~~- [ ] I have made corresponding change to the default configuration
files~~ N/A
~~- [ ] I have added tests that prove my fix is effective or that my
feature works~~ N/A
~~- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or
`CHANGELOG-developer.next.asciidoc`.~~ N/A

## Related issues

* Resolves elastic/security-docs#3576

---------

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
(cherry picked from commit e1267be)
mergify bot pushed a commit that referenced this pull request Aug 1, 2023
## What does this PR do?

Adds a note to
[Modules](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html)
to advise users to migrate to Elastic Agent.

Preview:
[Modules](https://beats_36157.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-modules.html)

## Why is it important?

While Filebeat modules are still supported, we do not typically apply
bug fixes or enhancements to these modules, or ship any new modules. Our
focus is now entirely on Elastic Agent integrations.

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [x] My code follows the style guidelines of this project
~~- [ ] I have commented my code, particularly in hard-to-understand
areas~~ N/A
- [x] I have made corresponding changes to the documentation
~~- [ ] I have made corresponding change to the default configuration
files~~ N/A
~~- [ ] I have added tests that prove my fix is effective or that my
feature works~~ N/A
~~- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or
`CHANGELOG-developer.next.asciidoc`.~~ N/A

## Related issues

* Resolves elastic/security-docs#3576

---------

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
(cherry picked from commit e1267be)
mergify bot pushed a commit that referenced this pull request Aug 1, 2023
## What does this PR do?

Adds a note to
[Modules](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html)
to advise users to migrate to Elastic Agent.

Preview:
[Modules](https://beats_36157.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-modules.html)

## Why is it important?

While Filebeat modules are still supported, we do not typically apply
bug fixes or enhancements to these modules, or ship any new modules. Our
focus is now entirely on Elastic Agent integrations.

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [x] My code follows the style guidelines of this project
~~- [ ] I have commented my code, particularly in hard-to-understand
areas~~ N/A
- [x] I have made corresponding changes to the documentation
~~- [ ] I have made corresponding change to the default configuration
files~~ N/A
~~- [ ] I have added tests that prove my fix is effective or that my
feature works~~ N/A
~~- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or
`CHANGELOG-developer.next.asciidoc`.~~ N/A

## Related issues

* Resolves elastic/security-docs#3576

---------

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
(cherry picked from commit e1267be)
mergify bot pushed a commit that referenced this pull request Aug 1, 2023
## What does this PR do?

Adds a note to
[Modules](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html)
to advise users to migrate to Elastic Agent.

Preview:
[Modules](https://beats_36157.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-modules.html)

## Why is it important?

While Filebeat modules are still supported, we do not typically apply
bug fixes or enhancements to these modules, or ship any new modules. Our
focus is now entirely on Elastic Agent integrations.

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [x] My code follows the style guidelines of this project
~~- [ ] I have commented my code, particularly in hard-to-understand
areas~~ N/A
- [x] I have made corresponding changes to the documentation
~~- [ ] I have made corresponding change to the default configuration
files~~ N/A
~~- [ ] I have added tests that prove my fix is effective or that my
feature works~~ N/A
~~- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or
`CHANGELOG-developer.next.asciidoc`.~~ N/A

## Related issues

* Resolves elastic/security-docs#3576

---------

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
(cherry picked from commit e1267be)
jrodewig pushed a commit that referenced this pull request Aug 3, 2023
jrodewig pushed a commit that referenced this pull request Aug 3, 2023
jrodewig pushed a commit that referenced this pull request Aug 3, 2023
natasha-moore-elastic added a commit that referenced this pull request Aug 3, 2023
…o Elastic Agent (#36200)

This is an automatic backport of pull request #36157 done by
[Mergify](https://mergify.com).


---


<details>
<summary>Mergify commands and options</summary>

<br />

More conditions and actions can be found in the
[documentation](https://docs.mergify.com/).

You can also trigger Mergify actions by commenting on this pull request:

- `@Mergifyio refresh` will re-evaluate the rules
- `@Mergifyio rebase` will rebase this PR on its base branch
- `@Mergifyio update` will merge the base branch into this PR
- `@Mergifyio backport <destination>` will backport this PR on
`<destination>` branch

Additionally, on Mergify [dashboard](https://dashboard.mergify.com) you
can:

- look at your merge queues
- generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com
</details>

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Aug 3, 2023
…o Elastic Agent (#36199)

This is an automatic backport of pull request #36157 done by
[Mergify](https://mergify.com).


---


<details>
<summary>Mergify commands and options</summary>

<br />

More conditions and actions can be found in the
[documentation](https://docs.mergify.com/).

You can also trigger Mergify actions by commenting on this pull request:

- `@Mergifyio refresh` will re-evaluate the rules
- `@Mergifyio rebase` will rebase this PR on its base branch
- `@Mergifyio update` will merge the base branch into this PR
- `@Mergifyio backport <destination>` will backport this PR on
`<destination>` branch

Additionally, on Mergify [dashboard](https://dashboard.mergify.com) you
can:

- look at your merge queues
- generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com
</details>

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Aug 3, 2023
…o Elastic Agent (#36198)

This is an automatic backport of pull request #36157 done by
[Mergify](https://mergify.com).


---


<details>
<summary>Mergify commands and options</summary>

<br />

More conditions and actions can be found in the
[documentation](https://docs.mergify.com/).

You can also trigger Mergify actions by commenting on this pull request:

- `@Mergifyio refresh` will re-evaluate the rules
- `@Mergifyio rebase` will rebase this PR on its base branch
- `@Mergifyio update` will merge the base branch into this PR
- `@Mergifyio backport <destination>` will backport this PR on
`<destination>` branch

Additionally, on Mergify [dashboard](https://dashboard.mergify.com) you
can:

- look at your merge queues
- generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com
</details>

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Aug 3, 2023
…o Elastic Agent (#36195)

This is an automatic backport of pull request #36157 done by
[Mergify](https://mergify.com).


---


<details>
<summary>Mergify commands and options</summary>

<br />

More conditions and actions can be found in the
[documentation](https://docs.mergify.com/).

You can also trigger Mergify actions by commenting on this pull request:

- `@Mergifyio refresh` will re-evaluate the rules
- `@Mergifyio rebase` will rebase this PR on its base branch
- `@Mergifyio update` will merge the base branch into this PR
- `@Mergifyio backport <destination>` will backport this PR on
`<destination>` branch

Additionally, on Mergify [dashboard](https://dashboard.mergify.com) you
can:

- look at your merge queues
- generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com
</details>

Co-authored-by: natasha-moore-elastic <[email protected]>
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
…c#36157)

## What does this PR do?

Adds a note to
[Modules](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html)
to advise users to migrate to Elastic Agent.

Preview:
[Modules](https://beats_36157.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-modules.html)

## Why is it important?

While Filebeat modules are still supported, we do not typically apply
bug fixes or enhancements to these modules, or ship any new modules. Our
focus is now entirely on Elastic Agent integrations.

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [x] My code follows the style guidelines of this project
~~- [ ] I have commented my code, particularly in hard-to-understand
areas~~ N/A
- [x] I have made corresponding changes to the documentation
~~- [ ] I have made corresponding change to the default configuration
files~~ N/A
~~- [ ] I have added tests that prove my fix is effective or that my
feature works~~ N/A
~~- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or
`CHANGELOG-developer.next.asciidoc`.~~ N/A

## Related issues

* Resolves elastic/security-docs#3576

---------

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v8.0.0 Automated backport with mergify backport-v8.1.0 Automated backport with mergify backport-v8.2.0 Automated backport with mergify backport-v8.3.0 Automated backport with mergify backport-v8.4.0 Automated backport with mergify backport-v8.5.0 Automated backport with mergify backport-v8.6.0 Automated backport with mergify backport-v8.7.0 Automated backport with mergify backport-v8.8.0 Automated backport with mergify backport-v8.9.0 Automated backport with mergify docs Filebeat Filebeat Team:Docs Label for the Observability docs team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Filebeat Modules] Pointing users to Elastic Agent integrations
8 participants