beats icon indicating copy to clipboard operation
beats copied to clipboard

[DOCS] Update docs.asciidoc

Open hp0620 opened this issue 2 years ago • 6 comments

Doc Team, please review:

The metricset name seems incorrect. It should be ingest_pipeline, not ingest. Customer ran into an issue following this document as we do not have the runner with the name ingest. Asking this to be fixed.

Looking at this section, https://github.com/elastic/beats/pull/34012/files/605f3e6ebbf4475acd074e7bfd78f1b60aeb8eb6#diff-ed3fa5687075193cef97f184197ead2670dac76a75052686bd860749774b047a, looks like everything is named as ingest_pipeline, so the doc seems to be incorrect.

If you name the metricset as ingest, we see errors:

{"log.level":"error","@timestamp":"2023-09-22T21:31:36.358Z","log.logger":"reload","log.origin":{"file.name":"cfgfile/list.go","file.line":138},"message":"Error creating runner from config: 1 error: metricset 'elasticsearch/ingest' not found","service.name":"metricbeat","ecs.version":"1.6.0"}

Looks like we have this metricset configured in this manner since 8.7 version. So might need to change the doc for those version branches as well.

Proposed commit message

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.

hp0620 avatar Oct 06 '23 15:10 hp0620

This pull request doesn't have a Team:<team> label.

botelastic[bot] avatar Oct 06 '23 15:10 botelastic[bot]

This pull request does not have a backport label. If this is a bug or security fix, could you label this PR @hp0620? 🙏. For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

mergify[bot] avatar Oct 06 '23 15:10 mergify[bot]

:green_heart: 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

  • Duration: 8 min 25 sec

:grey_exclamation: Flaky test report

No test was executed to be analysed.

:robot: 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!)

elasticmachine avatar Oct 06 '23 16:10 elasticmachine

This pull request does not have a backport label. If this is a bug or security fix, could you label this PR @hp0620? 🙏. For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

mergify[bot] avatar Feb 05 '24 14:02 mergify[bot]

backport-8.x has been added to help with the transition to the new branch 8.x. If you don't need it please use backport-skip label and remove the backport-8.x label.

mergify[bot] avatar Dec 26 '24 19:12 mergify[bot]

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 hp0620-patch-1 upstream/hp0620-patch-1
git merge upstream/main
git push upstream hp0620-patch-1

mergify[bot] avatar Dec 08 '25 07:12 mergify[bot]