Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.
    Appd tocbox

    On this page:

    Table of Contents
    maxLevel2
    minLevel2

     

    Server tagging makes it easy to query, filter, and compare related servers using custom metadata. You can tag related servers based on OS, location, tier, owner, or any other relevant criteria. Server tags provide additional context to server metrics. For example, you might want to specify deployment-version tags to the servers in a specific cluster; then you can use these tags to identify anomalies in server metrics during a new deployment. 

    Service Tagging requires a Server Visibility license. Server Tagging is currently available for Linux, Windows, and Solaris. 

    TBD DOCS-2010

    Server Visibility can import the following tags automatically.

    SourceTagsNotes
    Server

    Server Visibility can import the following tags from the Machine Agent. These tags appear in the Server Dashboard under Tags.

    • OS Architecture
    • OS Kernel
    • AppDynamics Agent Version
    These tags require 4.4 or higher of the Controller and 4.2 or higher of the Standalone Machine Agent.
    Amazon Web Services

    These tags appear in the Server Dashboard under Tags as AWS|<tag>.

    • resource-id
    • availability-zone
    • region
    • ami-id
    • instance-type
    • security-group
    These tags require 4.4 or higher of the Controller and the Standalone Machine Agent.
    Docker

    Server Visibility can import user-defined tags and system container-level tags. These appear under Container Details > Tags as Docker|<tag>.

    The exact set of tags imported can vary depending on the system on which the container is running.

    These tags require 4.3.3 or higher of the Controller and the Standalone Machine Agent.

    Kubernetes

    OpenShift

    Server Visibility can import ReplicaSet and pod tags. These appear under Container Details > Tags as K8s|<tag>.These tags require 4.4.3 or higher of the Controller and the Standalone Machine Agent.

     

    Viewing Servers by Tag in the Controller UI

    View filter servers by tag in the Servers list, click the Filters button and add the criteria you want for the tag filer. If you specify multiple criteria, the filter performs an AND search (for criteria with different keys) and an OR search (for criteria with the same key). In the following example, the tag criteria filters all servers with

    1. Tier tag that equals ECommWeb OR ECommInventory, AND
    2. An OS Architecture tag that equals x86_64.

    Defining and Viewing Tags for a Server

    You can specify custom tags as a set of key/value strings in the agent config directory. Each agent can support up to 50 tags by default.

    Info

    Note the following good practices for defining server tags:

    • If an agent is deployed in Amazon Web Services, the agent can auto-detect and import tags defined in AWS. The Controller also auto-assigns a set of default tags to each server.
      The primary use case for custom tags is to specify information that is not already specified in AWS and auto-assigned tags. Before you specify custom tags in the agent config directory, it is good practice to review the current set of tags: go to the Server Dashboard and view the Tags pane at the bottom of the page.

      Be careful not to define duplicate tags in the YML file.

     

    Div
    styleclear:both;

    Configure the following option in <machine_agent_home>/extensions/ServerMonitoring/ServerMonitoringConfig.yml :

    SettingDescription

    tag

    A list of user-defined tags for the individual server. You can use these tags to query, filter, aggregate, and compare related servers.
    Each tag is specified by a key-value pair. You can define tag names up to 127 unicode characters and tag values up to 255 unicode characters. Define each each key on a separate line. All key/value strings should be within single quotes. If a key has multiple values, delineate the list with commas:
    <key>: [ <value> ]  
    tags:
        'Location': ['NYC', 'Data Center', 'Server Room 7']
        'Environment': ['preProduction']

     

    Importing Tags from Docker

    Server Visibility can import some tags from Docker. See Kubernetes and AppDynamics APM.

    TBD – DOCS-2010

    Importing Tags from Kubernetes

    Server Visibility can import some tags from Kubernetes. See Kubernetes and AppDynamics APM.

    Importing Tags from Amazon Web Services

    Info

    Detailed information about Amazon Web Services is outside the scope of AppDynamics documentation. The following links are provided as a convenience and might not work if Amazon reorganizes its website or documentation.

     

    Before Server Visibility can import tags from AWS, you must must set up IAM roles:
    1. Log in to the AWS console: https://console.aws.amazon.com/iam/
    2. Create a role that has read access to EC2 tags. 
    3. Add this role to your EC2 instance.
      For information about these two steps, search for "To create an IAM role using the IAM console" and "Attaching an IAM Role to an Instance" in the following page:
       http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
    4. Run the Standalone Machine Agent with Amazon Web Services enabled.

    Configuration Options for Server Tagging

    To edit these settings, log in to the Controller administration console using the root user password. See Access the Administration Console.

    Div
    styleclear:both;
    Server Visibility PropertyDescriptionDefault
    sim.machines.tags.enabled

    Enable/disable server tags for all servers.

    True
     sim.machines.tags.aws.enabledEnable/disable collection of AWS tags for all servers.True
     sim.machines.tags.aws.pollingInterval

    Length of time in milliseconds between each polling of AWS tags

    21600000
    (6 hours)  

     sim.machines.tags.maxPerMachineMaximum number of unique tags per account. 50
     sim.machines.tags.maxPerAccount

    Maximum number of unique tags per account.

     500