Shape How You Monitor Your Environment with Attribute Rules

apmsaas
HID_Attributes
Attributes are labels that are applied to components. Each attribute has a name and a value (for example, color=red). Attributes make it easier to differentiate components and identify their relationships to other components. Use attributes in your perspectives, highlighting, and filtering to organize and display parts of the monitored application environment.
DX APM
lets you assign an unlimited number of attributes to components.
3
Attribute Types
DX APM
offers the following attribute types:
  • Basic Attributes
    Basic attributes are automatically reported and assigned to each component from the associated agent. For example, a database component can have the following basic attributes:
    • databasename
    • inferredBackendNode
    • Name
    • provider
    • Source cluster
    • Type
  • Custom Attributes
    Assign custom attributes to individual components, then add these attributes to perspectives, groups and filters. For example, use the
    owner
    attribute to assign the component to a specific analyst. To view components that are assigned to this analyst, add the
    owner
    attribute to a filter and specify the filter value.
  • Decorated Attributes
    You can define attribute rules that automatically assign new values to existing attributes. These newly derived attributes are called decorated attributes.
Define Custom Attributes
Define a custom attribute for an individual component or group of components.
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
    , select a component or group.
    You can add a custom attribute to a component that represents 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.
  2. Go to the
    Custom Attributes
    section of the
    Component View
    panel and select values for the following default custom attributes:
    • location
    • owner
    • region
    • tier
  3. (Optional) To create a new attribute, select
    <new attribute name>
    and type the attribute name. Select
    <new attribute value>
    and assign a value to the attribute.
    DX APM
    recognizes if an attribute value is an email address or a URL. A link or envelope icon appears next to the attribute in the
    Component View
    panel. Select the icon to open links in a new browser tab or open an Outlook email page.
  4. Add the new attribute to filters and perspectives.
The new attribute and value appear in the
Custom Attributes
section of the
Component View
panel.
Define Cross-Layer Attributes
Attributes that are assigned to components from a specific layer are visible across other layers in
DX APM
. For example, attributes that are assigned to components from the Infrastructure Layer are included in the drop-down list that is used to filter the Map in the Application Layer. This cross-layer functionality offers analysts data views that show the relationships between application components and their connected infrastructure components. This combined data view also works as an overview that can help with defining and organizing support roles across an organization. Administrators can assign attributes to components from the Infrastructure Layer in the
Custom Attributes
section of the
Component View
panel or by defining an attribute rule.
Examples
Example 1: Use Cross-Layer Attributes to Assist with Infrastructure Triage
The attribute
Owner = Joe Smith
is assigned to all infrastructure components that Joe supports. This attribute is then used to create the perspective
Joe Smith
. Analysts use this perspective and other
Owner
perspectives to identify who supports the infrastructure for applications that require triage. With these data views, analysts are also able to provide infrastructure support with key information that can result in faster triage.
Example 2: Use Cross-Layer Attributes to Define Support Roles
If the host components in your environment follow a naming convention, you can create an attribute rule to define support roles for application components. The following attribute rule assigns Joe Smith to all host components located in New York. A perspective is then created based on this attribute, which allows analyst Joe Smith to view their assigned application components and all connected infrastructure components.
Custom Attribute Name
Newly Assigned Value
Existing Attribute Name
Condition/Matching Operator
Condition Value
Owner
Joe Smith
Hostname
Contains
NY
The following links provide more information about layers and how to use attributes in
DX APM
:
Define Decorated Attributes Using Attribute Rules
Use rules to automate the process of adding custom attributes. A 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 component 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.
Define Global Attribute Rules
Define 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. Select the
    Attributes
    tab.
  2. Click
    <new attribute rule>
    in the
    Custom Attribute Name
    column and complete the name and value 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. Select the
    Attributes
    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. Select 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.