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] *Ingester modules are of the producer type not ingester. #65

Open
rudo-thomas opened this issue Aug 5, 2021 · 1 comment
Open
Labels
documentation Improvements or additions to documentation

Comments

@rudo-thomas
Copy link
Contributor

rudo-thomas commented Aug 5, 2021

This is a terminology/naming bug.

The architecture documentation defines three types of modules: producer, ingester, processor.

The prometheusIngester and kafkaIngester modules include the word ingester in their names, despite being producer type modules. While this is correctly documented at the modules' page, it is also very confusing and should be fixed.

@rudo-thomas rudo-thomas added bug Something isn't working documentation Improvements or additions to documentation and removed bug Something isn't working labels Aug 5, 2021
@FUSAKLA
Copy link
Contributor

FUSAKLA commented Aug 5, 2021

Yes, I agree it's confusing. The naming collision is a bit unfortunate.

Since module names are used in the configuration, changing it would mean a breaking change.
I think changing the pipeline module type names is the way to go.

How about:

  • producer -> source
  • processor (we can leave the same?)
  • ingester -> sink

@lksv @david-vavra WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants