Group

Group

Bases: GroupType

Source code in lib/python/src/aria/ops/definition/group.py

class Group(GroupType):
    def __init__(
        self,
        key: str,
        label: Optional[str] = None,
        instanced: bool = False,
        instance_required: bool = True,
    ) -> None:
        """
        Create a new group that can hold attributes and subgroups.

        Args:
            key (str): The key for the group.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
            instanced (bool): If True, this group can be 'instanced' with a value, so that its subgroups and attributes
                can appear multiple times, once for each instance value. For example, a group containing
                metrics for a network interface might be instanced for each discovered interface on the parent object.
            instance_required (bool): If true, then this group must be created with an instance. Otherwise, it can be
                created both with and without an instance. Creating an instanced group without an instance can be done
                to provide a location for aggregate metrics across all instances, for example. This does nothing if
                'instanced' is False.
        """
        self.key = validate_key(key, "Group")
        self.label = label
        if label is None:
            self.label = key
        self.instanced = instanced
        self.instance_required = instance_required
        super().__init__()

    def to_json(self) -> dict:
        return {
            "key": self.key,
            "label": self.label,
            "instanced": self.instanced,
            "instance_required": self.instance_required,
        } | super().to_json()

__init__(key, label=None, instanced=False, instance_required=True)

Create a new group that can hold attributes and subgroups.

Parameters:

Name	Type	Description	Default
key	str	The key for the group.	required
label	Optional[str]	Label that is displayed in the VMware Aria Operations UI. Defaults to the key.	None
instanced	bool	If True, this group can be 'instanced' with a value, so that its subgroups and attributes can appear multiple times, once for each instance value. For example, a group containing metrics for a network interface might be instanced for each discovered interface on the parent object.	False
instance_required	bool	If true, then this group must be created with an instance. Otherwise, it can be created both with and without an instance. Creating an instanced group without an instance can be done to provide a location for aggregate metrics across all instances, for example. This does nothing if 'instanced' is False.	True

Source code in lib/python/src/aria/ops/definition/group.py

def __init__(
    self,
    key: str,
    label: Optional[str] = None,
    instanced: bool = False,
    instance_required: bool = True,
) -> None:
    """
    Create a new group that can hold attributes and subgroups.

    Args:
        key (str): The key for the group.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
        instanced (bool): If True, this group can be 'instanced' with a value, so that its subgroups and attributes
            can appear multiple times, once for each instance value. For example, a group containing
            metrics for a network interface might be instanced for each discovered interface on the parent object.
        instance_required (bool): If true, then this group must be created with an instance. Otherwise, it can be
            created both with and without an instance. Creating an instanced group without an instance can be done
            to provide a location for aggregate metrics across all instances, for example. This does nothing if
            'instanced' is False.
    """
    self.key = validate_key(key, "Group")
    self.label = label
    if label is None:
        self.label = key
    self.instanced = instanced
    self.instance_required = instance_required
    super().__init__()

GroupType

Bases: ABC

Source code in lib/python/src/aria/ops/definition/group.py

class GroupType(ABC):
    # This is only an Abstract Base Class so that it isn't initialized as a standalone object
    def __init__(self) -> None:
        self.key: str
        self.attributes: dict[str, Attribute] = OrderedDict()
        self.groups: dict[str, Group] = OrderedDict()

    def define_group(self, key: str, label: Optional[str] = None) -> Group:
        """
        Create a new group that can hold attributes and subgroups.

        Args:
            key (str): The key for the group.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

        Returns:
             The created group.
        """
        group = Group(key, label)
        self.add_group(group)
        return group

    def define_instanced_group(
        self, key: str, label: Optional[str] = None, instance_required: bool = True
    ) -> Group:
        """
        Create a new group that can hold attributes and subgroups. This group can be 'instanced', with a value, so that
        its subgroups and attributes can appear multiple times, once for each instance value. For example, a group
        containing metrics for a network interface might be instanced for each discovered interface on the parent
        object.

        Args:
            key (str): The key for the group.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
            instance_required (bool): If true, then this group must be created with an instance. Otherwise, it can be
                created both with and without an instance. Creating an instanced group without an instance can be done
                to provide a location for aggregate metrics across all instances, for example.

        Returns:
             The created group.
        """
        group = Group(key, label, instanced=True, instance_required=instance_required)
        self.add_group(group)
        return group

    def add_groups(self, groups: list[Group]) -> None:
        """
        Adds a list of groups as subgroups of this group.

        Args:
            groups (list[Group]): A list of groups.
        """
        for group in groups:
            self.add_group(group)

    def add_group(self, group: Group) -> None:
        """
        Adds a group as a subgroup of this group.

        Args:
            group (Group): A group.
        """
        key = group.key
        if key in self.groups:
            raise DuplicateKeyException(
                f"Group with key {key} already exists in {type(self)} {self.key}."
            )
        self.groups[key] = group

    def define_metric(
        self,
        key: str,
        label: Optional[str] = None,
        unit: Optional[Unit] = None,
        is_rate: bool = False,
        is_discrete: bool = False,
        is_kpi: bool = False,
        is_impact: bool = False,
        is_key_attribute: bool = False,
    ) -> MetricAttribute:
        """
        Args:
            key (str): Used to identify the parameter.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
            unit (Optional[Unit]): Specifies what unit this metric is returned in. This allows the UI to display the
                units in a consistent manner, and perform conversions when appropriate.
            is_rate (bool): Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this
                will be set automatically. Otherwise, defaults to False.
            is_discrete (bool): Declares that this attribute's range of values is discrete (integer) rather than
                continuous (floating point)
            is_kpi (bool): If set, threshold breaches for this metric will be used in the calculation of the object's
                'Self - Health Score' metric, which can affect the 'Anomalies' Badge.
            is_impact (bool): If set, this attribute will never be the 'root cause' of an issue. For example, it could
                be a proxy to a root cause, but not the root cause itself.
            is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI.
        """
        metric = MetricAttribute(
            key,
            label,
            unit,
            is_rate,
            is_discrete,
            is_kpi,
            is_impact,
            is_key_attribute,
            dashboard_order=len(self.attributes),
        )
        self.add_attribute(metric)
        return metric

    def define_string_property(
        self,
        key: str,
        label: Optional[str] = None,
        unit: Optional[Unit] = None,
        is_rate: bool = False,
        is_discrete: bool = False,
        is_kpi: bool = False,
        is_impact: bool = False,
        is_key_attribute: bool = False,
    ) -> PropertyAttribute:
        """

        Args:
            key (str): Used to identify the parameter.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
            unit (Optional[Unit]): Specifies what unit this metric is returned in. This allows the UI to display the
                units in a consistent manner, and perform conversions when appropriate.
            is_rate (bool): Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this
                will be set automatically. Otherwise, defaults to False.
            is_discrete (bool): Declares that this attribute's range of values is discrete (integer) rather than
                continuous (floating point). Defaults to False, unless 'is_string' is set, in which case it will always
                be set to True.
            is_kpi (bool): If set, threshold breaches for this metric will be used in the calculation of the object's
                'Self - Health Score' metric, which can affect the 'Anomalies' Badge.
            is_impact (bool): If set, this attribute will never be the 'root cause' of an issue. For example, it could
                be a proxy to a root cause, but not the root cause itself.
            is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI.
        """
        _property = PropertyAttribute(
            key,
            label,
            True,
            unit,
            is_rate,
            is_discrete,
            is_kpi,
            is_impact,
            is_key_attribute,
            dashboard_order=len(self.attributes),
        )
        self.add_attribute(_property)
        return _property

    def define_numeric_property(
        self,
        key: str,
        label: Optional[str] = None,
        unit: Optional[Unit] = None,
        is_rate: bool = False,
        is_discrete: bool = False,
        is_kpi: bool = False,
        is_impact: bool = False,
        is_key_attribute: bool = False,
    ) -> PropertyAttribute:
        """
        Args:
            key (str): Used to identify the parameter.
            label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
            unit (Optional[Unit]): Specifies what unit this metric is returned in. This allows the UI to display the
                units in a consistent manner, and perform conversions when appropriate.
            is_rate (bool): Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this
                will be set automatically. Otherwise, defaults to False.
            is_discrete (bool): Declares that this attribute's range of values is discrete (integer) rather than
                continuous (floating point). Defaults to False, unless 'is_string' is set, in which case it will always
                be set to True.
            is_kpi (bool): If set, threshold breaches for this metric will be used in the calculation of the object's
                'Self - Health Score' metric, which can affect the 'Anomalies' Badge.
            is_impact (bool): If set, this attribute will never be the 'root cause' of an issue. For example, it could
                be a proxy to a root cause, but not the root cause itself.
            is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI.
        """
        _property = PropertyAttribute(
            key,
            label,
            False,
            unit,
            is_rate,
            is_discrete,
            is_kpi,
            is_impact,
            is_key_attribute,
            dashboard_order=len(self.attributes),
        )
        self.add_attribute(_property)
        return _property

    def add_attributes(self, attributes: list[Attribute]) -> None:
        """
        Adds a list of attributes to this group.

        Args:
            attributes (list[Attribute]): A list of attributes (metric or property definitions).
        """
        for attribute in attributes:
            self.add_attribute(attribute)

    def add_attribute(self, attribute: Attribute) -> None:
        """
        Adds an attribute to this group.

        Args:
            attribute (Attribute): An attribute (metric or property definition).
        """
        key = attribute.key
        if key in self.attributes:
            raise DuplicateKeyException(
                f"Attribute with key {key} already exists in {type(self)} {self.key}."
            )

        self.attributes[key] = attribute

    def to_json(self) -> dict:
        return {
            "attributes": [
                attribute.to_json() for attribute in self.attributes.values()
            ],
            "groups": [group.to_json() for group in self.groups.values()],
        }

