+ All Categories
Home > Documents > APM_9.5--APM for SiteMinder SNMP Collector Guide

APM_9.5--APM for SiteMinder SNMP Collector Guide

Date post: 11-Oct-2015
Category:
Upload: ggenmailru
View: 31 times
Download: 0 times
Share this document with a friend
Popular Tags:

of 37

Transcript
  • for CA SiteMinder SNMP Collector Guide Release 9.5

    CA Application Performance Management

  • This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation) is for your informational purposes only and is subject to change or withdrawal by CA at any time.

    This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA.

    Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.

    The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.

    TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

    The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice.

    The manufacturer of this Documentation is CA.

    Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors.

    Copyright 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

  • CA Technologies Product References

    This document references the following CA Technologies products and features:

    CA Application Performance Management (CA APM)

    CA Application Performance Management ChangeDetector (CA APM ChangeDetector)

    CA Application Performance Management ErrorDetector (CA APM ErrorDetector)

    CA Application Performance Management for CA Database Performance (CA APM for CA Database Performance)

    CA Application Performance Management for CA SiteMinder (CA APM for CA SiteMinder)

    CA Application Performance Management for CA SiteMinder Application Server Agents (CA APM for CA SiteMinder ASA)

    CA Application Performance Management for IBM CICS Transaction Gateway (CA APM for IBM CICS Transaction Gateway)

    CA Application Performance Management for IBM WebSphere Application Server (CA APM for IBM WebSphere Application Server)

    CA Application Performance Management for IBM WebSphere Distributed Environments (CA APM for IBM WebSphere Distributed Environments)

    CA Application Performance Management for IBM WebSphere MQ (CA APM for IBM WebSphere MQ)

    CA Application Performance Management for IBM WebSphere Portal (CA APM for IBM WebSphere Portal)

    CA Application Performance Management for IBM WebSphere Process Server (CA APM for IBM WebSphere Process Server)

    CA Application Performance Management for IBM z/OS (CA APM for IBM z/OS)

    CA Application Performance Management for Microsoft SharePoint (CA APM for Microsoft SharePoint)

    CA Application Performance Management for Oracle Databases (CA APM for Oracle Databases)

    CA Application Performance Management for Oracle Service Bus (CA APM for Oracle Service Bus)

    CA Application Performance Management for Oracle WebLogic Portal (CA APM for Oracle WebLogic Portal)

    CA Application Performance Management for Oracle WebLogic Server (CA APM for Oracle WebLogic Server)

    CA Application Performance Management for SOA (CA APM for SOA)

  • CA Application Performance Management for TIBCO BusinessWorks (CA APM for TIBCO BusinessWorks)

    CA Application Performance Management for TIBCO Enterprise Message Service (CA APM for TIBCO Enterprise Message Service)

    CA Application Performance Management for Web Servers (CA APM for Web Servers)

    CA Application Performance Management for webMethods Broker (CA APM for webMethods Broker)

    CA Application Performance Management for webMethods Integration Server (CA APM for webMethods Integration Server)

    CA Application Performance Management Integration for CA CMDB (CA APM Integration for CA CMDB)

    CA Application Performance Management Integration for CA NSM (CA APM Integration for CA NSM)

    CA Application Performance Management LeakHunter (CA APM LeakHunter)

    CA Application Performance Management Transaction Generator (CA APM TG)

    CA Cross-Enterprise Application Performance Management

    CA Customer Experience Manager (CA CEM)

    CA Embedded Entitlements Manager (CA EEM)

    CA eHealth Performance Manager (CA eHealth)

    CA Insight Database Performance Monitor for DB2 for z/OS

    CA Introscope

    CA SiteMinder

    CA Spectrum Infrastructure Manager (CA Spectrum)

    CA SYSVIEW Performance Management (CA SYSVIEW)

  • Contact CA Technologies

    Contact CA Support

    For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At http://ca.com/support, you can access the following resources:

    Online and telephone contact information for technical assistance and customer services

    Information about user communities and forums

    Product and documentation downloads

    CA Support policies and guidelines

    Other helpful resources appropriate for your product

    Providing Feedback About Product Documentation

    If you have comments or questions about CA Technologies product documentation, you can send a message to [email protected].

    To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at http://ca.com/docs.

  • Contents 7

    Contents

    Chapter 1: Installation Instructions and Metrics 9

    Before You Begin .......................................................................................................................................................... 9

    How to Install and Configure the Extension ................................................................................................................. 9

    Step 1: Running the Enterprise Manager Installer .............................................................................................. 10

    Step 2: Installing Agent Components on Windows/UNIX ................................................................................... 10

    Step 3: Configuring the Agent Profile .................................................................................................................. 13

    Step 4: Configuring the SNMP Collector ............................................................................................................. 14

    Step 5: Enabling the Management Module and Dashboards ............................................................................. 14

    Step 6: Run the SNMP Collector .......................................................................................................................... 15

    Chapter 2: Metrics for SNMP Collector 17

    Installation and Configuration Information Metrics .................................................................................................. 18

    Performance ............................................................................................................................................................... 20

    Connected Web Agents .............................................................................................................................................. 20

    Installation and Configuration Information Metrics ........................................................................................... 21

    Performance Metrics .......................................................................................................................................... 22

    Caching ....................................................................................................................................................................... 23

    Cookies ....................................................................................................................................................................... 24

    URLs ............................................................................................................................................................................ 25

    Key Operations ........................................................................................................................................................... 25

    Authorize ............................................................................................................................................................. 25

    IsProtected .......................................................................................................................................................... 26

    Login .................................................................................................................................................................... 27

    Validation ............................................................................................................................................................ 28

    Chapter 3: Aggregated Metrics for SNMP Collector 29

    Performance ............................................................................................................................................................... 30

    Caching ....................................................................................................................................................................... 31

    Key Operations ........................................................................................................................................................... 31

    Authorize ............................................................................................................................................................. 32

    IsProtected ................................................................................................................................................................. 33

    Login ........................................................................................................................................................................... 34

    Validation ................................................................................................................................................................... 35

  • 8 for CA SiteMinder SNMP Collector Guide

    Index 37

  • Chapter 1: Installation Instructions and Metrics 9

    Chapter 1: Installation Instructions and Metrics

    The Simple Network Management Protocol (SNMP) Collector helps you collect metrics for the SiteMinder web agents even if you do not have access to the web server or the application server. The SNMP Collector component can be installed on any machine. The component must be installed on a remote computer rather than on the Policy Server to avoid potential problems due to Policy Server computer load.

    An SNMP Collector can obtain metrics for multiple policy servers that provide both, Policy Server data and connected web agent data.

    This section contains the following topics:

    Before You Begin (see page 9) How to Install and Configure the Extension (see page 9)

    Before You Begin

    Before you install the extension, familiarize yourself with the following locations in your CA Introscope environment:

    The CA Introscope directorythe installation directory for CA Introscope on your Enterprise Manager, henceforth referred to as .

    The extension server home directorythe home directory of your application server, henceforth referred to as .

    The application server home directorythe home directory of your application server, henceforth referred to as .

    How to Install and Configure the Extension

    Installing and configuring the extension involves the following steps:

    Step 1: Running the Enterprise Manager installer (see page 10)

    Step 2: Installing extension agent components on a Windows/UNIX operating system (see page 10)

    Step 3: Configuring the Agent Profile (see page 13)

    Step 4: Configuring the SNMP Collector (see page 14)

    Step 5: Enabling the Management Module and dashboards (see page 14)

    Step 6: Running the SNMP Collector (see page 15)

  • How to Install and Configure the Extension

    10 for CA SiteMinder SNMP Collector Guide

    Step 1: Running the Enterprise Manager Installer

    Run the Enterprise Manager installer to install the Enterprise Manager components of the extension on the Enterprise Manager.

    Note: When an Enterprise Manager is in use by a different agent, the Enterprise Manager components of all the extensions are already installed in the /examples directory. You do not have to continue with this step; you can continue with configuring the Enterprise Manager.

    The installer places the files in the \examples\SNMPCollectorForSiteMinder directory. You later move the files to the correct location, which is based on how they are organized in the \examples directory.

    Note: For details about the Enterprise Manager installer and where to find the installer executable, see the CA APM Installation and Upgrade Guide.

    The Enterprise Manager installer places the following files onto the Enterprise Manager:

    \examples\SNMPCollectorForSiteMinder\config\modules\SiteMinderSNMP_Manag

    ementModule.jar

    This file is the extension Management Module, which contains preconfigured dashboards.

    These files are extracted to the following locations:

    File Description Location

    typeviewers.xml This file deploys the extension tabs.

    \examples\SNMPCollectorForSiteMinder\ext\ddtv\SiteMInder-SNMP

    SNMPEmExt.jar This jar file contains the extension.

    \examples\SNMPCollectorForSiteMinder\ext

    Step 2: Installing Agent Components on Windows/UNIX

    You can install the extension agent components on a Windows or UNIX operating system.

    Run the Standalone agent installer to install and configure the extension agent information.

  • How to Install and Configure the Extension

    Chapter 1: Installation Instructions and Metrics 11

    The Standalone agent installer configures the IntroscopeEPAgent.properties file with the following properties, which are based on your entries in the installer:

    Metric:

    introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT

    Definition: The property to the Enterprise Manager host name.

    Metric:

    introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT

    Definition: The property to the port number that the Enterprise Manager uses.

    Although the extension does not install an agent, it uses the CA Introscope agent to report the data back to the Enterprise Manager.

    For further customization, you can configure these additional SNMP configuration files listed in the following table. Each WebAgent collects the number of metrics of these files that are provided during the installation and can be manually edited to control.

    Metric:

    SiteMinder-SNMP.xml

    Definition: Provides most of the WebAgent and Policy Server data available to the SNMP subagent. Use this file when you want to monitor SiteMinder 6.x and 12.x.

    Metric:

    SiteMinder-SNMP-NoWebAgentData.xml

    Definition: When this configuration file is used, no WebAgent data is collected.

    Metric:

    SiteMinder-SNMP-WebAgentsMinimalData.xml

    Definition: This file collects critical WebAgent data.

    Metric:

    SiteMinder55-SNMP.xml

    Definition: Provides most of the WebAgent and Policy Server data available to the SNMP subagent. Use the metric when you want to monitor SiteMinder 5.x.

    You can also define the properties that control the way agent connects to the Enterprise Manager, agent side metric aging, and metric clamping in the SiteMinder_SNMP.profile file.

    Note: For more information about agent installation, see the CA APM Java Agent Implementation Guide, CA APM .NET Agent Implementation Guide, and the CA APM Installation and Upgrade Guide.

  • How to Install and Configure the Extension

    12 for CA SiteMinder SNMP Collector Guide

    In addition to these configuration files, you can also set a filter to define which WebAgents to monitor. To set the WebAgents being monitored, edit the Row-filter attribute of the SiteMinder-SNMP.xml file using regular expressions. For example:

    Row-filter=".*"

    Indicates that all data is collected from all WebAgents.

    Row-filter="Group*"

    Indicates that all data is collected from all WebAgents that start with the name Group.

    By controlling WebAgent metrics and filtering the WebAgents you do not need to monitor, you can collect only the critical metrics. This method reduces the amount of data that the Enterprise Manager must manage.

    The Extension Agent Files

    The Enterprise Manager installer places the following files on the agent in the directory:

    Metric:

    \SiteMinder_SNMP\StartAgent.bat

    Definition: File for the Windows platform

    Metric:

    \SiteMinder_SNMP/StartAgent.sh

    Definition: Shell script for the UNIX/Linux platform

    Metric:

    \SiteMinder_SNMP\config\IntroscopeEPAgent.properties

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\config\SiteMinder-SNMP.xml

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\config\SiteMinder55-SNMP.xml

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\config\SiteMinder-SNMP-NoWebAgentData.xml

    Definition: File for all platforms

  • How to Install and Configure the Extension

    Chapter 1: Installation Instructions and Metrics 13

    Metric:

    \SiteMinder_SNMP\config\SiteMinder-SNMP-WebAgentsMinimalData.xml

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\config\SNMPCollectorConfig.xml

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\lib\castor-1.0.4.jar

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\lib\commons-logging-1.1.jar

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\lib\EPAgent.jar

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\lib\SNMP4J.jar

    Definition: File for all platforms

    Metric:

    \SiteMinder_SNMP\lib\SNMPCollector.jar

    Definition: File for all platforms

    Metric:

    APM_Release_Notes_EN.pdf

    Definition: Release Notes information

    Step 3: Configuring the Agent Profile

    Configure the agent profile to integrate the SNMP Collector with ChangeDetector.

    Follow these steps:

    1. Edit the IntroscopeEPAgent.properties file by adding the introscope.agent.extensions.directory property.

    2. Set the value of this property to the full path to your \SiteMinder_SNMP\ext\ directory.

    For example:

    introscope.agent.extensions.directory=//SiteMinder_SNMP//ext

    The agent profile has been configured.

  • How to Install and Configure the Extension

    14 for CA SiteMinder SNMP Collector Guide

    Step 4: Configuring the SNMP Collector

    Configure the SNMP Collector to identify the SiteMinder Policy Server hosts you want to monitor.

    To configure the SNMP Collector, edit the SNMPCollectorConfig.xml file to define the SiteMinder Policy Server hosts, and as appropriate, the frequency, port, and community-string attributes.

    For example, enter the following lines for each SiteMinder Policy Server you monitor:

    Step 5: Enabling the Management Module and Dashboards

    The Management Module contains preconfigured dashboards for each web server type. The installer places the files in the \examples directory. To enable the dashboards, move the Management Module file to the directory where the Enterprise Manager recognizes it.

    Follow these steps:

    1. Copy SiteMinderSNMP_ManagementModule.jar, located in \examples\SNMPCollectorForSiteMinder\config\modules\ to the \config\modules directory in the Enterprise Manager installation directory.

    2. Copy SiteMinder-SNMP.typeviewers.xml, located in \examples\SNMPCollectorForSiteMinder\ext\ddtv\ to the \ext\ddtv\ directory in the Enterprise Manager installation directory.

    3. Copy SNMPEmExt.jar, located in \examples\SNMPCollectorForSiteMinder\ext\ to the \ext\ directory in the Enterprise Manager installation directory.

    4. Restart the Enterprise Manager.

    The new Management Module appears.

  • How to Install and Configure the Extension

    Chapter 1: Installation Instructions and Metrics 15

    Step 6: Run the SNMP Collector

    Follow these steps:

    1. Open a command prompt or shell.

    2. Navigate to the directory.

    3. Run the script to start the SNMP Collector.

    For Windows: Type StartAgent.bat and press the Enter key.

    For UNIX/Linux: Set the execution permission to StartAgent.sh, type ./StartAgent.sh, and press the Enter key.

    You have run the SNMP Collector.

  • Chapter 2: Metrics for SNMP Collector 17

    Chapter 2: Metrics for SNMP Collector

    Metrics for SiteMinder OneView Monitor appear in the Investigator under the node:

    SiteMinder-Monitor|SiteMinder-Monitor(*SuperDomain*) |SiteMinder Policy Servers

    node.

    Metrics for SiteMinder Policy Servers appear in the Investigator under the node:

    SiteMinder Policy Servers||Policy Server Data|

    ||

    The following list contains SNMP Collector metrics definitions:

    Metric:

    SiteMinder Policy Servers||Policy Server Data:Host

    Definition: IP address of the computer where the authentication server is installed.

    Metric:

    SiteMinder Policy Servers||Policy Server Data:Last

    Activity

    Definition: Date and time of the last interaction of the Policy Server with the Monitor.

    Metric:

    SiteMinder Policy Servers||Policy Server Data:Start Time

    Definition: The startup time of the Policy Server.

    Metric:

    SiteMinder Policy Servers||Policy Server Data:Status

    Definition: Status of the Policy Server. The status can be Active or Inactive.

    Metric:

    SiteMinder Policy Servers||Policy Server Data:Type

    Definition: Type of the Policy Server.

    This section contains the following topics:

    Installation and Configuration Information Metrics (see page 18) Performance (see page 20) Connected Web Agents (see page 20) Caching (see page 23) Cookies (see page 24) URLs (see page 25) Key Operations (see page 25)

  • Installation and Configuration Information Metrics

    18 for CA SiteMinder SNMP Collector Guide

    Installation and Configuration Information Metrics

    The following list contains Installation and Configuration metrics definitions:

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:Crypto

    Definition: Length of the encryption key that is used to encrypt/decrypt data that are sent between the Web Agent and the Policy Server.

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:L2 Cache Enabled

    Definition: Indicates whether the L2 cache is enabled.

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:Label

    Definition: Policy Server build number.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data | Install Configuration:Platform

    Definition: Operating system of the computer where the Policy Server is installed.

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:Policy Cache Enabled

    Definition: Indicates whether the policy cache is enabled.

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:Port

    Definition: Policy Server port number.

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:Product

    Definition: Policy Server product name.

  • Installation and Configuration Information Metrics

    Chapter 2: Metrics for SNMP Collector 19

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:Timezone

    Definition: Time zone for the geographical location where the Policy Server is installed.

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:Update

    Definition: Version number of the most recently applied update.

    Metric:

    SiteMinder Policy Servers||Policy Server Data|Install

    Configuration:Version

    Definition: Version number of the authentication server.

  • Performance

    20 for CA SiteMinder SNMP Collector Guide

    Performance

    The following list contains Performance metrics definitions:

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authentication Accept Count

    Definition: Number of successful authentications.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authentication Reject Count

    Definition: Number of failed authentication attempts. These attempts that are failed because of invalid credentials.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authorization Accept Count

    Definition: Number of successful authorization attempts.

    Metric:

    SiteMinder Policy Servers||Policy Server Data

    |Performance:Authorization Reject Count

    Definition: Number of rejected authorization attempts. These attempts were rejected because of insufficient access privileges.

    Metric:

    SiteMinder Policy Servers||Policy Server Data

    |Performance:Max Sockets

    Definition: Maximum number of open sockets (correspond to the number of open connections between the Policy Server and web agents) that the Authentication Server can support.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Socket Count

    Definition: Number of open sockets, which corresponds to the number of open connections between the Policy Server and web agents.

    Connected Web Agents

    All metrics for SiteMinder Policy Server connected web agents appear in the Investigator under the node:

    SiteMinder Policy Servers||Connected Web

    Agents|| ||

  • Connected Web Agents

    Chapter 2: Metrics for SNMP Collector 21

    The following list contains definitions of Connected Web Agents metrics:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|:Host

    Definition: IP address of the computer where the web agent is installed.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|:Last Activity

    Definition: Date and time of the last activity of the web agent.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|:Name

    Definition: Name of the web agent.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|:Start Time

    Definition: The startup time of the web server where the web agent is installed.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|:Status

    Definition: Status of the web agent. The status can be active or inactive.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|:Type

    Definition: Type of monitored component. In this case, web agent.

    Installation and Configuration Information Metrics

    The following list contains Installation and Configuration Information metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Install Configuration:Crypto

    Definition: Length of the encryption key that is used to encrypt/decrypt data that are sent between the web agent and the Policy Server.

  • Connected Web Agents

    22 for CA SiteMinder SNMP Collector Guide

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Install Configuration:Label

    Definition: Web agent build number.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Install Configuration:Platform

    Definition: Operating system of the computer where the web agent is installed.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Install Configuration:Product

    Definition: Web agent product name.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Install Configuration:Timezone

    Definition: Time zone for the geographical location where the web agent is installed.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Install Configuration:Update

    Definition: Version number of the latest software update.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Install Configuration:Version

    Definition: Version number of the web agent.

    Performance Metrics

    The following list contains Performance metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance:Socket Count

    Definition: Number of open sockets, which corresponds to the number of open connections between the Policy Server and the web agent. Because the Web Agent architecture for CA SiteMinder has changed, Socket Count has no value. The value is always zero.

  • Caching

    Chapter 2: Metrics for SNMP Collector 23

    Caching

    The following list contains Caching metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching:Resource

    Definition: Metrics about how often resources are found in the resource cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching|Resource:Average Cache Size

    Definition: Number of entries that are in the resource cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching|Resource:Hit Count

    Definition: Number of successful IsProtected calls from the cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching|Resource:Miss Count

    Definition: Number of IsProtected calls not found in the cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching|Resource:Max Cache Size

    Definition: Number of entries that can fit into the resource cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance|Caching:User Session

    Definition: Metrics about how often sessions are found in the user session cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance|Caching|

    User Session:Average Cache Size

    Definition: Number of entries that are in the user session cache.

  • Cookies

    24 for CA SiteMinder SNMP Collector Guide

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance|Caching| User Session:Hit Count

    Definition: Number of successful login calls from the cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching| User Session:Miss Count

    Definition: Number of login calls not found in the cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching| User Session:Max Cache Size

    Definition: Number of entries that can fit into the user session cache.

    Cookies

    The following list contains Cookie metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance|Cookies:Bad Cookie Hits

    Definition: Number of cookies that the Web Agent could not decrypt.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance|Cookies:Expired Cookie Hits

    Definition: Number of requests that contained an expired cookie.

  • URLs

    Chapter 2: Metrics for SNMP Collector 25

    URLs

    The following list contains URL metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance|URLs:Bad URL chars Hits

    Definition: Number of requests that the agent refuses because of bad URL characters. Bad URL characters are blocked to prevent a web client from evading SiteMinder rules.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance|URLs:Cross Site Script Hits

    Definition: Number of cross-site scripting hits. A cross-site scripting hit consists of malicious code embedded in pages at your site.

    Key Operations

    You can monitor key operations by viewing various metrics.

    Authorize

    The following list contains Authorization metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize

    Definition: Authorize a user after the login credentials for the user are validated.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize:Moving Average

    Response Time (ms)

    Definition: Average time for an authorized call (from the perspective of an agent) measured in milliseconds.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize:Error Count

    Definition: Number of errors returned in authorized calls.

  • Key Operations

    26 for CA SiteMinder SNMP Collector Guide

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize:Failure Count

    Definition: Number of failed authorize calls.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize:Invocation Count

    Definition: Number of authorized calls to the Policy Server.

    IsProtected

    The following list contains IsProtected metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| IsProtected

    Definition: Verifies whether the SiteMinder protects a defined resource and returns the relevant realm.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| IsProtected :Moving Average

    Response Time (ms)

    Definition: Average time for IsProtected call (from the perspective of an agent), measured in milliseconds.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| IsProtected:Error Count

    Definition: Number of errors while issuing the IsProtected call.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| IsProtected:Invocation Count

    Definition: Issues the Number of IsProtected calls by the agent.

    Note: Failure Count metric is not available for IsProtected operation.

  • Key Operations

    Chapter 2: Metrics for SNMP Collector 27

    Login

    The following list contains Login metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations|Login

    Definition: Establishes a connection to the Policy Server.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Login:Moving Average

    Response Time (ms)

    Definition: Average time for login call (from the perspective of an Agent) measured in milliseconds.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Login:Error Count

    Definition: Number of error returns in login calls.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Login:Failure Count

    Definition: Number of failed login calls.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Login:Invocation Count

    Definition: Number of login calls with Login credentials.

  • Key Operations

    28 for CA SiteMinder SNMP Collector Guide

    Validation

    The following list contains Validation metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Validation

    Definition: Determines if a defined user has authorization from the SiteMinder to perform a defined action on a defined resource.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Validation:Moving Average

    Response Time (ms)

    Definition: Average time for validation call (from the perspective of an agent) measured in milliseconds.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Validation:Error Count

    Definition: Number of error returns in validation calls.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Validation:Failure Count

    Definition: Number of failed validation calls.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Validation:Invocation Count

    Definition: Number of validation calls to Policy Server.

  • Chapter 3: Aggregated Metrics for SNMP Collector 29

    Chapter 3: Aggregated Metrics for SNMP Collector

    Aggregated metrics for SiteMinder OneView Monitor appear in the Investigator under the node:

    SiteMinder-Monitor|SiteMinder-Monitor(*SuperDomain*) |SiteMinder Policy Servers

    node.

    Aggregated metrics for SiteMinder Policy Servers appear in the Investigator under the node:

    SiteMinder Policy Servers||Policy Server Data|

    ||

    This section contains the following topics:

    Performance (see page 30) Caching (see page 31) Key Operations (see page 31) IsProtected (see page 33) Login (see page 34) Validation (see page 35)

  • Performance

    30 for CA SiteMinder SNMP Collector Guide

    Performance

    The following list contains Performance metrics definitions:

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authentication Accepts Per Interval

    Definition: Sum of successful authentication attempts per interval.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authentication Rejects Per Interval

    Definition: Sum of failed authentication attempts per interval.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authorization Accepts Per Interval

    Definition: Sum of successful authorization attempts per interval.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authorization Rejects Per Interval

    Definition: Sum of rejected authorization attempts per interval.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authentication Requests Per Interval

    Definition: Total number of authentication attempts per interval. This metric includes successful and failed authentication attempts.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Authorization Requests Per Interval

    Definition: Total number of authorization attempts per interval. This metric includes successful and failed authorization attempts.

    Metric:

    SiteMinder Policy Servers||Policy Server

    Data|Performance:Total Requests Per Interval

    Definition: Total number of requests per interval. This metric includes the total number of authentication attempts per interval and the total number of authorization attempts per interval.

  • Caching

    Chapter 3: Aggregated Metrics for SNMP Collector 31

    Caching

    The following list contains Caching metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching|Resource:Hits Per Interval

    Definition: Sum of hits count per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching|Resource:Misses Per Interval

    Definition: Sum of misses per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching| Resource:Cache Hit Percentage

    Definition: Sum of percentage of successful hits from the cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching|Resource:Accesses Per Interval

    Definition: Sum of hits per interval and misses per interval from Resource.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching| User Session: Hits Per Interval

    Definition: Sum of hits count per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching| User Session: Misses Per Interval

    Definition: Sum of misses per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching| User Session:Cache Hit Percentage

    Definition: Sum of percentage of successful hits from the cache.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents|| Performance| Caching| User Session:Accesses Per Interval

    Definition: Sum of hits per interval and misses per interval from User Session.

    Key Operations

    You can monitor key operations by viewing various metrics.

  • Key Operations

    32 for CA SiteMinder SNMP Collector Guide

    Authorize

    The following list contains Authorization metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize:Errors Per Interval

    Definition: Sum of errors returned in authorize calls per Interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize:Responses Per

    Interval

    Definition: Sum of authorize calls to Policy Server per Interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize:Average Response

    Time (ms)

    Definition: Average time for authorize calls per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Authorize:Failures Per

    Interval

    Definition: Sum of failures returned in authorize calls per interval.

  • IsProtected

    Chapter 3: Aggregated Metrics for SNMP Collector 33

    IsProtected

    The following list contains IsProtected metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| IsProtected:Errors Per

    Interval

    Definition: Sum of error returns in IsProtected calls per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| IsProtected:Responses Per

    Interval

    Definition: Issues the Sum of IsProtected calls by the agent per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| IsProtected:Average Response

    Time (ms)

    Definition: Average time for IsProtected calls per interval.

    Note: Failure Count metric is not available for IsProtected operation.

  • Login

    34 for CA SiteMinder SNMP Collector Guide

    Login

    The following list contains Login metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Login:Errors Per Interval

    Definition: Sum of error returns in login calls per Interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Login:Responses Per Interval

    Definition: Sum of login calls per Interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Login:Average Response Time

    (ms)

    Definition: Average time for login calls per Interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Login:Failures Per Interval

    Definition: Sum of failures returned in login calls per interval.

  • Validation

    Chapter 3: Aggregated Metrics for SNMP Collector 35

    Validation

    The following list contains Validation metrics definitions:

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Validation:Errors Per

    Interval

    Definition: Sum of error returns in validation calls per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Validation:Responses Per

    Interval

    Definition: Sum of validation calls to Policy Server per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| Key Operations| Validation:Average Response

    Time (ms)

    Definition: Average time for validation calls per interval.

    Metric:

    SiteMinder Policy Servers||Connected Web

    Agents||Performance| KeyOperations|Validation:Failures Per

    Interval

    Definition: Sum of failures returned in validation calls per interval.

  • Index 37

    Index

    A

    Aggregated Metrics for SNMP Collector 29 Authorize 25, 32

    B

    Before You Begin 9

    C

    CA Technologies Product References 3 Caching 23, 31 Connected Web Agents 20 Contact CA Technologies 5 Cookies 24

    H

    How to Install and Configure the Extension 9

    I

    Installation and Configuration Information Metrics 18, 21

    Installation Instructions and Metrics 9 IsProtected 26, 33

    K

    Key Operations 25, 31

    L

    Login 27, 34

    M

    Metrics for SNMP Collector 17

    P

    Performance 20, 30 Performance Metrics 22

    S

    Step 1 Running the Enterprise Manager Installer 10

    Step 2 Installing Agent Components on Windows/UNIX

    10

    Step 3 Configuring the Agent Profile 13

    Step 4 Configuring the SNMP Collector 14

    Step 5 Enabling the Management Module and

    Dashboards 14 Step 6

    Run the SNMP Collector 15

    T

    The Extension Agent Files 12

    U

    URLs 25

    V

    Validation 28, 35

    CA Technologies Product ReferencesContact CA TechnologiesContentsChapter 1: Installation Instructions and MetricsBefore You BeginHow to Install and Configure the ExtensionStep 1: Running the Enterprise Manager InstallerStep 2: Installing Agent Components on Windows/UNIXThe Extension Agent Files

    Step 3: Configuring the Agent ProfileStep 4: Configuring the SNMP CollectorStep 5: Enabling the Management Module and DashboardsStep 6: Run the SNMP Collector

    Chapter 2: Metrics for SNMP CollectorInstallation and Configuration Information MetricsPerformanceConnected Web AgentsInstallation and Configuration Information MetricsPerformance Metrics

    CachingCookiesURLsKey OperationsAuthorizeIsProtectedLoginValidation

    Chapter 3: Aggregated Metrics for SNMP CollectorPerformanceCachingKey OperationsAuthorize

    IsProtectedLoginValidation

    Index


Recommended