Support Questions

Find answers, ask questions, and share your expertise
Announcements
Celebrating as our community reaches 100,000 members! Thank you!

NiFi Best Practices: Processor Naming Conventions

avatar
Contributor

Hello All,

Do we have any "best practices" documentation or guidelines on how to name Processors in Configure > Settings > Name?

Thanks!!

1 ACCEPTED SOLUTION

avatar
Guru

Hi @M R,

Are the NiFi flows used/maintained by multiple parties? If so, it would make sense to determine a naming convention as a group so that it is done consistently across your team. In general, I think you want to give longer, unique and descriptive names to each processor so that it can be easily and quickly understood what it does and what role it plays in the flow. This is especially useful when you are trying to locate a particular processor but there are multiple processors in your flow that are the same type.

A good resource for keeping flows maintainable that has a section on naming can be found here:

http://sebastiancarroll.github.io/2017/03/15/keeping-your-dataflows-tidy.html

View solution in original post

3 REPLIES 3

avatar
Guru

Hi @M R,

Are the NiFi flows used/maintained by multiple parties? If so, it would make sense to determine a naming convention as a group so that it is done consistently across your team. In general, I think you want to give longer, unique and descriptive names to each processor so that it can be easily and quickly understood what it does and what role it plays in the flow. This is especially useful when you are trying to locate a particular processor but there are multiple processors in your flow that are the same type.

A good resource for keeping flows maintainable that has a section on naming can be found here:

http://sebastiancarroll.github.io/2017/03/15/keeping-your-dataflows-tidy.html

avatar
Contributor

Yes. Possibly maintained by different parties across several time zones. Thanks for sharing such a great link.

avatar
Guru

Glad it helped. I wanted to note that since @Sebastian Carroll posted his great blog, component alignment functionality was added in NiFi 1.2.0, so it is much easier to line up components on the canvas. I described it here:

https://community.hortonworks.com/content/kbentry/106723/new-ui-enhancements-in-apache-nifi-12.html