Previous Topic: Configure Single Logout on SharePoint 2010Next Topic: Use the Session Linker

Agent for SharePoint Guide › Advanced Configuration Options › Monitor Data with CA Introscope

Monitor Data with CA Introscope

CA Introscope® can monitor the following statistics of the server that hosts the CA SiteMinder® Agent for SharePoint:

Follow these steps:

  1. Configure your EPAgent.
  2. Modify the server.conf file.
  3. Open the Administrative UI to change Policy Server objects.
  4. Update your Agent Configuration object (ACO).
  5. Start the EPAgent using the appropriate procedure for your operating environment:
  6. Restart the CA SiteMinder® Agent for SharePoint.

Configure Your EPAgent

You can configure the following items on your EPAgent:

Configure EPAgent Properties

The properties used by the EPAgent are the same as the properties that are used for the Java agent.

Follow these steps:

  1. Configure the EPAgent settings in the IntroscopeEPAgent.properties file. The settings for the EPAgent are the same type as found in the [assign the value for wisc in your book] Agent profile.

    Note: For more information about properties, see the [assign the value for wapm in your book] Java Agent Implementation Guide.

  2. If you change the name or location of the IntroscopeEPAgent.properties file, you can set it with the Java system property:

    -Dcom.wily.introscope.epagent.properties=filename

    Note: This system property should immediately follow "java" in the command line. If it is placed later on the command line—for example, after -jar—it will not work.

Configure EPAgent Logging Options

By default, the EPAgent sends message and error output to the command console. You can configure the EPAgent to send message and error output to a log file also.

Follow these steps:

  1. Open the file <EPAgent_Home>/epagent/IntroscopeEPAgent.properties.
  2. Modify the properties.
Configuring EPAgent Plug-ins

To run EPAgent using the default plug-ins, you simply need to uncomment certain properties in IntroscopeEPAgent.properties file.

However, you may want to remove plug-ins you don’t need from the default plug-ins in the IntroscopeEPAgent.properties file, or add additional plug-ins.

EPAgent plug-ins are separated into two sections in the IntroscopeEPAgent.properties file, stateful and stateless.

Configuring the EPAgent for Network Data Sources

You can configure the EPAgent to accept data from network sources.

Modify the server.conf File

After the Introscope owner configures the EPAgent, the next step is modifying the server.conf file of the server on which the CA SiteMinder® Agent for SharePoint runs.

Follow these steps:

  1. Log in to the server hosting your CA SiteMinder® Agent for SharePoint.
  2. Open the following file with a text editor: 
    Agent-for-SharePoint_Home/proxy-engine/conf/server.conf
    Agent-for-SharePoint_Home

    Indicates the directory where the CA SiteMinder® Agent for SharePoint is installed.

    Default: (Windows) [32-bit] C:\Program Files\CA\Agent-for-SharePoint

    Default: (Windows) [64-bit] C:\CA\Agent-for-SharePoint
    Default: (UNIX/Linux) /opt/CA/Agent-for-SharePoint

  3. Locate the following section: 
    <metric-reporter name="WilyMetricReporter">
  4. Change the value on the enabled line (in the previous section) to "yes", as shown in the following example: 
    enabled="yes"
  5. Save the file and close the text editor.

    The server.conf file is modified. Continue with the next steps of having your policy administrator open the Administrative UI and update your Agent Configuration object (ACO).

Change the Policy Server Objects

Change the objects on your Policy Server by opening the Administrative UI.

Follow these steps:

  1. Open the following URL in a browser. 
    https://host_name:8443/iam/siteminder/adminui
    host_name

    Specifies the fully qualified Administrative UI host system name.

  2. Enter your CA SiteMinder® superuser name in the User Name field.
  3. Enter the CA SiteMinder® superuser account password in the Password field.

    Note: If your superuser account password contains dollar‑sign ($) characters, replace each instance of the dollar-sign character with $DOLLAR$. For example, if the CA SiteMinder® superuser account password is $password, enter $DOLLAR$password in the Password field.

  4. Verify that the proper server name or IP address appears in the Server drop-down list.
  5. Select Log In.

Update Your Agent Configuration Object (ACO)

The next step in monitoring data with CA Introscope® involves updating a configuration parameter in your Agent Configuration Object (ACO).

Follow these steps:

  1. Click Infrastructure, Agent, Agent Configuration Objects.
  2. Click the edit icon in the line Agent Configuration Object you want.
  3. Locate the following parameter:
    EnableIntroscopeApiSupport

    Collects information about the agent and sends it to CA Introscope® using a plug-in. This parameter uses the following settings:

    • When set to yes, the plug-in calls an API to collect the data.
    • When set to no, the plug-in creates an HTTP header with the data.
    • When set to both, the plug-in calls the API to collect the data and creates an HTTP header with the data.
    • When set to none, data not collected.

    Default: No.

    Limits: Yes, Both, No, None.

    Example: (HTTP header) sm-wa-perf-counters = server_name.example.com:6180,86117203,86118343,1,0,0,1,0,0,1,0,0,0,0,0,1,0,0,0,0,0,0,0,1125,0,15,1,1,750,750,

  4. Click the edit icon next to the previous parameter, and then add the settings that you want.
  5. (Optional) To disable automatic monitoring of the agent instance metrics that are configured with the CA SiteMinder® Agent for SharePoint, change the value of the following parameter to no:
    EnableMonitoring

    Specifies whether the agent sends monitoring information to the Policy Server.

    Default: Yes.

  6. Click OK.
  7. Click Submit.

    Your Agent Configuration object is updated. Continue with the next step of having your Introscope administrator start the EPAgent.

Start Your EPAgent on Windows Operating Environments

You can run the EPAgent as either a standalone .jar file, or a Java application.

To run the EPAgent as a standalone .jar file

To run the EPAgent as a Java application

Start Your EPAgent on UNIX Operating Environments

You can use a control script (shell script) to run the Introscope EPAgent on a UNIX operating system.

Follow these steps:

  1. Open a command prompt.
  2. Navigate to the directory that has the control script. For example: 
    cd Introscope<version_number>/bin
  3. Run the command that corresponds to the action you want:
    EPACtrl.sh start

    Starts the EPAgent.

    EPACtrl.sh status

    Shows the status of EPAgent process whether it is running or stopped.

    EPACtrl.sh stop

    Stops the EPAgent process

    EPACtrl.sh help

    Displays the help menu.

Restart the CA SiteMinder® Agent for SharePoint

Starting or stopping the CA SiteMinder® Agent for SharePoint involves the following separate procedures:

  1. Changing the value of EnableWebAgent in the WebAgent.conf file.
  2. Changing the state of the related services on the computer running the CA SiteMinder® Agent for SharePoint.
Change the Value of the EnableWebAgent Parameter

Change the value of the EnableWebAgent parameter to accomplish either of the following tasks:

Follow these steps:

  1. Open the following file with a text editor: 
    Agent-for-SharePoint_home\proxy-engine\conf\defaultagent\WebAgent.conf
  2. Locate the following line: 
    EnableWebAgent="NO"
  3. Change the value inside the quotation marks to one of the following values:
  4. Change the state of the related services on your CA SiteMinder® Agent for SharePoint.
Change the States of the Services

You can change the states of the related services on your CA SiteMinder® Agent for SharePoint.

Note: To start or stop your CA SiteMinder® Agent for SharePoint, change the value of the EnableWebAgent parameter first.

Follow these steps:

  1. To change the states of the related services, select one of the following procedures:
  2. For Windows operating environments, do the following steps:
    1. From the Windows Start menu navigate to Administrative Tools, Services.

      The Services dialog appears.

    2. Scroll down the list of services and select SiteMinder CA SiteMinder® Agent for SharePoint.
    3. From the Action menu, select All Tasks and select the command that you want.
    4. Repeat Step b for SiteMinder Agent for SharePoint Proxy Engine.

      The states of the services and CA SiteMinder® Agent for SharePoint are changed.

  3. To start the CA SiteMinder® Agent for SharePoint on UNIX operating environments, do the following steps.
    1. Log in as a root user.
    2. Navigate to the following directory: 
      Agent-for-SharePoint_home/proxy-engine
    3. Run the following command: 
      ./sps-ctl start

      The service and the CA SiteMinder® Agent for SharePoint start. The CA SiteMinder® Agent for SharePoint stops or starts according to the value you set in the EnableWebAgent parameter.

  4. To stop the CA SiteMinder® Agent for SharePoint on a system running UNIX, do the following steps:
    1. Navigate to the following directory: 
      Agent-for-SharePoint_home/proxy-engine
    2. Run the following command: 
      ./sps-ctl stop

      The service and the CA SiteMinder® Agent for SharePoint stop.