Problem
When writing analyzers, authors need to reference files that collectors produce. But the docs don't document what path each collector writes to in the support bundle. For example:
- If you use a
clusterResources collector, where does it put its output?
- If you use an
exec collector, what's the file path in the bundle?
Without this information, analyzer authors resort to trial and error or reading source code to figure out the collector-to-path mapping.
Requested change
Add output path documentation to each collector's reference page on troubleshoot.sh. For each collector type, document:
- The default output directory/file path in the bundle
- How
collectorName (where supported) changes the output path
- Example showing how an analyzer references that path via
fileName
Context
This came up in some hands-on sessions where participants found that collectors work, but couldn't figure out which files their analyzers should read. The information exists in source code but isn't surfaced in docs.
Problem
When writing analyzers, authors need to reference files that collectors produce. But the docs don't document what path each collector writes to in the support bundle. For example:
clusterResourcescollector, where does it put its output?execcollector, what's the file path in the bundle?Without this information, analyzer authors resort to trial and error or reading source code to figure out the collector-to-path mapping.
Requested change
Add output path documentation to each collector's reference page on troubleshoot.sh. For each collector type, document:
collectorName(where supported) changes the output pathfileNameContext
This came up in some hands-on sessions where participants found that collectors work, but couldn't figure out which files their analyzers should read. The information exists in source code but isn't surfaced in docs.