Insight ¶

class Insight(TypedDict, closed=True):
    insight_id: "capo_pi.types.string.String"
    """<p>The unique identifier for the insight. For example, <code>insight-12345678901234567</code>.</p>"""
    insight_type: NotRequired["capo_pi.types.string.String"]
    """<p>The type of insight. For example, <code>HighDBLoad</code>, <code>HighCPU</code>, or <code>DominatingSQLs</code>.</p>"""
    context: NotRequired["capo_pi.types.context_type.ContextType"]
    """<p>Indicates if the insight is causal or correlated insight.</p>"""
    start_time: NotRequired["capo_pi.types.iso_timestamp.ISOTimestamp"]
    """<p>The start time of the insight. For example, <code>2018-10-30T00:00:00Z</code>.</p>"""
    end_time: NotRequired["capo_pi.types.iso_timestamp.ISOTimestamp"]
    """<p>The end time of the insight. For example, <code>2018-10-30T00:00:00Z</code>.</p>"""
    severity: NotRequired["capo_pi.types.severity.Severity"]
    """<p>The severity of the insight. The values are: <code>Low</code>, <code>Medium</code>, or <code>High</code>.</p>"""
    supporting_insights: NotRequired["capo_pi.types.insight_list.InsightList"]
    """<p>List of supporting insights that provide additional factors for the insight.</p>"""
    description: NotRequired["capo_pi.types.markdown_string.MarkdownString"]
    """<p>Description of the insight. For example: <code>A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact</code>.</p>"""
    recommendations: NotRequired["capo_pi.types.recommendation_list.RecommendationList"]
    """<p>List of recommendations for the insight. For example, <code>Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id</code>.</p>"""
    insight_data: NotRequired["capo_pi.types.data_list.DataList"]
    """<p>List of data objects containing metrics and references from the time range while generating the insight.</p>"""
    baseline_data: NotRequired["capo_pi.types.data_list.DataList"]
    """<p> Metric names and values from the timeframe used as baseline to generate the insight.</p>"""