Stage Parameters
A stage includes parameters to configure how its data is displayed, stored, and streamed. These parameters control the stage's data behavior in presentation, storage, and streaming.
The following table lists the parameters common to all stages:
| Stage Parameter | Description |
|---|---|
| Hidden Columns | Lists column names not displayed by default when the stage opens. |
| Enable metric logging | Stores stage data changes in an internal TSDB (time-series database) for analytics and display. |
| Retention duration | Specifies the time period for retaining data in the TSDB. |
| Enable streaming |
Makes samples of the stage streamed if enabled. An optional boolean that defaults to False. If set to True, all series of the stage are streamed to external receivers through the Protobuf protocol. You can now access and stream all IBA data, including dynamic stages, in real time. |
| Description (optional) | Provides a stage description. |
| Units | Specifies units for displaying values. |
Some stages might not support of some of the above parameters depending on a processor which produces it. If so, you can find this information in documentation for each individual processor.
The following is an example of stage parameters for the "Average Interface Counters" stage of the "Device Traffic" probe:
