sybase IM Configuration

This article describes the configuration concepts and procedures to set up the Sybase Monitoring (sybase) probe. To configure the probe, you must create a connection to the Sybase server and a monitoring profile. These connections are used for running monitoring profiles on the Sybase server. These profiles monitor real-time events occurring in the server using various checkpoints. For example, you can create a profile that uses locked_users checkpoint to monitor the number of locked users in the system at a given time. You can create checkpoints or use predefined checkpoints, that can be customized. These profiles can also be configured to generate alarm and QoS messages.
uimpga-ga
sybase_IM
This article describes the configuration concepts and procedures to set up the Sybase Monitoring (sybase) probe. To configure the probe, you must create a connection to the Sybase server and a monitoring profile. These connections are used for running monitoring profiles on the Sybase server. These profiles monitor real-time events occurring in the server using various checkpoints. For example, you can create a profile that uses locked_users checkpoint to monitor the number of locked users in the system at a given time. You can create checkpoints or use predefined checkpoints, that can be customized. These profiles can also be configured to generate alarm and QoS messages.
The following diagram outlines the process to configure the sybase probe.
sybase_IM_configuration
sybase_IM_configuration
Contents
Verify Prerequisites
  • Verify that required hardware, software, and related information is available before you configure the probe.
Configure General Properties
The probe is deployed with default values as part of recommended configuration. You can change the default configuration of the probe if they do not meet your needs.
Follow these steps:
  1. Navigate to the
    Setup > General
    tab and specify the following values as required:
    • Generate status only
      : instructs the probe to only generate status and not issue an alarm when a threshold is breached. Select the
      Status
      tab to see the status for the different checkpoints.
      Default: Not selected
    • Alarm severity filter
      : sets a filter on severity levels that can become potential alarms. The sybase probe can check the Sybase databases. Some events that are generated are vital and key to the performance and availability of the database. For example, as a database administrator, you want to convey important events on to the operations center or help-desk, so that the event can trigger emails. The
      Alarm severity filter
      considers the events matching or exceeding the selected severity level alarms. If you select major, then only the messages with severity level as major and above are considered as alarms.
      The probe verifies the events matching the selected severity level only when you disable the
      Generate status only
      field.
      You can select from the following options:
      • clear
      • information
      • warning
      • minor
      • major
      • critical
    • Status Auto-Update:
      enables you to specify the automatic refresh interval of the monitoring profiles that are displayed under the
      Status
      tab.
      Default: 60 seconds
      The
      Status Auto-Update
      value is saved in the configuration file but the check box is cleared when you restart the probe.
    • Log Size:
      specifies a maximum size of the probe log file.
      Default:100 KB
    • Log Level:
      specifies the level of details that are written to the log file.
      Default: 0-Fatal
      Log as little as possible during normal operation to minimize disk consumption, and increase the amount of detail when debugging.
  2. Click
    OK
    to save the configuration.
Create a Connection
You can create a connection to the Sybase server that you want to monitor. You must specify the user name, password, and server name to be used to connect to the server instance. The password information is encrypted and placed in the configuration file. A connection can be used by more than one profile. You can create separate connections for monitoring server or tables, as required.
Follow these steps:
  1. Right-click in the
    Connections
    tab and select
    New
    .
  2. Enter a connection name in the
    Add New Connection
    dialog and click
    OK
    .
    The
    New Connection
    dialog is displayed.
  3. Specify the
    User ID
    ,
    Password
    , and name of the
    Server
    that you want to connect.
    The interface files contains information about Adaptive Server and Open Server applications. For example, you can get the server name from the interface files to establish the connection.
  4. Specify the following values in the
    New Connection
    dialog:
    • Advanced monitoring
      :
      allows you to perform advanced monitoring of the Sybase server. The
      Monitor Option
      field is enabled when you select the
      Advanced monitoring
      check box.
      • Monitor Option
        : allows you to specify the monitoring object as server or table. You can select any of the following options: Monitoring Server, Monitoring Tables.
    • In advanced mode, the probe allows you to monitor Sybase server and tables. In basic mode, the probe monitors only the server.
    • The Monitoring Server is not a part of the Adaptive Server Enterprise v15.7 or later. Hence, advanced monitoring using Monitoring Server is not supported.
    • Description:
      specifies additional information about the connection.
    • Monitoring server:
      specifies the monitoring server name. This field appears when you select the Monitor option as
      Monitoring server
      .
    • Retry attempts:
      specifies the number of attempts that the probe tries to connect in case of connection failure.
    • Retry delay:
      specifies the time period for which the probe waits between two connection attempts.
    • Timeout:
      specifies the connection timeout value.
  5. Click
    Test
    to verify the status of connection
    .
    If the connection is successful, it returns the instance name and version number. If the connection is unsuccessful, the probe displays a sybase error message.
  6. Click
    OK
    .
    The new connection is added to the
    Connections
    tab.
  • To copy a connection, right-click the connection and select
    Copy
    .
  • To edit a connection, right-click the connection and select
    Edit
    .
  • To delete a connection, right-click the connection and select
    Delete
    .
  • To rename a connection, right-click the connection and select
    Rename
    .
Create a Profile
You can create multiple profiles that monitor the Sybase server to verify that the performance always remains optimal. Every profile runs as a separate thread, and multiple profiles can be used to monitor one instance. The color of indicator icon appearing before the profile name indicates the following:
  • Green icon: profile is active and running.
  • Yellow icon: profile is active but suspended.
  • Black icon: profile is inactive.
Follow these steps:
  1. Right-click in the
    Profile
    tab and click
    New
    .
  2. Enter the name of the profile in
    Add New Profile
    dialog and click
    OK
    .
  3. Select
    Active
    to activate the profile for monitoring.
  4. Specify the following information:
    • Description
      :
      specifies additional information about the profile.
    • Heartbeat
      :
      specifies the interval at which all profile checkpoints schedules are tested and executed. This number is a common denominator to all used check interval values. The higher the value, the lower is the profile overhead.
      Default: 5 seconds
    • Connection
      :
      defines the connection used in this profile. The drop-down lists all the connections displayed in the
      Connections
      tab.
    • Check Interval
      :
      specifies the time interval at which the Sybase server or tables are scanned. Default: 5 minutes
      A shorter interval can also increase the system load. Reduce this interval to generate alarms frequently.
    • Clear message
      : specifies the message name used for clear alarm.
    • SQL Timeout
      :
      specifies the SQL query timeout.
      Every checkpoint query runs asynchronously. In case the query reaches the SQL timeout, the checkpoint processing is terminated and the probe starts the processing of the next checkpoint. The probe also generates an alarm message.
      Default: 30 seconds 
      On every check interval, the SQL timeout alert is first cleared on the basis of query for a particular checkpoint. The SQL timeout alert is generated again if the issue persists.
    • Message
      :
      specifies the message name used for SQL timeout alarm.
    • Profile Timeout
      :
      specifies the maximum processing time for all checkpoints in the profile. If this timeout is reached, the interval processing is done and the probe waits for next heartbeat to evaluate any checkpoint schedules. The probe also generates an alarm message.
      Default: 15 minutes 
    • Message
      :
      specifies the message name used for profile timeout alarm.
    • Timeout severity
      :
      specifies the severity for timeout messages.
    • Suspended/Resumed
      : specifies the profile state as running or suspended. This indicator is green when the profile is active. The indicator changes to yellow when the profile is suspended and to black when deactivated.
    • Alarm Source
      :
      overrides the source name of the alarm on the Unified Service Management(USM). If you do not specify a value, robot IP address is used.
    • Use Alarm source as QoS source
      :
      enables you to use alarm source for QoS.  If you select the check box without specifying the alarm source, then the robot name becomes the QoS source.
  5. Click
    OK
    to create the profile for monitoring.
  • To copy the selected monitoring profile, right-click the profile and select
    Copy
    .
  • To modify a profile, right-click the profile and select
    Edit
    .
  • To delete a profile, right-click the profile and select
    Delete
    .
  • To rename a profile, right-click the profile and select
    Rename
    .
  • To stop the selected profile from monitoring the server, right-click the profile and select
    Suspend .
  • To restart the selected profile to monitor the server, right-click the profile and select
    Resume.
