Shape How You Monitor Your Environment with Attribute Rules

apmdevops106
HID_Attributes
Administrator privileges grant you access to the settings tools. Administrators can perform the following tasks:
This setup lets your users view the environment efficiently and triage issues. In the map, identify components against known system architecture. If components are missing with all filters deselected, contact CA Support to ensure that the correct extensions are deployed.
After an upgrade of APM, alerts and thresholds are maintained and are available on the dashboard and map.
Attributes
Attributes are labels that are applied to nodes. Perspectives, highlighting, and filtering use these attributes to organize and display the parts of the monitored application environment. Application Performance Management has no limit to the number of attributes you can assign to components. Attributes make it easier to differentiate components and identify their relationships to other components. Use these attributes to view the map from different perspectives, filter out components, and highlight components. Each attribute has a name and a value (for example, color=red).
  • Basic Attributes
    Basic attributes are automatically added to each component. Basic attributes automatically use information that is taken from the agent reporting on that component.
  • Custom Attributes
    Custom attributes can be set manually or automatically. Users can create an attribute manually in the user interface or with the REST API. Or, Application Performance Management sets their values automatically, based on shipped or user-supplied rules. Custom attributes can be assigned to individual components, groups, and groups that are subject to a filter.
    Use basic and custom attributes to create the data view that you need. For example, to see Order applications in London, filter by Location= London and Application=Orders, and view by Location perspective. Ascribe a new attribute to this group. For example, Support Tech=John, to see all Orders applications in London that John supports.
  • Decorated Attributes
    Attributes created automatically as a result of attribute rules are called decorated attributes.
Attribute Rules
The process of adding custom attributes can be automated using rules. The rule uses basic and custom attributes that are already ascribed to a component. If the attribute meets the condition that is specified in the rule, a custom attribute name is created (or updated) and assigned the specified value. For example, an attribute rule states that if the hostname attribute of a node ends with the .cz suffix, the custom attribute with name
Support Location
is created and its value is
Czech Republic
. All components that meet the criteria of a rule are ascribed the custom attribute value. Rules ascribe the custom attribute in the current environment. Rules also ascribe that attribute to any component which meets the criteria in the future.
  • Local Attribute Rules
    As a user, you can create local attribute rules that apply to components within your universe. The rule applies the new attribute value to all components that meet the criteria and are within the current universe. These custom attributes are exclusive to the universe. Only users with access to this universe and the administrator can see them.
  • Global Attribute Rules
    Global attribute rule applies custom attribute values to all components that meet the rule criteria in the enterprise environment. Only the administrator can create global attribute rules. Global attribute rules take precedence over local attribute rules.
    Example: Create a local attribute to set a location attribute value to Long Island. If a global attribute rule is set to assign the location attribute value to New York, the value shows New York for all users.
  • Attribute Filter
    You can filter the content that Application Performance Management displays by specific attribute values. This filter is an attribute filter. All components that do not have the specified attribute value are removed from the data set.
Create Custom Attributes
Create custom attributes on components so that users can view perspectives and filter the map according to components that share an attribute name. You can add a custom attribute to an individual component or with an attribute rule. Custom attributes let users easily identify and relate to specific components. Analysts then view perspectives and filter the map according to components that share attribute name. Application Performance Management enables filtering by any attribute value.
We recommend that you ascribe custom attributes to all components in the environment. We recommend assigning values for 
owner
 and 
location
 to all components. 
Follow these steps
:
  1. In the
    Map
    view, click a node.
  2. Go to the
    Custom Attributes
    section of the Details panel, click
    <new attribute name>
  3. Type the attribute name.
  4. Click
    <new attribute value>
    and assign a value to the attribute.
  5. Click the node in the map.
    The new attribute and value appear in the Custom Attributes section of the Details panel.
  6. Click below the value. The attribute is added to the node. 
    You can add a custom attribute to a node representing a group. The attribute name and value are added to all components in that group. A prompt asks if you want to add the attribute to the group or create an attribute rule. 
