IBM Performance Management

Socket configuration

After you add a socket data source to your agent, you can configure the agent to accept data from a specified socket port.

About this task

After you add a Socket data source, the configuration is displayed on the Runtime Configuration page of the Agent Editor. The Socket configuration section contains the following property:
Table 1. Socket configuration property
Name Valid values Required Description
Port number 0 or any positive integer

The default value is 0

 Yes The port that the agent uses to listen on for data from socket clients. A value of 0 indicates that an ephemeral port is to be used.

The agent writes the value of the port that is being used to a file. Socket clients that run on the agent computer can later read this file to determine which port to connect to. The file that the port is written to is named kxx_instanceName_cps.properties, where: kxx is the three character product code of the agent and instanceName is the agent instance name for a multiple instance agent. If the agent is not a multiple instance agent, this part of the name is not included so the file name is kxx_cp.properties.

In Windows, the file is written to the %CANDLE_HOME%\TMAITM6 directory for 32-bit installations or %CANDLE_HOME%\TMAITM6_x64 for 64-bit installations. In UNIX, the file is written to /tmp.

Procedure

  1. Optional: Set the environment variable CDP_DP_HOSTNAME to the host name or IP address of your network interface, if your system has multiple interfaces:
    1. Go to the Agent Editor Agent Information view and select Environment Variables.
    2. Click Add and select CDP_DP_HOSTNAME from the list of environment variables by using the Name field.
    3. Set the host name or IP address in the Value field.
  2. Start your agent.

    When the agent is started, it binds to the interface that is defined by the CDP_DP_HOSTNAME environment variable. If CDP_DP_HOSTNAME is not set, the agent binds to the default host name.

    If you want the agent to bind to a defined port instead of an ephemeral port, you can set the configuration property Port Number (CP_PORT).

    To set the port number configuration property, use the following steps:

    1. Go to the Agent Editor Runtime Configuration view.
    2. In the Runtime Configuration Information pane select Configuration for Socket > Socket > Port Number
    3. Enter a port number value in Default value. If you do not enter a value, a value of 0 is used. A value of 0 indicates that an ephemeral port is used.