seznam/slo-exporter

[docs] *Ingester modules are of the producer type not ingester.

rudo-thomas opened this issue · 1 comments

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.

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?