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

Add note that there is no warranty or support for generator code #28797

Merged
merged 2 commits into from
Nov 30, 2021
Merged

Add note that there is no warranty or support for generator code #28797

merged 2 commits into from
Nov 30, 2021

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Nov 3, 2021 •
edited
Loading

What does this PR do?

Adds note to Beats Developer Guide in places where we talk about code for generating Beats, metricsets, modules, or filesets.

Questions:

  • Do we really want this note in all the topics that talk about the generator code, or does it apply to only some of the code? If so, please tell which which parts. I've tried to include the statement where I thought it applies.
  • What do we want to do about the protocol generator docs? The dev team has never had time to update those docs, and they aren't really very useful. If we do keep the docs there, I'm assuming the same restriction applies to the protocol generator, but let me know.

Why is it important?

The beats generator is old and will be deprecated in 8.0

Checklist

  • My code follows the style guidelines of this project

Related issues

@dedemorton dedemorton added docs Team:Docs Label for the Observability docs team v7.16.0 labels Nov 3, 2021
@dedemorton dedemorton self-assigned this Nov 3, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/obs-docs (Team:Docs)

@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 Nov 3, 2021
@mergify
Copy link
Contributor

mergify bot commented Nov 3, 2021

This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
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 Nov 3, 2021
@elasticmachine
Copy link
Collaborator

elasticmachine commented Nov 3, 2021 •
edited by jenkins-beats-ci bot
Loading

💚 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: 2021-11-10T19:40:53.763+0000

  • Duration: 20 min 9 sec

  • Commit: 9c1c9d8

❕ Flaky test report

No test was executed to be analysed.

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

@mergify
Copy link
Contributor

mergify bot commented Nov 5, 2021

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue#28426 upstream/issue#28426
git merge upstream/master
git push upstream issue#28426

@mtojek mtojek self-requested a review November 8, 2021 11:33
mtojek
mtojek reviewed Nov 8, 2021
View reviewed changes
Copy link
Contributor

@mtojek mtojek left a comment •
edited
Loading

Choose a reason for hiding this comment

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

There are some conflicts here. Would you mind rebasing the PR?

@dedemorton
Copy link
Contributor Author

@kvch Should I just close this PR? It looks like you have removed some of the files in #28816. Before I rebase, I wonder if there is anything in this PR worth preserving.

@kvch
Copy link
Contributor

kvch commented Nov 9, 2021

I think warranties about Filebeat modules and Metricbeat metricsets should be added to our docs. I did not remove those pages, just Beat generators.

@dedemorton
Copy link
Contributor Author

dedemorton commented Nov 10, 2021 •
edited
Loading

@kvch Thanks! I have rebased the PR. Please review and approve if it's ready to merge.

Also can you answer the question I asked earlier about the protocol generator? I think it's a little embarrassing that we say we're updating that section in the docs, but it's been out-of-date for a long time.

Do we even want to recommend that users add protocols now? WDYT?

@botelastic botelastic bot removed the Stalled label Nov 24, 2021
@kvch
Copy link
Contributor

kvch commented Nov 24, 2021

Maybe @adriansr can answer you about the protocol generator?

@adriansr
Copy link
Contributor

We've had some contributions for Packetbeat protocols, not a lot, but enough to assume that people interested manage to do it. What I don't know is if they're using the generator or basing new contributions on existing protocols.

About the recommendation, my understanding is that we still want those contributions, as Elastic Agent packages still need the protocol in Packetbeat to function and this is still going to be the case for 8.x.

@dedemorton
Copy link
Contributor Author

I'm going to merge this and leave the protocol docs as-is for now.

@dedemorton dedemorton merged commit 73a2e55 into elastic:master Nov 30, 2021
@dedemorton dedemorton deleted the issue#28426 branch November 30, 2021 01:31
@dedemorton dedemorton added backport-v7.16.0 Automated backport with mergify backport-v8.0.0 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Nov 30, 2021
mergify bot pushed a commit that referenced this pull request Nov 30, 2021
@dedemorton
Add note that there is no warranty or support for generator code (#28797
e3bf3b9 
)

* Add note that there is no warranty or support for generator code

* Remove tagged region because it's no longer used

(cherry picked from commit 73a2e55)
@mergify mergify bot mentioned this pull request Nov 30, 2021
Merged
mergify bot pushed a commit that referenced this pull request Nov 30, 2021
@dedemorton
Add note that there is no warranty or support for generator code (#28797
aed8089 
)

* Add note that there is no warranty or support for generator code

* Remove tagged region because it's no longer used

(cherry picked from commit 73a2e55)
@mergify mergify bot mentioned this pull request Nov 30, 2021
Merged
dedemorton added a commit that referenced this pull request Nov 30, 2021
@mergify @dedemorton
Add note that there is no warranty or support for generator code (#28797
7ad2204 
) (#29188)

* Add note that there is no warranty or support for generator code

* Remove tagged region because it's no longer used

(cherry picked from commit 73a2e55)

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
dedemorton added a commit that referenced this pull request Nov 30, 2021
@mergify @dedemorton
Add note that there is no warranty or support for generator code (#28797
a706a22 
) (#29187)

* Add note that there is no warranty or support for generator code

* Remove tagged region because it's no longer used

(cherry picked from commit 73a2e55)

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
v1v added a commit to v1v/beats that referenced this pull request Nov 30, 2021
@v1v
Merge remote-tracking branch 'upstream/master' into feature/use-debian-9
53d5763 
* upstream/master: (577 commits)
  Remove Journalbeat (elastic#29131)
  Add note that there is no warranty or support for generator code (elastic#28797)
  packetbeat: preparation for npcap addition (elastic#29017)
  Use the generic helper for opening file to read in filestream (elastic#29180)
  Workflow for macos (elastic#29174)
  Fix `decode_json_fields` processor to always add error key (elastic#29107)
  Workflow for macos (elastic#29156)
  Fix agent download timeout values in yaml files (elastic#29039)
  Added workflow file for builds with macos (elastic#29148)
  CI: enable AWS cloud testing on a PR basis if changes in certain files (elastic#29047)
  Remove links to Journalbeat (elastic#29134)
  Fix rds metadata in cloudwatch metricset (elastic#29106)
  [mergify]: notify conflicts in PRs that are still open (elastic#29122)
  Use NamedWatcher in Agent's k8s provider (elastic#29095)
  override host on statsd metricset (elastic#29103)
  Skip config check in autodiscover for duplicated configurations (elastic#29048)
  Change "filebeat.config.modules.enabled" to "true" (elastic#28769)
  Remove deprecated spool queue from Beats (elastic#28869)
  Add `beat` field back to beat.stats (elastic#29094)
  Revert "Move labels and annotations under kubernetes.namespace. (elastic#27917)" (elastic#29069)
  ...
elasticmachine pushed a commit to nxei/beats that referenced this pull request Dec 1, 2021
@v1v
Merge remote-tracking branch 'upstream/master' into github-actions-build
99c50fb 
* upstream/master:
  [libbeat] Fix add_labels flattening of arrays values (elastic#29211)
  Change elastic-agent pprof default to false (elastic#29155)
  elastic#28472 fix flaky tests in libbeat fmtstr to use time.UTC instead of time.Local (elastic#28473)
  Adopt `parsers` in Filebeat's journald input (elastic#29070)
  [Elastic Agent] Add process error handling guidelines (elastic#29152)
  winlogbeat/sys/winevent: use reflect IsZero method (elastic#29190)
  Remove Journalbeat (elastic#29131)
  Add note that there is no warranty or support for generator code (elastic#28797)
  packetbeat: preparation for npcap addition (elastic#29017)
  Use the generic helper for opening file to read in filestream (elastic#29180)
  Workflow for macos (elastic#29174)
  Fix `decode_json_fields` processor to always add error key (elastic#29107)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mtojek mtojek mtojek left review comments

@kvch kvch kvch approved these changes

@nimarezainia nimarezainia Awaiting requested review from nimarezainia

@ollyhowell ollyhowell Awaiting requested review from ollyhowell

Assignees

@dedemorton dedemorton

Labels
backport-v7.16.0 Automated backport with mergify backport-v8.0.0 Automated backport with mergify docs Team:Docs Label for the Observability docs team v7.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Banner in doc - Custom beat generator deprecation
5 participants
@dedemorton @elasticmachine @kvch @adriansr @mtojek