Skip to content

Attribute

Attribute

Bases: ABC

Source code in lib/python/src/aria/ops/definition/attribute.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class Attribute(ABC):
    def __init__(
        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,
        dashboard_order: int = 0,
    ):
        """

        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[str]): 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.
            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. Defaults to 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. Defaults to False.
            is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI.
            dashboard_order (int): Determines the order parameters will be displayed in the UI. Defaults to 0
        """
        self.key = validate_key(key, "Attribute")
        self.label = label
        if label is None:
            self.label = key
        self.unit = unit.value.key if unit else None
        self.is_rate = unit.value.is_rate if unit else is_rate
        self.is_discrete = is_discrete
        self.is_kpi = is_kpi
        self.is_impact = is_impact
        self.is_key_attribute = is_key_attribute
        self.dashboard_order = dashboard_order

    def to_json(self) -> dict:
        return {
            "key": self.key,
            "label": self.label,
            "unit": self.unit,
            "is_rate": self.is_rate,
            "is_discrete": self.is_discrete,
            "is_kpi": self.is_kpi,
            "is_impact": self.is_impact,
            "is_key_attribute": self.is_key_attribute,
            "dashboard_order": self.dashboard_order,
        }

__init__(key, label=None, unit=None, is_rate=False, is_discrete=False, is_kpi=False, is_impact=False, is_key_attribute=False, dashboard_order=0)

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[str]

Specifies what unit this metric is returned in. This allows the UI to display the units in a

 None

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. 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. Defaults to 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. Defaults to False. is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI. dashboard_order (int): Determines the order parameters will be displayed in the UI. Defaults to 0

Source code in lib/python/src/aria/ops/definition/attribute.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def __init__(
    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,
    dashboard_order: int = 0,
):
    """

    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[str]): 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.
        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. Defaults to 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. Defaults to False.
        is_key_attribute (bool): True if the attribute should be shown in some object summary widgets in the UI.
        dashboard_order (int): Determines the order parameters will be displayed in the UI. Defaults to 0
    """
    self.key = validate_key(key, "Attribute")
    self.label = label
    if label is None:
        self.label = key
    self.unit = unit.value.key if unit else None
    self.is_rate = unit.value.is_rate if unit else is_rate
    self.is_discrete = is_discrete
    self.is_kpi = is_kpi
    self.is_impact = is_impact
    self.is_key_attribute = is_key_attribute
    self.dashboard_order = dashboard_order

MetricAttribute

Bases: Attribute

Source code in lib/python/src/aria/ops/definition/attribute.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
class MetricAttribute(Attribute):
    def __init__(
        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,
        dashboard_order: int = 0,
    ):
        """

        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.
            dashboard_order (bool): Determines the order parameters will be displayed in the UI.
        """
        super().__init__(
            key,
            label,
            unit,
            is_rate,
            is_discrete,
            is_kpi,
            is_impact,
            is_key_attribute,
            dashboard_order,
        )

    def to_json(self) -> dict:
        return super().to_json() | {
            "data_type": "integer" if self.is_discrete else "float",
            "is_property": False,
        }

__init__(key, label=None, unit=None, is_rate=False, is_discrete=False, is_kpi=False, is_impact=False, is_key_attribute=False, dashboard_order=0)

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
dashboard_order bool

Determines the order parameters will be displayed in the UI.

 0
Source code in lib/python/src/aria/ops/definition/attribute.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def __init__(
    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,
    dashboard_order: int = 0,
):
    """

    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.
        dashboard_order (bool): Determines the order parameters will be displayed in the UI.
    """
    super().__init__(
        key,
        label,
        unit,
        is_rate,
        is_discrete,
        is_kpi,
        is_impact,
        is_key_attribute,
        dashboard_order,
    )

PropertyAttribute

Bases: Attribute

Source code in lib/python/src/aria/ops/definition/attribute.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
class PropertyAttribute(Attribute):
    def __init__(
        self,
        key: str,
        label: Optional[str] = None,
        is_string: bool = True,
        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,
        dashboard_order: int = 0,
    ):
        """

        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.
            is_string (bool): Determines if the property is numeric or string (text).
            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.
            dashboard_order (int): Determines the order parameters will be displayed in the UI.
        """
        super().__init__(
            key,
            label,
            unit,
            is_rate,
            is_discrete,
            is_kpi,
            is_impact,
            is_key_attribute,
            dashboard_order,
        )
        self.is_string = is_string

    def to_json(self) -> dict:
        return super().to_json() | {
            "data_type": (
                "string"
                if self.is_string
                else "integer" if self.is_discrete else "float"
            ),
            "is_discrete": True if self.is_string else self.is_discrete,
            "is_property": True,
        }

__init__(key, label=None, is_string=True, unit=None, is_rate=False, is_discrete=False, is_kpi=False, is_impact=False, is_key_attribute=False, dashboard_order=0)

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
is_string bool

Determines if the property is numeric or string (text).

 True
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
dashboard_order int

Determines the order parameters will be displayed in the UI.

 0
Source code in lib/python/src/aria/ops/definition/attribute.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def __init__(
    self,
    key: str,
    label: Optional[str] = None,
    is_string: bool = True,
    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,
    dashboard_order: int = 0,
):
    """

    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.
        is_string (bool): Determines if the property is numeric or string (text).
        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.
        dashboard_order (int): Determines the order parameters will be displayed in the UI.
    """
    super().__init__(
        key,
        label,
        unit,
        is_rate,
        is_discrete,
        is_kpi,
        is_impact,
        is_key_attribute,
        dashboard_order,
    )
    self.is_string = is_string