Processing block parameters

class PstMetrics(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

List of metrics that can be requested.

Note: underscores are removed for topic names

ALL = 'all'

Request all proceeding metrics

pydantic settings PstMetricsParams

pst-metrics script parameters

Show JSON schema

{
   "title": "pst-metrics",
   "description": "pst-metrics script parameters",
   "type": "object",
   "properties": {
      "metrics": {
         "default": [
            "all"
         ],
         "description": "List of metrics to generate, or 'all'",
         "items": {
            "$ref": "#/$defs/PstMetrics"
         },
         "title": "Metrics",
         "type": "array"
      },
      "max_message_size_bytes": {
         "default": 10000000,
         "description": "The number of bytes the maximum message can be",
         "minimum": 1000000,
         "title": "Max Message Size Bytes",
         "type": "integer"
      }
   },
   "$defs": {
      "PstMetrics": {
         "description": "List of metrics that can be requested.\n\nNote: underscores are removed for topic names",
         "enum": [
            "all",
            "bandpass",
            "timeseries",
            "histogram",
            "flow_through_histogram",
            "flow_through_bandpass",
            "flow_through_timeseries",
            "input_weights"
         ],
         "title": "PstMetrics",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Config:

• strict: bool = True

• extra: str = forbid

• arbitrary_types_allowed: bool = False

• validate_assignment: bool = True

• title: str = pst-metrics

Fields:

• max_message_size_bytes (int)

• metrics (list[pst_metrics_params.PstMetrics])

field max_message_size_bytes: int = 10000000

The number of bytes the maximum message can be

Constraints:

• ge = 1000000

field metrics: list[PstMetrics] = [PstMetrics.ALL]

List of metrics to generate, or ‘all’