Previous Topic: AttributeGroup (Metric Family)Next Topic: Discovery Attributes


General Attributes (Metric Family)

The general attributes for all metric families are as follows:

Attribute/name

Specifies the unique, internal name. For metrics, this name is also used for naming the database column.

Note: This name is never exposed externally. To display an attribute name in the user interface, use the AttributeDisplayName element.

Can be updated: Yes

Possible values: Alphanumeric and underscore.

Effect of updating: For metrics, the values for this attribute are stored in a new database column corresponding to the updated name. The user loses the historical data that is collected for this metric (with the older name). The custom reports reporting on this metric fails.

When does the update take effect: Next poll

Required actions for updates to take effect: None

Attribute/type

Indicates the data type of this attribute. The most frequently used data types are Int, Long, Double, String, or ObjectID. The database stores metric attributes as a float. Therefore, these attributes must use a numeric type (we recommend a Double). Other types are used for item attributes.

Can be updated: Yes

Possible values: Boolean, Int, Long, Double (floating point), BigInteger, String, DateTime, IPAddress, MACaddress, IPSubnet, OctetString (hex representation), ObjectID, ItemID, QName (Qualified Name)

Note: The type names are case insensitive, for example, "boolean" is the same as Boolean.

Effect of updating: For metrics, none. All metrics are stored in the database as a float. For item attributes, the device must be deleted and rediscovered.

When does the update take effect: For metrics, next poll. For item attributes, on rediscover.

Required actions for updates to take effect: For metrics, none. For item attributes, delete the device and rediscover.

AttributeDisplayName

Specifies the value that appears in operator and administrator interfaces.

Can be updated: Yes

Possible values: Alphanumeric, space, and underscore.

Effect of updating: The metric reflects the updated AttributeDisplayName in the Metric Families UI and custom reports.

When does the update take effect: Immediately

Required actions for updates to take effect: None

Documentation

Displays the attribute description in the user interface. The documentation is also displayed in tool tips when you hover the cursor over the attribute name.

Can be updated: Yes

Possible values: Plain text

Effect of updating: Hovering the cursor over the attribute name shows the updated documentation.

When does the update take effect: Immediately

Required actions for updates to take effect: None

Polled

Indicates whether the attribute is polled. If it is set to false, it is only accessed during discovery.

Can be updated: Yes

Possible values: true, false

Effect of updating: If set to false, the OIDs corresponding to this attribute/metric are not polled when no other polled attribute/metric is using that OID in its expression. If set to true, the OIDs corresponding to this attribute/metric are polled.

When does the update take effect: Next poll

Required actions for updates to take effect: None

IsDbColumn

Stores its value in the database table. IsDbColumn is used for metric attributes. Set the IsDbColumn value to true when Polled is set to true.

Can be updated: Yes

Possible values: true, false

Effect of updating: If set to false, the data for this attribute/metric is not stored in the database. If set to true, the data for this attribute/metric is stored in the database.

When does the update take effect: Immediately

Required actions for updates to take effect: None