add_attribute(attribute)

Adds an attribute to this group.

Parameters:

Name	Type	Description	Default
attribute	Attribute	An attribute (metric or property definition).	required

Source code in lib/python/src/aria/ops/definition/group.py

def add_attribute(self, attribute: Attribute) -> None:
    """
    Adds an attribute to this group.

    Args:
        attribute (Attribute): An attribute (metric or property definition).
    """
    key = attribute.key
    if key in self.attributes:
        raise DuplicateKeyException(
            f"Attribute with key {key} already exists in {type(self)} {self.key}."
        )

    self.attributes[key] = attribute

add_attributes(attributes)

Adds a list of attributes to this group.

Parameters:

Name	Type	Description	Default
attributes	list[Attribute]	A list of attributes (metric or property definitions).	required

Source code in lib/python/src/aria/ops/definition/group.py

def add_attributes(self, attributes: list[Attribute]) -> None:
    """
    Adds a list of attributes to this group.

    Args:
        attributes (list[Attribute]): A list of attributes (metric or property definitions).
    """
    for attribute in attributes:
        self.add_attribute(attribute)

add_group(group)

Adds a group as a subgroup of this group.

Parameters:

Name	Type	Description	Default
group	Group	A group.	required

Source code in lib/python/src/aria/ops/definition/group.py

def add_group(self, group: Group) -> None:
    """
    Adds a group as a subgroup of this group.

    Args:
        group (Group): A group.
    """
    key = group.key
    if key in self.groups:
        raise DuplicateKeyException(
            f"Group with key {key} already exists in {type(self)} {self.key}."
        )
    self.groups[key] = group

add_groups(groups)

Adds a list of groups as subgroups of this group.

Parameters:

Name	Type	Description	Default
groups	list[Group]	A list of groups.	required

Source code in lib/python/src/aria/ops/definition/group.py

def add_groups(self, groups: list[Group]) -> None:
    """
    Adds a list of groups as subgroups of this group.

    Args:
        groups (list[Group]): A list of groups.
    """
    for group in groups:
        self.add_group(group)

define_group(key, label=None)

Create a new group that can hold attributes and subgroups.

Parameters:

Name	Type	Description	Default
key	str	The key for the group.	required
label	Optional[str]	Label that is displayed in the VMware Aria Operations UI. Defaults to the key.	None

Returns:

Type	Description
Group	The created group.

Source code in lib/python/src/aria/ops/definition/group.py

def define_group(self, key: str, label: Optional[str] = None) -> Group:
    """
    Create a new group that can hold attributes and subgroups.

    Args:
        key (str): The key for the group.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

    Returns:
         The created group.
    """
    group = Group(key, label)
    self.add_group(group)
    return group

define_instanced_group(key, label=None, instance_required=True)

Create a new group that can hold attributes and subgroups. This group can be 'instanced', with a value, so that its subgroups and attributes can appear multiple times, once for each instance value. For example, a group containing metrics for a network interface might be instanced for each discovered interface on the parent object.

Parameters:

Name	Type	Description	Default
key	str	The key for the group.	required
label	Optional[str]	Label that is displayed in the VMware Aria Operations UI. Defaults to the key.	None
instance_required	bool	If true, then this group must be created with an instance. Otherwise, it can be created both with and without an instance. Creating an instanced group without an instance can be done to provide a location for aggregate metrics across all instances, for example.	True