Add Profile Checkpoints
Select the
Profile Checkpoints
that you want from the list in the
New Profile
dialog. Profile checkpoints are predefined parameters that can be used for monitoring the server performance or unwanted events. The global and default checkpoint settings are used, unless you modify the settings locally for your profile.
Configure Checkpoints
You can configure the properties of a checkpoint to monitor the server performance or unwanted events. You can use dynamic checkpoint templates, which means that the checkpoints are defined globally (under the
Templates
tab) and represent the default settings. When you change the template value, it reflects on all profiles using dynamic templates strategy.
Follow these steps:
  1. Double-click the required checkpoint from the
    Edit Profile
    dialog.
    The
    Edit template checkpoint
    dialog appears.
  2. Select
    Active
    to activate a checkpoint. If you do not select the check box, the checkpoint is not available for monitoring.
  3. Set or modify the following values, as needed:
    • Description:
      specifies additional information about the checkpoint.
    • Check Interval:
      specifies the time interval at which the Sybase tables and server is scanned. 
      A shorter interval can also increase the system load. Reduce this interval to generate alarms frequently.
    • Send Quality of Service:
      enables you to activate QoS values being sent into the QoS database. If not available for a checkpoint, the check box is disabled.
    • QoS List
      : allows you to define QoS to be used in the checkpoint. Click single_arrow.png to open the
      QoS list
      dialog that displays the current QoS definition list.
      Right-click in the list to add new QoS definitions and copy, edit, or delete any existing QoS definition.
      Some of the checkpoints cannot be used for generating QoS . For such checkpoints, the QoS dialog cannot be activated.
    • Samples:
      specifies the number of samples to calculate an average value, which is compared with the specified alarm threshold. The probe generates an alarm when the average value of any sample breaches the threshold. The probe behavior for the following
      Samples
      value is described as follows:
      • 0: Sampling is done based on the number of samples defined in the template. If no number is specified in the template, no sampling is done.
      • 1: No sampling is done.
      • 3: The probe performs the following:
        • uses the first sample value in the first interval
        • uses the average of samples 1 and 2 in the second interval
        • uses the average of samples 1, 2, and 3 in the third interval
      Default: 1
    • Use excludes:
      allows you to specify the patterns to be excluded in the template checkpoint. Click single_arrow.png to open the
      Exclude list
      dialog and specify the patterns to be excluded for the checkpoint. You can define objects that you do not want to monitor in the template checkpoint.
      This check box is available for a custom checkpoint from version 4.9 or later. In previous versions, this check box is disabled after you create a custom checkpoint.
    • Scheduling:
      allows you to specify the schedule settings, if defined. You can select any of the following:
      • rules:
        defines rules for running the schedules of the template checkpoint.
      • exceptions:
        defines exceptions for running the schedules of the template checkpoint.
    • Clear message:
      specifies the message name used for clear alarm message.
    • Clear severity:
      specifies the severity used for message issued when the threshold is not breached. You can select from the following:
      • clear
      • information
      • warning
      • minor
      • major
      • critical
  4. Click
    OK
    .
    The checkpoint is configured. Similarly, to edit the properties for a checkpoint template, double-click the checkpoint in the
    Profile
    list or
    Templates
    tab. After modification, the new settings will be valid for all profiles, unless overruled by static settings in the profile. If you want specific settings valid only for one profile, right-click the checkpoint in the list and select
    Change to Static
    . Such checkpoints apply to the selected profile.
Create Custom Checkpoints
This section describes how to create a custom checkpoint for the sybase probe. The checkpoints can be used to monitor various database events occurring in the Sybase server.
Follow these steps:
  1. Navigate to the
    Templates
    tab,  right-click and select
    Create new
    from the context menu.
  2. Specify the name for the custom checkpoint in
    Add New User Template
    dialog and click
    OK
    .
    The
    Edit template checkpoint
    dialog opens.
  3. Click the
    Query
    tab.
  4. Select the required connection from the
    Connection
    drop-down list that displays a list of preconfigured connections, created from the
    Connections
    tab.
    To edit the connection parameters, click
    Edit/New
    to open the
    Edit Connection
    dialog.
  5. Click
    Test
    in the
    Edit Connection
    dialog to validate the connection settings.
    A confirmation message appears.
  6. Click
    OK
    .
  7. In the
    Query
    tab of
    Edit template checkpoint
    dialog, enter the required query statement in the
    Query
    text box and click
    Test
    to validate the query.
    The
    Query Result
    dialog appears, displaying the query result.
    The
    Connection
    field in the
    Query
    tab of templates resets to none when you save the template configuration.
  8. Click
    Close
    .
  9. Set or modify the following values in the
    Query
    tab of
    Edit template checkpoint
    dialog:
    • Row identification
      : specifies the unique identification code of the row for which reporting is done.
    • Message variables
      : specifies the variables to be used in the message. Click
      Edit
      to choose one or more message variables.
    • Query file
      : specifies the file that stores the query.
    • Interval modus
      : enables you to subtract the variable value from the value generated at the end of the interval. On selecting the
      Interval modus
      check box, the variable
      $interval_value.i
      is added to the
      Message variables
      text box. The
      interval_value
      variable can be configured from the probe
      Raw Configuration
      interface.
  10. Navigate to the
    General
    tab of
    Edit template checkpoint
    dialog and provide the details as mentioned in Configure Checkpoints.
  11. After you have filled the above fields, click
    QoS List
    . The
    QoS list
    dialog appears.
  12. Right-click in the grid view and select
    New
    from the context menu.
  13. Enter a description of the QoS metric that you want to define.
  14. Set or modify the following values as required in the
    Edit
    dialog:
    • Name
      : specifies the name of the QoS metric.
    • Description
      : specifies the additional information about the QoS metric.
    • Unit
      : indicates the unit of QoS metric.
    • Metric
      : selects the required QoS metric.
    • Abbreviation
      : specifies the abbreviated name of the QoS metric.
    • Max value
      : specifies the maximum value of the QoS metric.
  15. Click
    OK
    in the Edit dialog and in the
    QoS list
    dialog.
Configure Alarm Thresholds
The thresholds list contains the predefined set of monitoring parameters that you can use in your profiles. The probe allows you to modify the thresholds as required. The threshold values can be defined by modifying checkpoints in the respective profile. Every checkpoint must have at least one threshold, but you can define additional thresholds. The probe scans the entire server to verify any matching events. When any given event breaches the set threshold, the probe generates an alarm message.
The threshold identification consists of an object name (if applicable), like tablespace name, userid, and a threshold ID, numbered from 0. Threshold values are descending or ascending, depending on condition used in a checkpoint, starting with the highest severity threshold condition.
Follow these steps:
  1. In the Thresholds section of the
    Edit template checkpoint
    dialog, right-click and select the
    New
    option.
    The
    Edit Threshold
    dialog appears.
  2. Specify the name of the monitoring object in the
    Threshold object name
    field.
  3. Select the conditional operator to be used in the
    Condition
    field.
  4. Define the
    Threshold Value
    .
  5. Select the
    Message
    for the threshold alarm.
  6. Set or modify the following values as needed:
    • Current interval value:
      specifies the last measured value, if invoked from the status report.
    • Severity:
      specifies the severity of alarm message to be used for the threshold.
    • Message text
      : specifies text of the message, containing variables. If the message text is changed from a profile list, you must create new message.
    • Variables:
      displays the list of variables that are available only for the custom checkpoints. For example, $check, $profile, $instance, $object, $state. The variables for every custom checkpoint are different, depending on the variable query.
    • Clear message
      : specifies the clear alarm message.
    • Scheduling
      : allows you to specify when the schedule is active or inactive.
      • rules:
        specifies the days and time when the schedule for the profile is active.
      • exceptions:
        specifies the days and time when the schedule for the profile is inactive.
    • Key Column Name
      : specifies the column name for which you can generate a key specific alarm.
    • Key Column Value
      : specifies the key value on which an alarm condition would be compared for the specified column name. If the condition matches, the alarm will be generated
    • Schedules
      : For more information on setting schedules, see Configure Schedules.
  7. Click
    OK
    to add the threshold object.
