Adding environment variables

You must configure the environment variables that are used by the agents that are installed on each cluster node.

About this task

You must specify values for the following environment variables:
  • CTIRA_HOSTNAME: This variable is used to configure each instance of the Microsoft SQL Server agent. The value of this variable is limited to 31 characters and is common for all monitoring agents. Set the value of this variable to the cluster name to navigate to all the monitoring agents for that cluster in the Application Performance Dashboard.
  • CTIRA_NODETYPE: This variable is used to identify the agent. By default, the value of this variable is set to MSS for the Microsoft SQL Server agent.
  • CTIRA_SUBSYSTEMID: This variable is used to distinguish the multiple instances of the Microsoft SQL Server agent. By default, the value of this variable is set to Microsoft SQL Virtual Server for the Microsoft SQL Server agent.
  • COLL_HOME: This variable is used to collect data and store log files for attribute groups that use configuration files at a shared location. Set the value of the variable to X:\shared-location, where X is a shared drive that is accessible to the cluster nodes. For example, set the value for the COLL_HOME variable when you define the configuration settings for the MS SQL Table Detail attribute group or MS SQL Error Event Details attribute group.
  • CTIRA_HIST_DIR: This variable is used to specify the path to the shared disk directory. If history for the Microsoft SQL Server agent is configured to be stored at the monitoring agent, each instance of the agent must be configured with a common CTIRA_HIST_DIR variable that refers to the shared disk directory.
    Remember: If history is stored at the Cloud APM server, you need not specify a value for the CTIRA_HIST_DIR variable. Storing history at the Cloud APM server increases the load on that server.

To add these variables, see the steps that are described in Configuring local environment variables on Windows systems.

What to do next

Change the startup type of the agent service and the collector service to Manual by completing the steps that are described in Changing the startup type of the agent service and the collector service.