13.3 Configuring URI Access to Statistics Reports

As described in Section 13.1, "Methods for Monitoring Oracle Traffic Director Instances," in addition to viewing activity statistics by using the CLI, you can view the following reports through a URI.

  • stats-xml: Detailed statistics in XML format. For a sample, see Section 13.7.

  • perfdump: A summary report in plain-text format containing a subset of the data in the stats-xml report. For a sample, see Section 13.8. Note that though you enable the perf-dump report at the virtual-server level, the data in the report is aggregated at the instance level.

Note:

If you enable URI access to statistics reports, then you should be aware that this URL can be visible to end users by accessing /.perfdump. The administrator should block this access through an external hardware load balancer.

Relative Advantages of URI-Based and CLI Access to Statistics Reports

  • The administration server need not be running for users to access the stats-xml and perfdump reports through URIs. When compared with accessing statistics by using the CLI, accessing URI-based reports involves lower processing overhead.

  • Access to statistics by using the CLI is enabled by default, but to view statistics through the browser, you should explicitly enable URI-based reporting and specify the URIs at which users can access the reports.

You can configure URI-based reporting of statistics by using either the administration console or the CLI.

Configuring URI Access to Statistics Using the Administration Console

To configure URI-based reporting by using the administration console, do the following:

  1. Log in to the administration console, as described in Section 2.3.2, "Accessing the Administration Console."

  2. Click the Configurations button that is situated at the upper left corner of the page.

    A list of the available configurations is displayed.

  3. Select the configuration for which you want to configure URI-based reports.

  4. In the navigation pane, expand Virtual Servers, and select the virtual server for which you want to configure URI-based reports.

    The Virtual Server Settings page is displayed.

  5. Go to the Monitoring section of the page.

    • To enable URI-based reporting in XML format, select the XML Report check box and specify a valid URI.

    • To enable URI-based reporting in plain-text format, select the Plain Text Report check box and specify a valid URI for the report.

    On-screen help and prompts are provided for all of the parameters.

    When you change the value in a field or tab out of a text field that you changed, the Save button near the upper right corner of the page is enabled.

    At any time, you can discard the changes by clicking the Reset button.

  6. After making the required changes, click Save.

    • A message, confirming that the updated configuration was saved, is displayed in the Console Messages pane.

    • In addition, the Deployment Pending message is displayed at the top of the main pane. You can either deploy the updated configuration immediately by clicking Deploy Changes, or you can do so later after making further changes as described in Section 4.3, "Deploying a Configuration."

Configuring URI Access to Statistics in XML Format Using the CLI

Note:

The CLI examples in this section are shown in shell mode (tadm>). For information about invoking the CLI shell, see Section 2.3.1, "Accessing the Command-Line Interface."

  • To view the current XML reporting settings, run the get-stats-xml-prop command, as shown in the following example:

    tadm> get-stats-xml-prop --config=soa --vs=vs1
enabled=false
uri=/stats-xml(|/*)

  • To enable and configure URI-based XML reporting, run the enable-stats-xml command.

    For example, the following command enables URI-based statistics reporting in XML format for the virtual server vs1 in the configuration soa and specifies that the report should be available at the URI /stats.

    tadm> enable-stats-xml --config=soa --vs=vs1 --uri=/stats
OTD-70201 Command 'enable-stats-xml' ran successfully.

  • To disable URI-based XML reporting, run the disable-stats-xml command, as shown in the following example:

    tadm> disable-stats-xml --config=soa --vs=vs1
OTD-70201 Command 'disable-stats-xml' ran successfully.

For the updated configuration to take effect, you should deploy it to the Oracle Traffic Director instances by using the deploy-config command.

Configuring URI Access to Statistics in Plain-Text Format Using the CLI

  • To view the plain-text reporting settings, run the get-perfdump-prop command, as shown in the following example:

    tadm> get-perfdump-prop --config=soa --vs=vs1
enabled=true
uri=/.perf

  • To enable and configure the plain-text reporting, run the enable-perfdump command.

    For example, the following command enables URI-based statistics reporting in plain-text format for the virtual server vs1 in the configuration soa and specifies that the report should be available at the URI /perf.

    tadm> enable-perfdump --config=soa --vs=vs1 --uri=/perf
OTD-70201 Command 'enable-perfdump' ran successfully.

  • To disable URI-based plain-text reporting, run the disable-perfdump command, as shown in the following example:

    tadm> disable-perfdump --config=soa --vs=vs1
OTD-70201 Command 'disable-perfdump' ran successfully.

For the updated configuration to take effect, you should deploy it to the Oracle Traffic Director instances by using the deploy-config command.

For more information about the CLI commands mentioned in this section, see the Oracle Traffic Director Command-Line Reference or run the commands with the --help option.