Configure Schedules
You can specify a schedule for the checkpoint to run. A schedule is a definition of an execution period on specified days, time from/to and date from/to values when you are using rules. If you are using exceptions, the schedule is considered as an execution break.
If the schedules list is empty, the checkpoint is executed in every 24 hours. Additionally, there can be defined number of schedules for each checkpoint, which can define additional
rules
to the check interval or
exceptions
of it. The
rules
and
exceptions
cannot be mixed in one checkpoint.
Follow these steps:
  1. Right-click in the
    Schedules
    section of
    General
    tab and select
    New
    from the context menu.
    The
    Schedule ID
    dialog appears.
    • First execution of schedule happens when you specify the value in
      Date from
      and
      fields
      .
    • Run once
      causes the checkpoint to run only once a day in the defined period (unlike multiple times if
      Run interval
      used).
  2. Click
    OK
    and click
    Yes
    to confirm the modification of template.
    The new schedule is added to the
    Templates
    tab.
View Profile Status
The
Status
tab lists the profiles that are defined and their corresponding checkpoint templates. You can also modify the properties of an individual checkpoint object from the
Status
tab.
Follow these steps:
  1. Select a profile in the right pane and a monitored checkpoint in the left pane.
  2. Double-click an object in the right pane. If the object belongs to a template object, you are warned that a modification will make the checkpoint static for the selected profile. Refer Configure Checkpoints.
Create Alarm Messages
You can define the alarm messages that you want the user to receive when a specified threshold is breached or cleared.
Follow these steps:
  1. Navigate to the
    Setup > Message
    Pool
    tab. This tab lists the following fields of the pre-defined alarm messages:
    • Name
      : specifies the alarm message name.
    • Text
      : specifies the alarm message text.
    • i18n Token:
      indicates the category of the alarm message to be identified in USM in non-english locales.
  2. Right click on the list and click
    New.
    The
    New Message
    dialog appears.
  3. Enter a name for the alarm message and click OK.
    The
    Edit Message
    dialog appears.
  4. Update the following information to configure the message properties:
      • Checkpoint
        : enables you to select a checkpoint for that alarm message.
      • Message text
        : specifies the required message text for the checkpoint.
      • Variables
        : enables you to add the selected variable in the
        Message text
        field. Click arrow.png to add the selected variable.
  5. Click
    OK
    .
  • If you want to copy a message, right click on it and select
    Copy
    .
  • If you want to edit a message, right click on it and select
    Edit
    .
  • If you do not want to use a message, right click on it and select
    Delete.
Variable Expansion in Alarms
You can enter a $ symbol in the alarm message text to select from the following list of variables:
  • Profile
    : defines the name of the profile in which the situation occurred.
  • Host
    : defines the host name being queried.
  • Jitter
    : defines the server time jitter. This indicates the time stability of the server.
  • Jitter_limit
    : defines the limit for jitter set in the profile above which an alarm should be generated.
  • Offset
    : defines the server time offset.
  • Offset_limit
    : defines the limit for offset set in the profile above which an alarm should be generated.
  • Refid
    : defines the refid of the NTP server queried.
  • Response_time
    : defines the time in milliseconds that is used for querying the server.
  • Response_time_limit
    : defines the limit for response time set in the profile above which an alarm should be generated.