Returns:

Type	Description
Group	The created group.

Source code in lib/python/src/aria/ops/definition/group.py

def define_instanced_group(
    self, key: str, label: Optional[str] = None, instance_required: bool = True
) -> Group:
    """
    Create a new group that can hold attributes and subgroups. This group can be 'instanced', with a value, so that
    its subgroups and attributes can appear multiple times, once for each instance value. For example, a group
    containing metrics for a network interface might be instanced for each discovered interface on the parent
    object.

    Args:
        key (str): The key for the group.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
        instance_required (bool): If true, then this group must be created with an instance. Otherwise, it can be
            created both with and without an instance. Creating an instanced group without an instance can be done
            to provide a location for aggregate metrics across all instances, for example.

    Returns:
         The created group.
    """
    group = Group(key, label, instanced=True, instance_required=instance_required)
    self.add_group(group)
    return group

define_metric(key, label=None, unit=None, is_rate=False, is_discrete=False, is_kpi=False, is_impact=False, is_key_attribute=False)

Parameters:

Name	Type	Description	Default
key	str	Used to identify the parameter.	required
label	Optional[str]	Label that is displayed in the VMware Aria Operations UI. Defaults to the key.	None
unit	Optional[Unit]	Specifies what unit this metric is returned in. This allows the UI to display the units in a consistent manner, and perform conversions when appropriate.	None
is_rate	bool	Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this will be set automatically. Otherwise, defaults to False.	False
is_discrete	bool	Declares that this attribute's range of values is discrete (integer) rather than continuous (floating point)	False
is_kpi	bool	If set, threshold breaches for this metric will be used in the calculation of the object's 'Self - Health Score' metric, which can affect the 'Anomalies' Badge.	False
is_impact	bool	If set, this attribute will never be the 'root cause' of an issue. For example, it could be a proxy to a root cause, but not the root cause itself.	False
is_key_attribute	bool	True if the attribute should be shown in some object summary widgets in the UI.	False

Source code in lib/python/src/aria/ops/definition/group.py

def define_metric(
    self,
    key: str,
    label: Optional[str] = None,
    unit: Optional[Unit] = None,
    is_rate: bool = False,
    is_discrete: bool = False,
    is_kpi: bool = False,
    is_impact: bool = False,
    is_key_attribute: bool = False,
) -> MetricAttribute:
    """
    Args:
        key (str): Used to identify the parameter.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
        unit (Optional[Unit]): Specifies what unit this metric is returned in. This allows the UI to display the
            units in a consistent manner, and perform conversions when appropriate.
        is_rate (bool): Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this
            will be set automatically. Otherwise, defaults to False.
        is_discrete (bool): Declares that this attribute's range of values is discrete (integer) rather than
            continuous (floating point)
        is_kpi (bool): If set, threshold breaches for this metric will be used in the calculation of the object's
            'Self - Health Score' metric, which can affect the 'Anomalies' Badge.
        is_impact (bool): If set, this attribute will never be the 'root cause' of an issue. For example, it could
            be a proxy to a root cause, but not the root cause itself.
        is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI.
    """
    metric = MetricAttribute(
        key,
        label,
        unit,
        is_rate,
        is_discrete,
        is_kpi,
        is_impact,
        is_key_attribute,
        dashboard_order=len(self.attributes),
    )
    self.add_attribute(metric)
    return metric

define_numeric_property(key, label=None, unit=None, is_rate=False, is_discrete=False, is_kpi=False, is_impact=False, is_key_attribute=False)

Parameters:

Name	Type	Description	Default
key	str	Used to identify the parameter.	required
label	Optional[str]	Label that is displayed in the VMware Aria Operations UI. Defaults to the key.	None
unit	Optional[Unit]	Specifies what unit this metric is returned in. This allows the UI to display the units in a consistent manner, and perform conversions when appropriate.	None
is_rate	bool	Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this will be set automatically. Otherwise, defaults to False.	False
is_discrete	bool	Declares that this attribute's range of values is discrete (integer) rather than continuous (floating point). Defaults to False, unless 'is_string' is set, in which case it will always be set to True.	False
is_kpi	bool	If set, threshold breaches for this metric will be used in the calculation of the object's 'Self - Health Score' metric, which can affect the 'Anomalies' Badge.	False
is_impact	bool	If set, this attribute will never be the 'root cause' of an issue. For example, it could be a proxy to a root cause, but not the root cause itself.	False
is_key_attribute	bool	True if the attribute should be shown in some object summary widgets in the UI.	False

