Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.
    Comment: Published by Scroll Versions from this space and version 20.8
    Sv translation
    languageen

    Use Server Tagging 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 may want to specify deployment-version tags to the servers in a specific cluster, and then use those tags to identify anomalies in server metrics during a new deployment. 

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

    Server Visibility can import the tags (described in the table) automatically.

    SourceTagsController and Agent Requirements
    Custom

    Server Visibility can import:

    • Controller version 4.4 or higher
    • Standalone Machine Agent version 4.4 or higher
    Machine Agent

    These tags display in the Server Dashboard under Tags:

    • OS Architecture
    • OS Kernel
    • AppDynamics Agent Version
    • Controller version 4.4 or higher
    • Standalone Machine Agent version 4.2 or higher
    Amazon Web Services

    These tags display in the Server Dashboard under Tags as AWS|<tag>. See Importing Tags from Amazon Web Services

    • resource-id
    • availability-zone
    • region
    • ami-id
    • instance-type
    • security-group
    • Controller version 4.4 or higher
    • Standalone Machine Agent version 4.4 or higher
    Docker

    Server Visibility can import user-defined tags and system container-level tags. These display 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.

    • Controller version 4.4.3 or higher
    • Standalone Machine Agent version 4.4.3 or higher

    Kubernetes

    OpenShift

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


    View Servers by Tag in the Controller UI

    To view filter servers by tag in the Servers list, select Filters and add the criteria you want for the tag filter. 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). This example shows the tag criteria filters for all servers with:

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

    Filters and Servers by Tagging

    Anchor
    custom
    custom
    Define and View 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

    Follow these suggested best practices to define 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, you should review the current set of tags. Access the Server Dashboard and view the Tags pane at the bottom of the page:
    Tags Pane

    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 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']


    Anchor
    imp-tags-aws
    imp-tags-aws
    Import Tags from Amazon Web Services

    Info

    Detailed information about Amazon Web Services is outside the scope of AppDynamics documentation.

    Before Server Visibility can import tags from AWS, you must set up IAM roles:

    1. Log in to the AWS console: https://console.aws.amazon.com/iam/
    2. Create a role with read access to EC2 tags.
      Specifically, the role must have an AWS Managed Policy with the required permissions (such as, AmazonEC2ReadOnlyAccess) attached. 
    3. Add this role to your EC2 instance.
      For information about these steps, search for "To create an IAM role using the IAM console" and "Attaching an IAM Role to an Instance" in this page
    4. Run the 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 or disable server tags for all servers

    True
    sim.machines.tags.aws.enabledEnable or disable the collection of AWS tags for all serversTrue
    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

    Configuration Options for Docker Tags

    You can configure the Machine Agent to collect different types of tags. By default, all tags are collected. To turn off tag collection, set dockerTagsEnabled to "false".

    1. Edit the <machine_agent_home>/extensions/DockerMonitoring/DockerMonitoringConfig.yml file.
    2. Under the containerMonitoringConfig section, set dockerTagsEnabled: "false"

      Code Block
      # WARNING: Before making any changes to this file read the following section carefully
      # 
      # After editing the file, make sure the file follows the yml syntax. Common issues include
      # - Using tabs instead of spaces
      # - File encoding should be UTF-8
      #
      # The safest way to edit this file is to copy paste the examples provided and make the
      # necessary changes using a plain text editor instead of a WYSIWYG editor.
      #
      
      # samplingInterval indicates how often to gather metric data. Units in milliseconds.
      samplingInterval: 30000
      
      containerMonitoringConfig:
          # containerProcessSelectorRegex defines regular expression to evaluate the processes in
          # each running container to be monitored by the machine agent. The regular expression is
          # compared against each process full command line within running
          # If the pattern matches, then the machine agent start monitoring it.
          containerProcessSelectorRegex: ".*[ ]-Dappdynamics.*"
          dockerTagsEnabled: "false" 

    Configuration Options for AWS Tags

    You can configure the Machine Agent to collect different types of tags. By default, all tags are collected. To turn off tag collection, set awsTagsEnabled to "false".

    1. Edit the <machine_agent_home>/extensions/ServerMonitoring/conf/ServerMonitoring.yml file.
    2. Set awsTagsEnabled: "false" 
      Code Block
      //ServerMonitoring.yml
      # WARNING: Before making any changes to this file read the following section carefully
      # 
      # After editing the file, make sure the file follows the yml syntax. Common issues include
      # - Using tabs instead of spaces
      # - File encoding should be UTF-8
      #
      # The safest way to edit this file is to copy paste the examples provided and make the
      # necessary changes using a plain text editor instead of a WYSIWYG editor.
      #
      awsTagsEnabled: "false"
      # samplingInterval indicates how often to gather metric data. Units in milliseconds.
      samplingInterval: 30000
      ...

    Configuration Options for Kubernetes and OpenShift Tags

    You can configure the Machine Agent to collect different types of tags. By default, all tags are collected. To turn off tag collection, set k8sTagsEnabled to "false".

    1. Edit the <machine_agent_home>/extensions/ServerMonitoring/conf/ServerMonitoring.yml file.
    2. Set k8sTagsEnabled: "false"
      Code Block
      //ServerMonitoring.yml
      # WARNING: Before making any changes to this file read the following section carefully
      # 
      # After editing the file, make sure the file follows the yml syntax. Common issues include
      # - Using tabs instead of spaces
      # - File encoding should be UTF-8
      #
      # The safest way to edit this file is to copy paste the examples provided and make the
      # necessary changes using a plain text editor instead of a WYSIWYG editor.
      #
      k8sTagsEnabled: "false"
      # samplingInterval indicates how often to gather metric data. Units in milliseconds.
      samplingInterval: 30000
      ...


    Sv translation
    languageja
    Appd tocbox

    On this page:

    Table of Contents
    maxLevel2
    minLevel2

     

    サーバのタグ付けにより、カスタムメタデータを使用して、関連するサーバの照会、フィルタ処理、および比較を簡単に行うことができます。OS、ロケーション、階層、所有者、またはその他の関連する基準に基づいて、関連するサーバにタグを付けることができます。サーバタグは、サーバメトリックに追加のコンテキストを提供します。たとえば、特定のクラスタ内のサーバに対して、デプロイバージョンのタグを指定できます。その後、これらのタグを使用して、新しいデプロイ時にサーバメトリックの異常を識別できます。 

    サービスのタグ付けには、サーバの可視性のライセンスが必要です。サーバのタグ付けは、現在、Linux、Windows、および Solaris で利用できます。 

     

     

     

     

     

    サーバの可視性により、次のタグを自動的にインポートできます。

    送信元タグコントローラ/エージェントの要件
    カスタム

    サーバの可視性で以下をインポートできます。

    • コントローラ 4.4 以降
    • スタンドアロン マシン エージェント 4.4 以降
    マシンエージェント

    次のタグは、サーバダッシュボードの [Tags] に表示されます。

    • OS アーキテクチャ
    • OS カーネル
    • AppDynamics エージェントのバージョン
    • コントローラ 4.4 以降
    • スタンドアロン マシン エージェント 4.2 以降
    Amazon Web Services

    次のタグは、サーバダッシュボードの [Tags] に AWS|<tag> として表示されます。以下の「Amazon Web Services からのタグのインポート」を参照してください。

    • resource-id
    • availability-zone
    • region
    • ami-id
    • instance-type
    • security-group
    • コントローラ 4.4 以降
    • スタンドアロン マシン エージェント 4.4 以降
    Docker

    サーバの可視性により、ユーザ定義のタグとシステムコンテナレベルのタグをインポートできます。これらは、[Container Details] > [Tags] に Docker|<tag> として表示されます。

    インポートされるタグの正確なセットは、コンテナが実行されているシステムによって異なります。

    • コントローラ 4.4.3 以降
    • スタンドアロン マシン エージェント 4.4.3 以降

    Kubernetes

    OpenShift

    サーバの可視性により、ReplicaSet タグとポッドタグをインポートできます。これらは、[Container Details] > [Tags] に K8s|<tag> として表示されます。
    • コントローラ 4.4.3 以降
    • スタンドアロン マシン エージェント 4.4.3 以降

     

    コントローラ UI でのタグによるサーバの表示

    [Servers] リストでタグによってサーバをフィルタ処理して表示し、[Filters] ボタンをクリックして、タグファイラに必要な条件を追加します。複数の条件を指定すると、フィルタは AND 検索(キーが異なる条件の場合)および OR 検索(キーが同じ条件の場合)を実行します。次の例では、タグ条件によって、次のタグがあるすべてのサーバがフィルタ処理されます。

    1. ECommWeb または ECommInventory に等しい Tier タグ、および
    2. x86_64 に等しい OS Architectur タグ。

    Anchor
    custom
    custom
    サーバのタグの定義と表示

    エージェント設定ディレクトリでキー/値の文字列のセットとしてカスタムタグを指定できます。各エージェントは、デフォルトで最大 50 のタグをサポートできます。

    Info

    サーバタグを定義する場合、次の推奨事項に留意してください。

    • エージェントが Amazon Web Services にデプロイされている場合、エージェントは AWS で定義されている重要なタグを自動検出してインポートできます。また、コントローラは、デフォルトのタグのセットを各サーバに自動的に割り当てます。
      カスタムタグの主な使用例は、AWS および自動割り当てタグでまだ指定されていない情報を指定することです。エージェント設定ディレクトリでカスタムタグを指定する前に、現在のタグのセットを確認することをお勧めします。サーバダッシュボードに移動し、ページの下部にある [Tags] ペインを表示します。

      YML ファイルに重複するタグを定義しないようにしてください。

     

    Div
    styleclear:both;

    <machine_agent_home>/extensions/ServerMonitoring/ServerMonitoringConfig.yml で次のオプションを設定します。

    設定説明

    tag

    個々のサーバのユーザ定義タグのリスト。これらのタグを使用して、関連するサーバの照会、フィルタ処理、集約、および比較を行うことができます。
    各タグは、キーと値のペアによって指定します。最大 127 の Unicode 文字のタグ名と、最大 255 の Unicode 文字のタグ値を定義できます。各キーを別々の行に定義します。すべてのキー/値の文字列は、単一引用符で囲む必要があります。キーに複数の値がある場合は、カンマを使用してリストを指定します。
    <key>: [ <value> ]  
    tags:
        'Location': ['NYC', 'Data Center', 'Server Room 7']
        'Environment': ['preProduction']

     

    Anchor
    imp-tags-aws
    imp-tags-aws
    Amazon Web Services からのタグのインポート

    Info

    Amazon Web Services についての詳細は、AppDynamics のドキュメントの範囲外です。次のリンクは利便性のために提供されていて、Amazon が Web サイトまたはドキュメントを再編成した場合には機能しない可能性があります。

     

    サーバの可視性により AWS からタグをインポートできるようになる前に、IAM ロールを設定する必要があります。
    1. AWS コンソールにログインします。https://console.aws.amazon.com/iam/
    2. EC2 タグの読み取りアクセス権を持つロールを作成します。
      特に、このロールには、必要な権限(AmazonEC2ReadOnlyAccess など)が添付された AWS 管理対象ポリシーが必要です。 
    3. このロールを EC2 インスタンスに追加します。
      これらの 2 つの手順の詳細については、次のページで「To create an IAM role using the IAM console」および「Attaching an IAM Role to an Instance」を検索してください。
      http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
    4. Amazon Web Services が有効な状態でマシンエージェントを実行します。

    サーバのタグ付けの設定オプション

    これらの設定を編集するには、root ユーザのパスワードを使用して、コントローラの管理コンソールにログインします。 Access the Administration Console」を参照してください。

    Div
    styleclear:both;
    サーバの可視性プロパティ説明デフォルト
    sim.machines.tags.enabled

    すべてのサーバのサーバタグを有効または無効にします。

    True
    sim.machines.tags.aws.enabledすべてのサーバの AWS タグの収集を有効または無効にします。True
    sim.machines.tags.aws.pollingInterval

    AWS タグのポーリングの間隔(ミリ秒単位)

    21600000
    (6 時間)

    sim.machines.tags.maxPerMachineアカウントごとの一意のタグの最大数。50
    sim.machines.tags.maxPerAccount

    アカウントごとの一意のタグの最大数。

    500

     

    Docker タグの設定オプション

    マシンエージェントは、さまざまなタイプのタグを収集するように設定できます。デフォルトでは、すべてのタグが収集されます。タグの収集をオフにするには、dockerTagsEnabled を「false」に設定します。

    1.  <machine_agent_home>/extensions/DockerMonitoring/DockerMonitoringConfig.yml ファイルを編集します。
    2. containerMonitoringConfig セクションで、dockerTagsEnabled: "false" を設定します。

      Code Block
      # WARNING: Before making any changes to this file read the following section carefully
      # 
      # After editing the file, make sure the file follows the yml syntax. Common issues include
      # - Using tabs instead of spaces
      # - File encoding should be UTF-8
      #
      # The safest way to edit this file is to copy paste the examples provided and make the
      # necessary changes using a plain text editor instead of a WYSIWYG editor.
      #
      
      # samplingInterval indicates how often to gather metric data. Units in milliseconds.
      samplingInterval: 30000
      
      containerMonitoringConfig:
          # containerProcessSelectorRegex defines regular expression to evaluate the processes in
          # each running container to be monitored by the machine agent. The regular expression is
          # compared against each process full command line within running
          # If the pattern matches, then the machine agent start monitoring it.
          containerProcessSelectorRegex: ".*[ ]-Dappdynamics.*"
          dockerTagsEnabled: "false" 

    AWS タグの設定オプション

    マシンエージェントは、さまざまなタイプのタグを収集するように設定できます。デフォルトでは、すべてのタグが収集されます。タグの収集をオフにするには、awsTagsEnabled を「false」に設定します。

    1. <machine_agent_home>/extensions/ServerMonitoring/conf/ServerMonitoring.yml ファイルを編集します。
    2. 次のように設定します。awsTagsEnabled: "false" 

     

    Code Block
    //ServerMonitoring.yml
    # WARNING: Before making any changes to this file read the following section carefully
    # 
    # After editing the file, make sure the file follows the yml syntax. Common issues include
    # - Using tabs instead of spaces
    # - File encoding should be UTF-8
    #
    # The safest way to edit this file is to copy paste the examples provided and make the
    # necessary changes using a plain text editor instead of a WYSIWYG editor.
    #
    awsTagsEnabled: "false"
    # samplingInterval indicates how often to gather metric data. Units in milliseconds.
    samplingInterval: 30000
    ...

     

    Kubernetes および OpenShift タグの設定オプション

    マシンエージェントは、さまざまなタイプのタグを収集するように設定できます。デフォルトでは、すべてのタグが収集されます。タグの収集をオフにするには、k8sTagsEnabled を「false」に設定します。

    1. <machine_agent_home>/extensions/ServerMonitoring/conf/ServerMonitoring.yml  ファイルを編集します。
    2. 次のように設定します。k8sTagsEnabled: "false"
    Code Block
    //ServerMonitoring.yml
    # WARNING: Before making any changes to this file read the following section carefully
    # 
    # After editing the file, make sure the file follows the yml syntax. Common issues include
    # - Using tabs instead of spaces
    # - File encoding should be UTF-8
    #
    # The safest way to edit this file is to copy paste the examples provided and make the
    # necessary changes using a plain text editor instead of a WYSIWYG editor.
    #
    k8sTagsEnabled: "false"
    # samplingInterval indicates how often to gather metric data. Units in milliseconds.
    samplingInterval: 30000
    ...