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

    This page describes the settings that are available for configuring the Node.js Agent. To apply the settings, add them to the require statement for the Node.js Agent in the monitored application.

    You can use environment variables for some of the settings below. See Install the Node.js Agent.  

    General Settings

    This is the complete list of settings in the require statement that you insert into your application code. Not all of these settings are required.

    Div
    stylewidth: 800px; padding-top: 20px;
    Property NameDescription
    controllerHostNameThe IP address or hostname of your Controller. SaaS customers receive this URL in their welcome email from AppDynamics. On-premises customers set them when they install the Controller.
    controllerPort

    The port to which the agent connects to the Controller. It is 8090 for an on-premises Controller, and 443 for a SaaS Controller. 

    controllerSslEnabledSet this property to true if connecting to the Controller via SSL.
    accountNameThe account name on the Controller to which this agent will report. See Account Name and Access Key Requirements for details.
    accountAccessKeyAccount access key on the Controller.
    applicationNameName that represents the entire application in the AppDynamics console.
    tierNameName that represents your Node.js app or service in the flow maps.
    nodeNameName of the Node.js process to be monitored by this agent. See Node Names.
    noNodeNameSuffixOptional, set to true if you do not want the agent to add a suffix, such as -0, -1, -2, and so on, to the node name. See Node Names.
    proxyHost, proxyPortSet these options to route data to the Controller through a proxy server. The proxyHost is the hostname or IP address of the proxy server. The proxyPort is the proxy server's HTTP or HTTPS port, whichever you are using. If you set the host, you must set the port as well.
    proxyUser, proxyPasswordFileConfigure the proxy username and password file if the proxy server requires credentials.
    proxySet this property to true if you want to use the Java proxy version of the Node.js agent.
    alwaysAddEumMetadataInHttpHeadersSet this property to true to have the Node.js Agent write business transaction metadata to the XHR header and in a cookie even if the request is considered cross-origin. See the description for the equivalent setting always-add-eum-metadata-in-http-headers in App Agent Node Properties Reference for more information. 
    btEntryPointDelayDisabledtrue|false - Optional, defaults to false. Setting this property to true can accelerate the startup of business transactions, but it can adversely affect the drill-down in distributed transactions.
    debugSet this property to true to enable debug level logging for the agent. The default is false.
    loggingThe location, level, and other settings related to agent logging. See Node.js Agent Logging.
    maxProcessSnapshotsPerPeriodOptional. The default is 2. The number of automatic process snapshots allowed in processSnapshotCountResetPeriodSeconds seconds. 
    processSnapshotCountResetPeriodSecondsOptional, defaults to 60. Frequency, in seconds, at which the automatic process snapshot count is reset to 0.
    autoSnapshotDurationSeconds

    Optional, defaults to 10. Length, in seconds, of automatically-triggered process snapshots.

    proxyAutolaunchDisabled

    true|false - Optional, defaults to false. Set this property to true if you need to manually launch the proxy for this agent. See Manually Starting the Java Proxy for Node.js Agents. 

    proxyCtrlDirDirectory path for the directory containing the domain control socket, which the agent uses to start an AppDynamics node. Optional, set by the agent. Set manually if you are setting up a multi-tenant proxy. See Sharing a Proxy Among Node.js Agents.
    rootTmpDir

    Directory path for the root of the directory that stores the agent files. Optional, defaults to /tmp/appds.

    tmpDirDirectory path for the subdirectory of the root directory for the monitored node. Optional, defaults to a hash of the Controller info for the instrumented node.
    reuseNodeSet this property to true to enable reusing node names. This property is useful for monitoring environments where there are many nodes with short life spans. The default is false.
    reuseNodePrefixSet this property to the string that prefixes the node name when reuseNode is set to true. The Controller uses this prefix to generate node names dynamically.
    certificateFileDirectory path for the directory containing the SSL certificate.
    uniqueHostIdThe unique host ID can be set to any value that will identify the host. If a value is not specified, the agent will generate the host ID. This setting is only available for the proxyless version of the Node.js Agent.

    Analytics Settings

    If you are configuring the Node.js Agent to send the default transaction data to the Analytics Agent, add a setting for the analytics host and port using the following format:

    Code Block
    analytics: {
        host: <analyticsHostName>,
        port: <analyticsPort>,
        ssl: <true || false>  
    }


    The Analytics Agent may report on the same or different host and port numbers from the Node.js Agent. In either case, you need to specify it here.

    For more information, see Collect Transaction Analytics Data.

    Windows Settings

    On Windows, the Node.js Agent requires three additional ports. See Install the Node.js Agent on Windows for more information.

    • proxyCommPort: default is 10101
    • proxyRequestPort: default is 10102
    • proxyReportingPort: default is 10103

    Filter Sensitive Data

    If your application contains sensitive data that should not be displayed in the Controller, you can apply the following data filters to the require statement for the Node.js Agent:

    Code Block
    // Add a sensitive data filter 
    dataFilters: [{
       "appliesTo": "http-headers",
       "matchPattern": "host"
    }],
     
    // Add an environment variable filter 
    dataFilters: [{
       "appliesTo": "env-vars",
       "matchPattern": "password|key"
    }],
    
    // Add a sensitive URL filter 
    urlFilters: [{
       "delimiter": "/",
       "segment": "1",
       "matchPattern": "a",
       "paramPattern": "bar"
    }],
    
    // Add a sensitive message filter 
    messageFilters: [{
       "messageType": "throwable",
       "matchPattern": "Error.*proxy.",
       "redactionRegex": "proxy"
    }]
    Info

    The matchpattern/parampattern is a standard regex.

    Environment Variables

    If you have not provided the required settings in the require statement, the agent uses the values of the following environment variables if those variables are set. If both are set, the require statement value takes precedence over the environment variable.

    Environment VariableMaps To
    APPDYNAMICS_CONTROLLER_HOST_NAME controllerHostName
    APPDYNAMICS_CONTROLLER_PORTcontrollerPort
    APPDYNAMICS_CONTROLLER_SSL_ENABLEDcontrollerSslEnabled
    APPDYNAMICS_AGENT_ACCOUNT_NAMEaccountName
    APPDYNAMICS_LOGGER_OUTPUT_TYPEUser can stream logs to stdout by setting its value to "console".

    APPDYNAMICS_LOGGER_LEVEL

    User can set the logging level of the agent.

    Possible values are FATAL, ERROR, WARN, INFO, DEBUG, and TRACE.

    APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEYaccountAccessKey
    APPDYNAMICS_AGENT_APPLICATION_NAMEapplicationName
    APPDYNAMICS_AGENT_TIER_NAMEtierName
    APPDYNAMICS_AGENT_NODE_NAMEnodeName
    APPDYNAMICS_AGENT_UNIQUE_HOST_ID
    APPDYNAMICS_ANALYTICS_HOST_NAMEhost—in Analytics settings
    APPDYNAMICS_ANALYTICS_PORTport—in Analytics settings
    APPDYNAMICS_ANALYTICS_SSL_ENABLEDsslin Analytics settings
    UNIQUE_HOST_ID

    uniqueHostId

    Info

    This environment variable is only supported in the proxyless version of the Node.js Agent.

    Sv translation
    languageja

    Appd tocbox
    Width350px

    On this page:

    Table of Contents
    maxLevel2
    minLevel2

    このトピックでは、Node.jsエージェントの構成に使用できる設定について説明します。設定を適用するには、モニタリング対象アプリケーションのNode.jsエージェントのrequireステートメントにそれらを追加します。

    以下で説明するように、いくつかの設定に環境変数を使用することもできます。詳細については、「Install the Node.js Agent」を参照してください。  

    一般設定

    以下はアプリケーションコードに挿入するrequireステートメントにある設定の完全なリストです。すべての設定が必要というわけではありません。

    Div
    stylewidth: 900px; padding-top: 20px;
    プロパティ名説明
    controllerHostNameコントローラの IP アドレスまたはホスト名。SaaS使用の場合は、AppDynamicsからのWelcomeメールにこのurlが記載。オンプレミスの場合はコントローラをインストールする際にこの設定を実行。
    controllerPort

    エージェントがコントローラに接続するポート。オンプレミスコントローラの場合は 8090、SaaS コントローラの場合は 443。 

    controllerSslEnabledSSL 経由でコントローラに接続する場合はこのプロパティを true に設定。
    accountNameこのエージェントがレポートするコントローラのアカウント名。詳細については、「アカウント名およびアクセスキーの要件」を参照。
    accountAccessKeyコントローラのアカウントアクセスキー。
    applicationNameAppDynamicsコンソールの中のアプリケーション全体を示す名前。
    tierNameフローマップでNode.js アプリケーションまたはサービスを示す名前
    nodeNameこのエージェントにより監視されるNode.jsプロセスを示す名前。次を参照してください。Node Names
    noNodeNameSuffixオプション。エージェントが -0、-1、-2 などのサフィックスをノード名に追加しないようにする場合は、true に設定。次を参照してください。Node Names
    proxyHost、proxyPortプロキシサーバ経由でコントローラにデータをルーティングする場合は、これらのオプションを設定。proxyHostは、プロキシサーバーのホスト名またはIPアドレスです。proxyPortはご使用のプロキシサーバーのHTTPまたはHTTPSポートです。ホストを設定した場合、ポートも設定する必要があります。
    proxyUser、proxyPasswordFileプロキシサーバにログイン情報が必要な場合は、プロキシのユーザ名とパスワードファイルを構成。
    プロキシ(proxy)Java プロキシバージョンの Node.js エージェントを使用する場合は、このプロパティを true に設定。
    alwaysAddEumMetadataInHttpHeadersリクエストがクロスオリジンであってもビジネストランザクションのメタデータを XHR ヘッダーと cookie に書き込むように Node.js エージェントを構成する場合は、このプロパティを true に設定します。詳細については、「App Agent Node Properties Reference」の同等の設定 always-add-eum-metadata-in-http-headers に関する説明を参照してください。 
    btEntryPointDelayDisabledtrue|false:オプション。デフォルトは false。このプロパティを true に設定すると、ビジネストランザクションの起動を高速化できますが、分散トランザクションでのドリルダウンに悪影響を与える可能性があります。
    debugエージェントのデバッグレベルのログを有効にするには、このプロパティを true に設定。デフォルトは false。
    loggingエージェントのログ記録に関連する場所、レベル、およびその他の設定。次を参照してください。Node.js Agent Logging
    maxProcessSnapshotsPerPeriodオンプレミスの場合、HTTPのデフォルトは8090、HTTPSのデフォルトは8181です。デフォルトは 2。processSnapshotCountResetPeriodSeconds の時間(秒)内に生成される自動プロセススナップショットの数。 
    processSnapshotCountResetPeriodSecondsオプション。デフォルトは 60。自動プロセス スナップショット カウントが 0 にリセットされる頻度(秒単位)。
    autoSnapshotDurationSeconds

    オプション。デフォルトは 10。自動トリガーされるプロセススナップショットの長さ(秒単位)。

    proxyAutolaunchDisabled

    true|false:オプション。デフォルトは false。このエージェントのプロキシを手動で起動する必要がある場合は、このプロパティを true に設定。「Node.js エージェント用の Java プロキシを手動で起動する」を参照してください。 

    proxyCtrlDirエージェントがAppDynamicsノードを起動するために使用するドメイン制御ソケットを含むディレクトリ用のディレクトリパス。オプション。エージェントが設定。マルチテナントプロキシを設定する場合に、手動で設定する。次を参照してください。Sharing a Proxy Among Node.js Agents
    rootTmpDir

    エージェントのファイルを保存するディレクトリのルート用ディレクトリパス。オプション。デフォルトは /tmp/appds

    tmpDir監視対象ノード用ルートディレクトリのサブディレクトリのディレクトリパス。オプション。デフォルトは、インストゥルメント化されたノードのコントローラ情報のハッシュ。
    reuseNodeノード名を再利用できるようにするには、このプロパティを true に設定します。このプロパティは、寿命が短いノードが多数ある環境のモニタリングに役立ちます。デフォルトは false。
    reuseNodePrefixこのプロパティを、reuseNode が true に設定されているときにノード名のプレフィックスとなる文字列に設定。コントローラはこのプレフィックスを使用して、ノード名を動的に生成します。
    certificateFileSSL証明書を含むディレクトリのディレクトリパス。
    uniqueHostId固有のホストIDの値。この設定は、プロキシなしバージョンのNode.jsエージェントにのみ使用可能です。

    分析の設定

    Analyticsエージェントにデフォルトのトランザクションデータを送信するようNode.jsエージェントを構成するには、以下の形式で分析ホスト及びポート用の設定を追加します。

    No Format
    analytics: {
        host: <analyticsHostName>,
        port: <analyticsPort>,
        SSL: <true || false>  }

    分析エージェントは、Node.jsエージェントと同じホストまたは異なるホストおよびポート番号についてレポートすることがあります。どちらの場合でも、ここでそれを指定する必要があります。

    詳細については、「Collect Transaction Analytics Data」を参照してください。

    Windows 設定

    Windowsで、Node.jsエージェントは追加のポートを3つ要求します。詳細については、「Install the Node.js Agent on Windows」を参照してください。

    • proxyCommPort:デフォルトは 10101
    • proxyRequestPort:デフォルトは 10102
    • proxyReportingPort:デフォルトは 10103

    機密データのフィルタ

    アプリケーションにコントローラに表示すべきではない機密データが含まれている場合は、Node.jsエージェントのrequireステートメントに次のデータフィルタを適用できます。

    No Format
    // Add a sensitive data filter 
    dataFilters: [{
       "appliesTo": "http-headers",
       "matchPattern": "host"
    }],
     
    // Add an environment variable filter 
    dataFilters: [{
       "appliesTo": "env-vars",
       "matchPattern": "password|key"
    }],
    
    // Add a sensitive URL filter 
    urlFilters: [{
       "delimiter": "/",
       "segment": "1",
       "matchPattern": "a",
       "paramPattern": "bar"
    }],
    
    // Add a sensitive message filter 
    messageFilters: [{
       "messageType": "throwable",
       "matchPattern": "Error.*proxy.",
       "redactionRegex": "proxy"
    }]
    Info
    iconfalse

    matchpattern/parampattern は標準の正規表現です。


    環境変数

    requireステートメントで必要な設定を指定していない場合、エージェントは以下の環境設定の値を使用します(すでにその変数が設定済みの場合)。両方が設定されている場合、requireステートメントの値が環境変数より優先されます。

    環境変数へのマップ
    APPDYNAMICS_CONTROLLER_HOST_NAME controllerHostName
    APPDYNAMICS_CONTROLLER_PORTcontrollerPort
    APPDYNAMICS_CONTROLLER_SSL_ENABLEDcontrollerSslEnabled
    APPDYNAMICS_AGENT_ACCOUNT_NAMEaccountName
    APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEYaccountAccessKey
    APPDYNAMICS_AGENT_APPLICATION_NAMEapplicationName
    APPDYNAMICS_AGENT_TIER_NAMEtierName
    APPDYNAMICS_AGENT_NODE_NAMEnodeName
    APPDYNAMICS_AGENT_UNIQUE_HOST_ID 
    APPDYNAMICS_ANALYTICS_HOST_NAMEhost(Analytics 設定内)
    APPDYNAMICS_ANALYTICS_PORTport(Analytics 設定内)
    APPDYNAMICS_ANALYTICS_SSL_ENABLEDssl(Analytics 設定内)
    UNIQUE_HOST_ID

    uniqueHostId

    ホストを識別するために使用する任意の値に対し、一意のホストIDを設定できます。値を指定しない場合、エージェントによってホストIDが生成されます。

    Info

    この環境変数は、プロキシなしバージョンのNode.jsエージェントでのみサポートされています。