1. Using Oracle Infrastructure Monitoring
  2. Discovery
  3. Add Oracle Traffic Director

Add Oracle Traffic Director

You can add Oracle Traffic Director entities using the Add Entity UI or using the cloud agent command line interface (omcli) with the appropriate JSON files.

Step 1: Prepare Oracle Traffic Director for monitoring.

Prerequisites

OTD 11

Use an OTD Administrator user.

In addition, to enable collection of metrics, you must configure and start an SNMP subagent. To start the SNMP subagent, use OTD Admin Console, or use the following command:
tadm start-snmp-subagent
--host=<otd_host>
--port=<otd port>
--user=<otd user>
--password-file=<password_file>

For more information on configuring and starting an SNMP subagent, see the Oracle Traffic Director documentation.

OTD 12

Use a WebLogic Server user with the Monitor role. The user can also have Operator or Admin roles, which include the Monitor role.

Step 2: Decide how you want to add the Oracle Traffic Director.

You can add Oracle Traffic Director entities using one of two ways:

  • Add them from UI
  • Use the agent's omcli add_entity command with the appropriate JSON files

Adding Entities from the UI

  1. From the Management Cloud main menu, select Administration, Discovery, and then Add Entity. The Add Entity page displays.
  2. Select the Oracle Traffic Director Entity Type.
  3. Enter the following UI properties.
    Traffic Director Instance (OTD) UI Fields

    12c or later

    • Entity Name: The OTD entity name that is displayed on Infrastructure Monitoring UI.
    • Port: OTD Administration Server listening port
    • Protocol: t3 or t3s
    • Administration Server Host: Fully-qualified host name where the OTD Administration Server is installed.
    • Discover Coherence: Coherence Clusters deployed on the domain will be discovered. Turn this option off when discovering a SOA Suite Domain.
    • Cloud Agent: Cloud agent monitoring the host where the OTD Administration Server is installed.

    Monitoring Credentials (WebLogic Server Credentials)

    • Username: OTD Administration Server username.
    • Password: OTD Administration Server password.

    11g

    • Entity Name: OTD 11g Entity Display Name which is displayed on Infrastructure Monitoring UI
    • Administration Server Host Name: Fully-qualified Host Name where the OTD 11g Administration Server is installed.
    • Administration Server Listen Port: OTD 11g Administration Server listening port.
    • Configuration Name: OTD 11g configuration name
    • Administration Server Oracle Home: Absolute path of the OTD 11g Administration Server oracle home location
    • Cloud Agent: Cloud agent monitoring the host where the OTD 11g Administration Server is running.

    Monitoring Credentials (OTD 11g Administration Server Credentials)

    • Administration Username: OTD 11g Administration Server username
    • Administration Password: OTD 11g Administration Server password
    • SNMP Community String: Community string used in SNMP aubagent. Default value is "public".

See Add Entities from the Console for detailed instructions on using the Add Entity UI.

Using omcli and the Appropriate JSON Files

  1. Download and extract the required JSON file(s) from the master JSON zip file. See the table below for the specific JSON files you'll need.
  2. Edit the file(s) and specify the requisite properties shown below.
    Traffic Director Instance (OTD) JSON Files and Properties

    Definition File: omc_oracle_otd_cluster_sample.json

    Note:

    This applies specifically for OTD 11. For OTD 12, OTD will be automatically discovered as part of the WebLogic Domain discovery
    • name: Your OTD 11g name.
    • displayName: Name displayed in the Oracle Infrastructure Monitoring User Interface.
    • timezoneRegion: Time zone of your entity. It is recommended that you use the long values IANA-maintained TZ database time zones. For example: America/New_York
    • admin_host: Under “value”, provide the fully-qualified Host Name where the OTD 11g Administration Server is installed.
    • admin_port: Under “value”, provide the OTD 11g Administration Server listening port.
    • admin_oracle_home: Under “value”, provide the absolute path of the OTD 11g Administration Server Oracle Home location.
    • config_name: Under “value”, provide the OTD 11g configuration name.

    Credential File: omc_oracle_otd_cluster_sample_creds.json

    Note:

    This applies specifically for OTD 11. For OTD 12, OTD will be automatically discovered as part of the WebLogic Domain discovery.
    • admin_user_name: Under “value”, within the square brackets, provide the OTD 11g Administration Server user name. You must have identified this user in the Prerequisite Tasks step.
    • admin_password: Under “value”, within the square brackets, provide the OTD 11g Administration Server password.
    • snmp_comm_string: Under “value”, within the square brackets, provide the community string used in SNMP subagent. The default value is "public".

    Do not remove the square brackets.
  3. Add the entity using omcli.
    omcli add_entity agent DEFINITION_FILE [-credential_file CREDENTIAL_FILE [-encryption_method_gpg]]
  4. Verify the status of the newly added entity. 
    omcli status_entity agent DEFINITION_FILE

See step 4. Adding Entities to Your Service of Add Entities Using JSON Files for more information.

Step 3: (Optional but recommended) Set up alerts.

To enable lights-out monitoring, you can set up alert rules to generate alerts and send notifications if your entities have performance issues.

See Set Up Alert Rules and Set Up Alert Thresholds and Notifications.

Troubleshooting

If you run into any issues regarding discovery or monitoring of Oracle Traffic Director, see the following: