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

dedemorton · 2021-11-03T19:50:25Z

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

Closes Banner in doc - Custom beat generator deprecation #28426

elasticmachine · 2021-11-03T19:50:28Z

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

mergify · 2021-11-03T19:50:33Z

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.

elasticmachine · 2021-11-03T20:10:50Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

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 · 2021-11-05T11:18:17Z

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

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

dedemorton · 2021-11-08T19:48:34Z

@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 · 2021-11-09T08:09:02Z

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

docs/devguide/creating-beat-from-metricbeat.asciidoc

docs/devguide/generator-support-note.asciidoc

dedemorton · 2021-11-10T19:47:53Z

@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?

kvch · 2021-11-24T15:15:36Z

Maybe @adriansr can answer you about the protocol generator?

adriansr · 2021-11-25T16:53:08Z

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 · 2021-11-30T01:31:14Z

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

) * 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)

) (#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 <[email protected]>

) (#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 <[email protected]>

* 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) ...

* 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)

dedemorton added docs Team:Docs Label for the Observability docs team v7.16.0 labels Nov 3, 2021

dedemorton requested review from nimarezainia and ollyhowell November 3, 2021 19:50

dedemorton self-assigned this Nov 3, 2021

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 bot added the backport-skip Skip notification from the automated backport with mergify label Nov 3, 2021

mtojek self-requested a review November 8, 2021 11:33

mtojek reviewed Nov 8, 2021

View reviewed changes

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

48183d6

dedemorton commented Nov 10, 2021

View reviewed changes

docs/devguide/creating-beat-from-metricbeat.asciidoc Outdated Show resolved Hide resolved

dedemorton force-pushed the issue#28426 branch from c77dc1c to 48183d6 Compare November 10, 2021 19:38

dedemorton commented Nov 10, 2021

View reviewed changes

docs/devguide/generator-support-note.asciidoc Outdated Show resolved Hide resolved

Remove tagged region because it's no longer used

9c1c9d8

dedemorton added the Stalled label Nov 17, 2021

kvch approved these changes Nov 24, 2021

View reviewed changes

botelastic bot removed the Stalled label Nov 24, 2021

dedemorton merged commit 73a2e55 into elastic:master Nov 30, 2021

dedemorton deleted the issue#28426 branch November 30, 2021 01:31

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 mentioned this pull request Nov 30, 2021

[7.16](backport #28797) Add note that there is no warranty or support for generator code #29187

Merged

mergify bot mentioned this pull request Nov 30, 2021

[8.0](backport #28797) Add note that there is no warranty or support for generator code #29188

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

dedemorton commented Nov 3, 2021 •

edited

Loading

elasticmachine commented Nov 3, 2021

mergify bot commented Nov 3, 2021

elasticmachine commented Nov 3, 2021 •

edited by jenkins-beats-ci bot

Loading

Build stats

mergify bot commented Nov 5, 2021

mtojek left a comment •

edited

Loading

dedemorton commented Nov 8, 2021

kvch commented Nov 9, 2021

dedemorton commented Nov 10, 2021 •

edited

Loading

kvch commented Nov 24, 2021

adriansr commented Nov 25, 2021

dedemorton commented Nov 30, 2021

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

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

Conversation

dedemorton commented Nov 3, 2021 • edited Loading

What does this PR do?

Why is it important?

Checklist

Related issues

elasticmachine commented Nov 3, 2021

mergify bot commented Nov 3, 2021

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

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

mergify bot commented Nov 5, 2021

mtojek left a comment • edited Loading

Choose a reason for hiding this comment

dedemorton commented Nov 8, 2021

kvch commented Nov 9, 2021

dedemorton commented Nov 10, 2021 • edited Loading

kvch commented Nov 24, 2021

adriansr commented Nov 25, 2021

dedemorton commented Nov 30, 2021

dedemorton commented Nov 3, 2021 •

edited

Loading

elasticmachine commented Nov 3, 2021 •

edited by jenkins-beats-ci bot

Loading

mtojek left a comment •

edited

Loading

dedemorton commented Nov 10, 2021 •

edited

Loading