Command instrumentation

This stand-alone package is utilized for dynamically generating/maintaining a list of metrics; this list is determined by the stability class of the metric. We statically analyze all files in the Kubernetes code base to:

• Determine whether the metric falls into a stability class with stability guarantees.
• Determine the metric's metadata, i.e. the name, labels, type of metric.
• Output (based on the above) the metrics which meet our criteria into a yaml file.

Due to the dynamic nature of how metrics can be written, we only support the subset of metrics which can actually be parsed. If a metric cannot be parsed, it must be delegated to the stability class `Internal`, which will exempt the metric from static analysis.

The entrypoint to this package is defined in a shell script (i.e. stability-utils.sh) which has the logic for feeding file names as arguments into the program. The logic of this program is as follows:

• parse all files fed in, keeping track of:
• the function and struct pointers which correspond to prometheus metric definitions.
• consts/variable we encounter, so that we can use these to resolve values in metric definitions
• then, iterate over the function and struct pointers, resolving attributes to concrete metric values
• then, using our collected and resolved metric definitions, output (depending on the mode):
• a yaml file corresponding to all stable metrics
• a documentation file corresponding to all parseable metrics in the Kubernetes codebase

Subdirectories