Source code in lib/python/src/aria/ops/definition/group.py

def define_numeric_property(
    self,
    key: str,
    label: Optional[str] = None,
    unit: Optional[Unit] = None,
    is_rate: bool = False,
    is_discrete: bool = False,
    is_kpi: bool = False,
    is_impact: bool = False,
    is_key_attribute: bool = False,
) -> PropertyAttribute:
    """
    Args:
        key (str): Used to identify the parameter.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
        unit (Optional[Unit]): Specifies what unit this metric is returned in. This allows the UI to display the
            units in a consistent manner, and perform conversions when appropriate.
        is_rate (bool): Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this
            will be set automatically. Otherwise, defaults to False.
        is_discrete (bool): Declares that this attribute's range of values is discrete (integer) rather than
            continuous (floating point). Defaults to False, unless 'is_string' is set, in which case it will always
            be set to True.
        is_kpi (bool): If set, threshold breaches for this metric will be used in the calculation of the object's
            'Self - Health Score' metric, which can affect the 'Anomalies' Badge.
        is_impact (bool): If set, this attribute will never be the 'root cause' of an issue. For example, it could
            be a proxy to a root cause, but not the root cause itself.
        is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI.
    """
    _property = PropertyAttribute(
        key,
        label,
        False,
        unit,
        is_rate,
        is_discrete,
        is_kpi,
        is_impact,
        is_key_attribute,
        dashboard_order=len(self.attributes),
    )
    self.add_attribute(_property)
    return _property

define_string_property(key, label=None, unit=None, is_rate=False, is_discrete=False, is_kpi=False, is_impact=False, is_key_attribute=False)

Parameters:

Name	Type	Description	Default
key	str	Used to identify the parameter.	required
label	Optional[str]	Label that is displayed in the VMware Aria Operations UI. Defaults to the key.	None
unit	Optional[Unit]	Specifies what unit this metric is returned in. This allows the UI to display the units in a consistent manner, and perform conversions when appropriate.	None
is_rate	bool	Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this will be set automatically. Otherwise, defaults to False.	False
is_discrete	bool	Declares that this attribute's range of values is discrete (integer) rather than continuous (floating point). Defaults to False, unless 'is_string' is set, in which case it will always be set to True.	False
is_kpi	bool	If set, threshold breaches for this metric will be used in the calculation of the object's 'Self - Health Score' metric, which can affect the 'Anomalies' Badge.	False
is_impact	bool	If set, this attribute will never be the 'root cause' of an issue. For example, it could be a proxy to a root cause, but not the root cause itself.	False
is_key_attribute	bool	True if the attribute should be shown in some object summary widgets in the UI.	False

Source code in lib/python/src/aria/ops/definition/group.py

def define_string_property(
    self,
    key: str,
    label: Optional[str] = None,
    unit: Optional[Unit] = None,
    is_rate: bool = False,
    is_discrete: bool = False,
    is_kpi: bool = False,
    is_impact: bool = False,
    is_key_attribute: bool = False,
) -> PropertyAttribute:
    """

    Args:
        key (str): Used to identify the parameter.
        label (Optional[str]): Label that is displayed in the VMware Aria Operations UI. Defaults to the key.
        unit (Optional[Unit]): Specifies what unit this metric is returned in. This allows the UI to display the
            units in a consistent manner, and perform conversions when appropriate.
        is_rate (bool): Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this
            will be set automatically. Otherwise, defaults to False.
        is_discrete (bool): Declares that this attribute's range of values is discrete (integer) rather than
            continuous (floating point). Defaults to False, unless 'is_string' is set, in which case it will always
            be set to True.
        is_kpi (bool): If set, threshold breaches for this metric will be used in the calculation of the object's
            'Self - Health Score' metric, which can affect the 'Anomalies' Badge.
        is_impact (bool): If set, this attribute will never be the 'root cause' of an issue. For example, it could
            be a proxy to a root cause, but not the root cause itself.
        is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI.
    """
    _property = PropertyAttribute(
        key,
        label,
        True,
        unit,
        is_rate,
        is_discrete,
        is_kpi,
        is_impact,
        is_key_attribute,
        dashboard_order=len(self.attributes),
    )
    self.add_attribute(_property)
    return _property