Skip to content

AuditFinding

Source code in docs_src/capo_application_signals/types/audit_finding.py
class AuditFinding(TypedDict, closed=True):
    key_attributes: "capo_application_signals.types.attributes.Attributes"
    """<p>The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.</p>"""
    auditor_results: NotRequired[
        "capo_application_signals.types.auditor_results.AuditorResults"
    ]
    """<p>An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.</p>"""
    operation: NotRequired["str"]
    """<p>The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.</p>"""
    metric_graph: NotRequired["capo_application_signals.types.metric_graph.MetricGraph"]
    """<p>A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.</p>"""
    dependency_graph: NotRequired[
        "capo_application_signals.types.dependency_graph.DependencyGraph"
    ]
    """<p>A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.</p>"""
    type: NotRequired["str"]
    """<p>The type of audit finding.</p>"""

auditor_results instance-attribute

auditor_results: NotRequired[AuditorResults]

An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.

dependency_graph instance-attribute

dependency_graph: NotRequired[DependencyGraph]

A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.

key_attributes instance-attribute

key_attributes: Attributes

The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.

metric_graph instance-attribute

metric_graph: NotRequired[MetricGraph]

A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.

operation instance-attribute

operation: NotRequired[str]

The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.

type instance-attribute

type: NotRequired[str]

The type of audit finding.