How Might We help users troubleshoot missing information and/or understand requirements for app inclusion?

[KevinMGranger]

We've seen folks be confused by data missing from pelorus many times.

All solutions relying on logging missing data means collectors need to look at everything,
which we've been told is prohibitively expensive.

How might we help users with this, without making the exporters slow and complicated?

Some preliminary ideas, none of them mutually exclusive:

• add a prominent "Requirements" section to the doc, outlining what needs to be labeled with what for inclusion.
• add a tutorial for onboarding an app into pelorus, which does the above.
• create a troubleshooting script / web interface that will let users see resources that are missing the necessary data. (the web interface would be separate from the collectors).

[KevinMGranger]

Some levels of improvement, in order of increasing effort (but increasing value for troubleshooting info)

1. Document the requirements
2. Add troubleshooting section
3. Add one-liners to query for these kinds of mislabeled resources
4. Add script to do this check
5. Add web interface / regularly-running pod / Job / CronJob to do this check by default for new users