Skip to content

PerformanceInsightsMetric

Source code in docs_src/capo_pi/types/performance_insights_metric.py
class PerformanceInsightsMetric(TypedDict, closed=True):
    metric: NotRequired["capo_pi.types.descriptive_string.DescriptiveString"]
    """<p>The Performance Insights metric.</p>"""
    display_name: NotRequired["capo_pi.types.descriptive_string.DescriptiveString"]
    """<p>The Performance Insights metric name.</p>"""
    dimensions: NotRequired["capo_pi.types.descriptive_map.DescriptiveMap"]
    """<p>A dimension map that contains the dimensions for this partition.</p>"""
    filter: NotRequired["capo_pi.types.descriptive_map.DescriptiveMap"]
    """<p>The filter for the Performance Insights metric.</p>"""
    value: NotRequired["capo_pi.types.double.Double"]
    """<p>The value of the metric. For example, <code>9</code> for <code>db.load.avg</code>.</p>"""

dimensions instance-attribute

dimensions: NotRequired[DescriptiveMap]

A dimension map that contains the dimensions for this partition.

display_name instance-attribute

display_name: NotRequired[DescriptiveString]

The Performance Insights metric name.

filter instance-attribute

filter: NotRequired[DescriptiveMap]

The filter for the Performance Insights metric.

metric instance-attribute

metric: NotRequired[DescriptiveString]

The Performance Insights metric.

value instance-attribute

value: NotRequired[Double]

The value of the metric. For example, 9 for db.load.avg.