Application Performance Management recognizes if an attribute value is an email address or a URL. A link or envelope icon appears next to the attribute in the Details panel. Users click the icon to open links in a new browser tab or open an Outlook email page.
Delete Custom Attributes
Delete a custom attribute that you no longer need.
Follow these steps:
  1. In the left corner, click the side panel and and select
    Attributes
    .
    Existing Attribute Rules appear.
  2. Under the
    Custom Attribute Name
    column, select the attribute that you want to delete.
  3. In the
    Actions
    column, click
    Delete
    .
    The custom attribute is deleted.
Create Global Attribute Rules
Create attribute rules to assign attributes to components automatically. Global attribute rules apply custom attributes to all current and future components that meet the condition of the rule definition. Global attribute rules apply to all components in the Enterprise environment regardless of universe. Any user who has the component that is assigned to their universe sees the custom attribute. A user cannot create a local attribute rule that overwrites a global attribute rule value.
Follow these steps
:
  1. In the
    Settings
     side panel, click the
    Attributes 
    tab.
  2. Click
    <new attribute rule>
     in the
    Custom Attribute Name
    column and complete the names and values for the new rule.
  3. Click away from the row.
    The rule is saved.
Use RegEx Operand with Attribute Rules
Use the
Contains RegEx
operand in these cases:
  •  Operands such as
    Starts with
    or
    Contains
    are not enough to create the attribute rule you require.
  • You need a new attribute value that is based on the original value.
One RegEx expression that is used on an existing attribute value can be used to create several custom attribute rules.
Follow these steps:
  1. In the
    Settings
    page, click the
    ATTRIBUTE RULES
    tab.
  2. Click
    <new attribute rule>
    .
  3. Ascribe a custom attribute name.
  4. Ascribe a RegEx Group Value to the
    Newly Assigned Value.
  5. Select the required
    Existing Attribute Name
    .
  6. Select a
    Condition/Matching Operator
    value:
    Contains RegEx
    or
    Doesn't contain RegEx
    .
  7. Enter the RegEx into
    Condition Value
    , and press
    Enter
    .
    Case Sensitive
     cannot be selected. Case sensitivity is decided based on a RegEx operand.
The attribute rule is saved and the number of components with the new attribute is displayed in
Affected Components
.
  • Example: Hostname in your network follows the rule
    <2-letter country code><city><numeric ID>.vendor.com
    You can use the RegEx operand to create attribute rules to create separate Country and City attributes from the Hostname. The syntax
    "(..)([a-z]*)[0-9]*\.vendor\.com"
    describes this RegEx.
    You can create attribute rules to extract values for Country and City by creating these attribute rules.
    Custom Attribute Name
    Newly Assigned Value
    Existing Attribute Name
    Condition/Matching Operator
    Case Sensitive
    Condition Value
    Country
    $1
    hostname
    ContainsRegEx
    (..)([a-z]*)[0-9]*\.vendor\.com
    City
    $2
    hostname
    ContainsRegEx
    (..)([a-z]*)[0-9]*\.vendor\.com
  • Example: Two host name values in one environment: uklondon1234.vendor.com and usdallas1234.vendor.com
    $1 returns values of uk and us, $2 returns values of london and dallas. You can also create a link to your documentation like the following example. Click any map element to see a link to your documentation.
    Custom Attribute Name
    Newly Assigned Value
    Existing Attribute Name
    Condition/Matching Operator
    Case Sensitive
    Condition Value
    Country
    $1
    hostname
    ContainsRegEx
    (..)([a-z]*)[0-9]*\.vendor\.com
    City
    $2
    hostname
    ContainsRegEx
    (..)([a-z]*)[0-9]*\.vendor\.com
    Documentation URL
    https://wiki.vendor.com/searchForServerDoc.cgi?host=$1
    hostname
    ContainsRegEx
    (.*)\.vendor\.com
     For full RegEx syntax, see Java RegEx documentation. Optionally, search the Internet for Online Java RegEx tester.