1. Using Oracle WebLogic Server Proxy Plug-Ins
  2. Configuring the Plug-In for Oracle HTTP Server

2 Configuring the Plug-In for Oracle HTTP Server

The Oracle WebLogic Server Proxy Plug-In (WLS OHS Plug-In) is the plug-in for proxying requests from Oracle HTTP Server to Oracle WebLogic Server. The WLS OHS Plug-In is included in the Oracle HTTP Server 14c (14.1.2.0.0) installation. You do not have to download and install it separately.

You can configure the WLS OHS Plug-In either by using Fusion Middleware Control or by editing the mod_wl_ohs.conf configuration file manually.

Note:

The WLS OHS Plug-In is now able to front-end WebSocket applications.

This chapter includes the following topics:

Preparing for Configuring the WLS OHS Plug-In

You must complete some installation and verification tasks before configuring the WLS OHS Plug-In.

  • Ensure that Oracle WebLogic Server has been installed, a domain has been created, and you can access the Oracle WebLogic Remote Console. Oracle HTTP Server and WebLogic Server can be installed either in same domain or in separate domains.

  • If OHS is being used in a WebLogic managed domain, verify that Fusion Middleware Control has been installed and you can access the Enterprise Manager Fusion Middleware Control Console. This is required to configure the WLS OHS Plug-In by using the graphical interface provided by Fusion Middleware Control. The Fusion Middleware Control is available only for WebLogic managed domains.

  • To be able to test the configuration, ensure that the required Java applications are deployed to Oracle WebLogic Server—either to a single managed server or to a cluster—and are accessible.

See the following topics:

Parent topic: Configuring the Plug-In for Oracle HTTP Server

Setting the WebLogic Plug-In Enabled Parameter

You must set the WebLogic Plug-In Enabled parameter.

  1. Log in to the WebLogic Remote Console.
  2. In the Edit Tree, go to Environment, then:
    • If the server instances to which you want to proxy requests from Oracle HTTP Server are in a cluster, select Clusters.
    • Otherwise, select Servers.
  3. Select the cluster or server to which you want to proxy requests from Oracle HTTP Server.
  4. Click Show Advanced Fields.
  5. Turn on the WebLogic Plug-In Enabled option to use WebLogic Plug-Ins with the WebLogic Server.
    If you selected Servers (and not Clusters), turn on WebLogic Plug-In Enabled for every server to which you want to proxy requests from Oracle HTTP Servers.

    See Understanding the WebLogic Plug-In Enabled Parameter.

  6. Click Save.

For the change to take effect, you must restart the server instances.

Parent topic: Preparing for Configuring the WLS OHS Plug-In

Understanding the WebLogic Plug-In Enabled Parameter

The WebLogic Plug-In Enabled drop-down list contains these values:

  • Yes—Yes must be selected if the WLS proxy plug-ins are used with WebLogic Server. When set to Yes on the server, it specifies that this server uses the proprietary WL-Proxy-Client-IP header, which is recommended if the server instance will receive requests from a proxy plug-in.

    When set to Yes on the cluster, it specifies that the cluster will receive requests from a proxy plug-in or HttpClusterServlet. A call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header, instead of the web server.

  • No—Selecting No for the server or cluster disables the weblogic-plugin-enabled parameter (weblogic-plugin-enabled=false) in the config.xml file.

  • Default—When Default is selected for WebLogic Plug-In Enabled in the servers page, then the servers will inherit the value selected for WebLogic Plug-In Enabled for the cluster. When Default is selected for WebLogic Plug-In Enabled in the clusters page, then the clusters will inherit the value selected for WebLogic Plug-In Enabled for the domain.

Parent topic: Preparing for Configuring the WLS OHS Plug-In

Configuring the WLS OHS Plug-In Using Fusion Middleware Control

If OHS is being used in a WebLogic managed domain, you may use Fusion Middleware Control to configure the mod_wl_ohs module.

To configure the mod_wl_ohs module, complete the following tasks:

Parent topic: Configuring the Plug-In for Oracle HTTP Server

Task 1: Navigate to the mod_wl_ohs Configuration Page

The mod_wl_ohs configuration page contains the parameters for configuring the WLS OHS Plug-In.

  1. Ensure that you have fulfilled the prerequisites listed in Preparing for Configuring the WLS OHS Plug-In.
  2. Select Administration from the Oracle HTTP Server menu.
  3. Select mod_wl_ohs Configuration from the Administration menu. The mod_wl_ohs Configuration page appears.

    The following table describes the fields in the mod_wl_ohs page.

    Field Description

    Provide WebLogic Cluster Details

    List of Oracle WebLogic clusters that can be used for load balancing. The server or cluster list is a list of host:port entries. If a mixed set of clusters and single servers is specified, the dynamic list returned for this parameter will return only the clustered servers.

    If you are not sure of the correct cluster, you can click the search icon to see a list of all associated clusters. See Using the Search Function.

    The module does a simple round-robin between all available servers. The server list specified in this property is a starting point for the dynamic server list that the server and module maintain. Oracle WebLogic Server and the module work together to update the server list automatically with new, failed, and recovered cluster members.

    You can disable the use of the dynamic cluster list by disabling the Dynamic Server List ON field. The module directs HTTP requests containing a cookie, URL-encoded session, or a session stored in the POST data to the server in the cluster that originally created the cookie.

    Provide WebLogic Server Host and Port Details

    • WebLogic Host

      Oracle WebLogic Server host (or virtual host name as defined in Oracle WebLogic Server) to which HTTP requests should be forwarded. If you are using a WebLogic cluster, use the WebLogic Cluster parameter instead of WebLogic Host.

      If you are not sure of the correct server, you can click the search icon to see a list of all associated clusters. See Using the Search Function.

    • WebLogic Port

      Port at which the Oracle WebLogic Server host is listening for connection requests from the module (or from other servers). (If you are using SSL between the module and Oracle WebLogic Server, set this parameter to the SSL listen port.)

    Dynamic Server List ON | OFF

    When set to OFF, the module ignores the dynamic cluster list used for load balancing requests proxied from the module and only uses the static list specified with the WebLogic Cluster parameter. Normally this parameter should be set to ON.

    There are some implications for setting this parameter to OFF:

    • If one or more servers in the static list fails, the module could waste time trying to connect to a terminated server, resulting in decreased performance.

    • If you add a new server to the cluster, the module cannot proxy requests to the new server unless you redefine this parameter. Oracle WebLogic Server automatically adds new servers to the dynamic server list when they become part of the cluster.

    Error Page

    You can create your own error page to appear when your Web server cannot forward requests to Oracle WebLogic Server.

    WebLogic Temp Directory

    Specifies the location of the _wl_proxy directory for post data files.

    Exclude Path or MIME Type

    This parameter allows you exclude certain requests from proxying.

    This parameter can be defined locally at the Location tag level and globally. When the property is defined locally, it does not override the global property but defines a union of the two parameters.

    Match Expressions

    Use this region to specify any Expression overrides. For example, if you were proxying by MIME type, you might enter:

    *.jsp WebLogicHost=myHost|paramName=value

    You can define a new parameter for Match Expression by using the following syntax:

    *.jsp PathPrepend=/test|PathTrim=/foo

    (parameters are separated by a |)

    Location

    Use this table to specify any location overrides. See Task 3: Configure Expression Overrides or Location Overrides (Optional).

    Add Cross Component Wiring

    This button appears only if you have installed Oracle HTTP Server in full JRF mode (collocated) and there is a backing database.

    Selecting this button opens the Service Tables page. A service table provides a way for service providers to publish endpoint information about their services, and clients of these services to query and bind to these services. A service table is a single table in a database schema. There is one row for every endpoint that is published to it. The service table schema is initially created by the Repository Creation Utility.

    See Wiring Components to Work Together in Administering Oracle Fusion Middleware

Parent topic: Configuring the WLS OHS Plug-In Using Fusion Middleware Control

Task 2: Specify the Configuration Settings

Specify the configuration settings for the WLS OHS Plug-In. In the General section, you can configure mod_wl_ohs for a WebLogic cluster or for WebLogic servers.

  • If you select the Provide WebLogic Cluster Details radio button, then provide values for the WebLogic Cluster, Dynamic Server List ON, Error Page, WebLogic Temp Directory, and Exclude Path or MIME Type fields.

  • If you select the Provide WebLogic Server Host and Port Details radio button, then provide values for the WebLogic Host, WebLogic Port, Dynamic Server List ON, Error Page, WebLogic Temp Directory, and Exclude Path or MIME Type fields.

Parent topic: Configuring the WLS OHS Plug-In Using Fusion Middleware Control

Task 3: Configure Expression Overrides or Location Overrides (Optional)

If necessary, you can add expression or location overrides to your configuration.

  1. Add any expression overrides in the Match Expression field.

  2. Add any location overrides in the Location table.

    1. Click Add Row to create a new row.

    2. Enter the base URI for which the associated directives become effective.

    3. Complete the WebLogic Cluster, WebLogic Host, and WebLogic Port fields. You can automatically complete these fields by clicking AutoFill (see Using the AutoFill Function).

    4. Complete the Path Trim field.

      According to the RFC specification, generic syntax for URL is:

      [PROTOCOL]://[HOSTNAME]:{PORT}/{PATH}/{FILENAME};{PATH_PARAMS}/{QUERY_STRING}...

      Path Trim specifies the string trimmed by the module from the {PATH}/{FILENAME} portion of the original URL, before the request is forwarded to WebLogic Server. For example, if the URL: 

      http://myWeb.server.com/weblogic/foo

      is passed to the module for parsing and if Path Trim has been set to strip off /weblogic before handing the URL to WebLogic Server, the URL forwarded to WebLogic Server is: 

      http://myWeb.server.com:7002/foo

      Note:

      If you are converting an existing third-party server to proxy requests to WebLogic Server using the module for the first time, you must change application paths to /foo to include weblogic/foo. You can use Path Trim and Path Prepend in combination to change this path

    5. Complete the Path Prepend field.

      According to the RFC specification, generic syntax for URL is:

      [PROTOCOL]://[HOSTNAME]:{PORT}/{PATH}/{FILENAME};{PATH_PARAMS}/{QUERY_STRING}...

      Path Prepend specifies the path that the module prepends to the {PATH} portion of the original URL, after Path Trim is trimmed and before the request is forwarded to WebLogic Server.

      Note:

      If you need to append File Name, use the DefaultFileName module parameter instead of Path Prepend.

    6. Click Add Row again to save the new row.

Parent topic: Configuring the WLS OHS Plug-In Using Fusion Middleware Control

Task 4: Apply Your Changes

Apply your changes to the mod_wl_ohs Configuration Page and restart Oracle HTTP Server.

  1. If the settings are correct, click Apply to apply the changes. If the settings are incorrect or you decide to not apply the changes, click Revert to return to the original settings.
  2. Restart Oracle HTTP Server by selecting Control from the Oracle HTTP Server menu, and then selecting Start Up.

The mod_wl_ohs module configuration is saved and displayed on the mod_wl_ohs Configuration page.

Parent topic: Configuring the WLS OHS Plug-In Using Fusion Middleware Control

Using the Search Function

The search function allows you to search for a particular WebLogic Cluster or WebLogic Host that is available to the selected Oracle HTTP Server instance. By clicking the search icon Magnifying glass, you can see a list of clusters or servers available to the selected Oracle HTTP Server instance. To use the search function, do the following:

  1. Click the search icon for either WebLogic Cluster or WebLogic Host. The Select WebLogic Cluster/Server dialog box appears.
  2. Select the cluster or server you want to use and click OK.

The selected cluster or server name appears in the appropriate field.

Parent topic: Configuring the WLS OHS Plug-In Using Fusion Middleware Control

Using the AutoFill Function

Note:

The AutoFill function is available only if you are using Oracle WebLogic Server in Full-JRF mode. It is not available if you are using Restricted-JRF.

You can easily add valid WebLogic Server and endpoint locations for a specified Base URL to the Locations table on the Oracle WebLogic Server Proxy Plug-In Configuration screen by using the AutoFill button. To do so:

  1. Click Add to add a new location,
  2. Enter a location name in the Location field.
  3. Click AutoFill.

Data for any location of the same name will be updated and any new locations will be added to the table.

Parent topic: Configuring the WLS OHS Plug-In Using Fusion Middleware Control

Configuring the WLS OHS Plug-In Manually

When OHS has been configured in standalone mode, specify directives in the mod_wl_ohs.conf file to manually configure the WLS OHS Plug-In.

  1. Ensure that you have fulfilled the prerequisites listed in Preparing for Configuring the WLS OHS Plug-In.
  2. Open the mod_wl_ohs.conf file in a text editor.

    The mod_wl_ohs.conf file is located in the following directory:

    DOMAIN_HOME/config/fmwconfig/components/OHS/componentHome

  3. Add directives within the <IfModule weblogic_module> element in the configuration file.

    For examples, see Examples of <IfModule weblogic_module> Element Configurations.

    For information about the other directives that you can specify in the mod_wl_ohs.conf file, see Parameters for Oracle WebLogic Server Proxy Plug-Ins.

  4. Restart Oracle HTTP Server by using one of the techniques described in Starting Oracle HTTP Server in Administering Oracle HTTP Server.

Parent topic: Configuring the Plug-In for Oracle HTTP Server

Examples of <IfModule weblogic_module> Element Configurations

The configuration of the predefined <IfModule weblogic_module> element determines how requests are sent to Oracle WebLogic Server. These examples demonstrates the different ways in which you can configure this element.

Note:

Oracle recommends that you specify directives within the predefined <IfModule weblogic_module> element.

If you specify directives outside the predefined <IfModule weblogic_module> element, or in additional <IfModule weblogic_module> elements, or in configuration files other than mod_wl_ohs.conf, the Oracle WebLogic Server Proxy Plug-In might work, but the configuration state of the module, as displayed in Fusion Middleware Control, could be inconsistent with the directives specified in the mod_wl_ohs.conf configuration file.

To Forward Requests to a Single Oracle WebLogic Server Instance

To forward requests to an application running on a single Oracle WebLogic Server instance, specify the details of that destination server within a <location> element.

Syntax: 

<IfModule weblogic_module>
<Location path>
WLSRequest On
WebLogicHost host
WeblogicPort port
</Location>
</IfModule>

Example:

With the following configuration, requests for the /myapp1 URI received at the Oracle HTTP Server listen port will be forwarded to /myapp1 on the Oracle WebLogic Server with the listen port localhost:7001

<IfModule weblogic_module>
<Location /myapp1>
WLSRequest On
WebLogicHost localhost
WeblogicPort 7001
</Location>
</IfModule>

To Forward Requests to a Cluster of Oracle WebLogic Server Instances

To forward requests to an application running on a cluster of Oracle WebLogic Server instances, specify the details of that destination cluster within a new <location> element.

Syntax: 

<IfModule weblogic_module>
<Location path>
WLSRequest On
WebLogicCluster host:port,host:port,...
</Location>
</IfModule>

Example:

With the following configuration, requests for the /myapp2 URI received at the Oracle HTTP Server listen port will be forwarded to /myapp2 on the Oracle WebLogic Server cluster containing the Managed Servers with the listen ports localhost:8002 and localhost:8003. 

<IfModule weblogic_module>
<Location /myapp2>
WLSRequest On
WebLogicCluster localhost:8002,localhost:8003
</Location>
</IfModule>

To Configure Multiple Destinations

To configure multiple destinations—say, an application running on a single Oracle WebLogic Server instance and another application running on a cluster—you must specify each destination in a distinct <location> child element. All the <location> child elements should be at the same level within the <IfModule weblogic_module> element, as shown in the following syntax: 

<IfModule weblogic_module>
#For an application running on a single server instance
<Location path1>
WLSRequest On
WebLogicHost host
WeblogicPort port
</Location>

#For an application running on a cluster
<Location path2>
WLSRequest On
WebLogicCluster host:port,host:port,...
</Location>

</IfModule>

To Link to Managed Servers

To configure the WLS OHS Plug-In so that it can link to Managed Servers, for example to enable a high availability deployment of Oracle HTTP Server, edit the mod_wl_ohs.conf file as follows: 

<IfModule mod_weblogic.c>
      WebLogicCluster apphost1.mycompany.com:7050,apphost2.mycompany.com:7050
      MatchExpression *.jsp
 </IfModule>
  
<Location /weblogic>
  WLSRequest On
  WebLogicCluster apphost1.mycompany.com:7050,apphost2.com:7050
  DefaultFileName index.jsp
</Location>

Note:

If you are using SSL termination and routing requests to WebLogic Server, the following additional configuration is required.

In the WebLogic console, WebLogic Plugin Enabled must be set to true, either at the domain, cluster or Managed Server level.

In the Location block which directs requests to the WebLogic Managed Servers, one of the following lines also must be added.

WLProxySSL ON
WLProxySSLPassThrough ON

(To help determine which parameter to use, see SSL Parameters for Oracle WebLogic Server Proxy Plug-Ins.)

For example:

<Location /weblogic>
  WLSRequest On
  WebLogicCluster apphost1.mycompany.com:7050,apphost2.com:7050
  WLProxySSL On
  WLProxySSLPassThrough ON
  DefaultFileName index.jsp
</Location>

After enabling the WebLogic plugin, restart the Administration Server. See Terminating SSL Requests in Administering Oracle HTTP Server.

These examples show two different ways of routing requests to Oracle WebLogic Managed Servers:

  • The <IfModule> block sends any requests ending in *.jsp to the WebLogic Managed Server cluster located on Apphost1 and Apphost2.

  • The <Location> block sends any requests with URLs prefixed by /weblogic to the WebLogic Managed Server cluster located on Apphost1 and Apphost2.

To Configure One-way and Two-way SSL

For information about configuring the WLS OHS Plug-In to support one-way and two-way SSL between Oracle HTTP Server and Oracle WebLogic Server, see Using SSL with Proxy Plug-Ins.

Parent topic: Configuring the WLS OHS Plug-In Manually

Configuring IPv6 with Proxy Plug-Ins

The 14.1.2.0.0 WLS proxy plug-ins support IPv6. Specifically, the WebLogicHost and WebLogicCluster configuration parameters now support IPv6 addresses.

See WebLogicCluster and WebLogicHost.

For example:

<IfModule mod_weblogic.c>
 WebLogicHost [a:b:c:d:e:f]
 WebLogicPort 7002
 ...
</IfModule>

or

<IfModule mod_weblogic.c>
 WebLogicCluster [a:b:c:d:e:f]:<port>, [g:h:i:j:k:l]:<port>
 
 ....
</IfModule>

You can also use the IPv6 address mapped host name.

For example:
<IfModule mod_weblogic.c>  
#hostname1 is mapped to IPv6 address in /etc/hosts file
 WebLogicHost hostname1
 WebLogicPort 7002
 ...
</IfModule>
Sample entry in the /etc/hosts file:
127.0.0.1 localhost localhost.localdomain localhost4 localhost4.localdomain4
::1 localhost localhost.localdomain localhost6 localhost6.localdomain6
::1 hostname1

Note:

As of Windows 2008, the DNS server returns the IPv6 address in preference to the IPv4 address. If you are connecting to a Windows 2008 (or later) system using IPv4, the link-local IPv6 address format is tried first, which may result in a noticeable delay and reduced performance. To use the IPv4 address format, configure your system to instead use IP addresses in the configuration files or add the IPv4 addresses to the etc/hosts file.

In addition, you may find that, setting the DynamicServerList property to OFF in the configuration file also improves performance with IPv6. When set to OFF, the proxy plug-in ignores the dynamic cluster list used for load balancing requests proxied from the proxy plug-in and uses the static list specified with the WebLogicCluster parameter.

Parent topic: Configuring the Plug-In for Oracle HTTP Server

Next Steps After Installing the 14.1.2.0.0 WLS OHS Plug-In

After installing the 14.1.2.0.0 WLS OHS Plug-In, to use its new features, complete its configuration as follows.

This section includes the following topic:

Parent topic: Configuring the Plug-In for Oracle HTTP Server

About HTTP Header Case Handling

The WLS OHS Plug-In converts the case of HTTP headers based on the HTTP protocol version configured for the front-end and the back-end connections.

Table 2-1 shows how the case of request and response headers are modified based on the HTTP protocol version configured for the front-end and the back-end connections.

Table 2-1 Case of HTTP Request and Response Headers

HTTP Protocol Version for the Front-End Connection HTTP Protocol Version for the Back-End Connection Case of Request Header Sent to the Back End by the Oracle WebLogic Server Proxy Plug-In Case of Response Header Sent to the Client by the Oracle WebLogic Server Proxy Plug-In
HTTP/1.1 HTTP/1.1 No Conversion No Conversion

Parent topic: Next Steps After Installing the 14.1.2.0.0 WLS OHS Plug-In

Understanding WLS OHS Plug-In Performance Metrics

Oracle HTTP Server provides performance metrics specific to the WLS OHS Plug-In (mod_wl_ohs) module, where a request is proxied to the backend WebLogic Server.

These metrics are provided through the Oracle Dynamic Monitoring Service (DMS) which enables Oracle Fusion Middleware components to provide administration tools, such as Fusion Middleware Control, with data regarding the component's performance, state and on-going behavior. For the WLS OHS Plug-In module, for example, it could return the number of requests proxied, the number of failed requests, and other specific metrics. For more information on DMS, see Using the Oracle Dynamic Monitoring Service in Tuning Performance Guide.

Note:

The WLS OHS Plug-In module metrics are available only for Oracle HTTP Server and Apache Server plug-ins.

This section contains the following information on DMS metrics.

Parent topic: Configuring the Plug-In for Oracle HTTP Server

Configuring DMS Metrics for the WLS OHS Plug-In

The DMS metrics for the WLS OHS Plug-In are enabled by default in the admin.conf file. They are included as part of the regular DMS metrics collection.

Parent topic: Understanding WLS OHS Plug-In Performance Metrics

Viewing Performance Metrics for the WLS OHS Plug-In

You can view the performance metrics by using either the administration port, WLST commands, or Fusion Middleware Control. For details of each of the performance metrics, see DMS State Metrics, DMS Event Metrics, and DMS PhaseEvent Metrics.

Using the Administration Port:

If administration port is configured, for example, at 127.0.0.1:9999, then you can view the raw DMS metrics at the URL http://127.0.0.1/dms/.

The metrics under the section /WebLogicProxy [type=OHSWebLogic] are the metrics coming from WLS OHS Plug-In.

Using WLST (Collocated Mode Only)

Use the WLST command displayMetricTables to view performance metrics, for example: 

displayMetricTables(servertype="OHS", servers=<instancename>)

The metrics under the section /WebLogicProxy [type=OHSWebLogic] are the metrics coming from Oracle WebLogic Server Proxy Plug-in.

Using Fusion Middleware Control (Collocated Mode Only)

To view performance metrics in Fusion Middleware Control, select Oracle HTTP Server, then Monitoring, then Performance Summary. The metrics towards the bottom of this page will have WLS OHS Plug-In specific metrics. See Viewing Performance Metrics in Administering Oracle HTTP Server.

Parent topic: Understanding WLS OHS Plug-In Performance Metrics

DMS State Metrics

A State metric tracks system status information or to track a metric that is not associated with an event. For a description of the State metrics, see Table 3-4.

Table 2-2 State Metrics for the WLS OHS Plug-In Module

Metric Name Description

totalDeclines

The total number of requests declined (not processed by mod_wl_24). This number indicates the requests that are not configured, and/or rejected by the proxy plug-in (for example, custom HTTP methods are always rejected by the proxy plug-in)

totalErrors

Number of requests that could not be processed successfully. See Event Metrics for errors.

totalHandled

The total number of requests serviced by the mod_wl_24 proxy plug-in.

totalRequests

The total number of requests received by mod_wl_24. The number includes all the requests that are targeted to the proxy plug-in, plus the requests that are not targeted to any module (not configured).

totalRetries

Number of times a request was retried. Requests are generally retried on failure (depending on configuration). If a request is ever retried, this metric will increment (once per request, irrespective of how many times the request was retried).

totalSuccess

The number of requests successfully processed. If the requests are processed successfully (proxied to Oracle WebLogic Server, and sent the response back to client), then this metric will be incremented.

websocketActive

Number of WebSocket upgrade requests currently active.

websocketClose

Number of WebSocket upgrade requests closed. If the WebSocket session is terminated (for any reason), then this metric is updated.

websocketMax

Maximum number of simultaneous WebSocket requests that can be active.

If the WLMaxWebSocketClients parameter is configured, the value will be the lower of these:

  • The configured value, OR
  • 0.75 of the value of MaxRequestWorkers (Apache 2.4)

If WLMaxWebSocketClients parameter is not configured, the value will be 0.5 of the value of MaxRequestWorkers (Apache 2.4).

For more information about the WLMaxWebSocketClients parameter, see Tuning Oracle HTTP Server for High Throughput for WebSocket Upgrade Requests.

websocketPercent

This value is defined by the number of active WebSockets (websocketActive) divided by the maximum number of simultaneous WebSocket requests (websocketMax) multiplied by 100:

(websocketActive/webocketMax)*100.

websocketRequests

The number of WebSocket upgrade requests made. If the request URI is an WebSocket upgrade request, this metric will be incremented.

websocketSuccess

Number of WebSocket upgrade requests completed successfully. If Oracle WebLogic Server responds to a WebSocket upgrade request with 101 Switching Protocols, then this metric is updated.

Parent topic: Understanding WLS OHS Plug-In Performance Metrics

DMS Event Metrics

A DMS Event metric counts system events. A DMS event tracks system events that have a short duration, or where the duration of the event is not of interest but the occurrence of the event is of interest. For a description of the Event metrics, see Table 3-5.

Table 2-3 Event Metrics for the WLS OHS Plug-In.

Metric Name Description

errConnRefused

The number of CONNECTION_REFUSED errors. Indicates the number of times the configured WebLogicHost and/or WebLogicPort is either not reachable or not listening.

errNoResources

The number of NO_RESOURCES errors. One scenario where this exception can occur is when SSL is configured in the proxy plug-in, but the corresponding SSL configuration is not defined in the managed server.

errOthers

The number of any other errors. For example, POST data size is greater than the value of MaxPostSize.

errReadClient

The number of READ_ERROR_FROM_CLIENT errors. Indicates the number of times that the proxy plug-in could not read from the client (browser).

errReadServer

The number of READ_ERROR_FROM_SERVER errors. Indicates the number of times a read operation could not be successfully performed on Oracle WebLogic Server.

errReadTimeout

The number of READ_TIMEOUT errors. An example is Oracle WebLogic Server not responding within WLIOTimeoutSecs.

errWriteClient

The number of WRITE_ERROR_TO_CLIENT errors. Indicates the number of times that the proxy plug-in could not write to client. This can be seen when the client sends a request but closes the connection before receiving the response.

errWriteWLS

The number of WRITE_ERROR_TO_SERVER errors. Indicates the number of times that the proxy plug-in could not write to Oracle WebLogic Server.

wsClientClose

Number of WebSocket upgrade requests closed by client. If the client sends a WebSocket upgrade request, and client closes the connection, then this metric is updated.

wsErrorClose

Number of WebSocket sessions terminated due to error. If there is any error which causes the WebSocket connection to close, then this metric is updated.

wsNoUpgrade

The number of times the WebSocket upgrade request was rejected. The response to WebSocket upgrade request is not "101 Switching Protocols". This can happen when the upgrade request is sent to Oracle WebLogic Server that does not support WebSockets (Oracle WebLogic Server version 12.1.2 or earlier).

wsServerClose

Number of WebSocket upgrade requests closed by server. If Oracle WebLogic Server initiates a close of WebSocket communication, then this metric is updated. For example, timeout or no communication (by default, 5 minutes) after upgrading the request.

Parent topic: Understanding WLS OHS Plug-In Performance Metrics

DMS PhaseEvent Metrics

A DMS PhaseEvent metric measures the time spent in a specific section of code that has a beginning and an end. A PhaseEvent tracks time in a method or in a block of code. For each phase event, an "active count", "completed count", "total time", "min time", "max time", and "average time" value is included. For a description of the PhaseEvent metrics, see Table 3-6.

Table 2-4 PhaseEvent Metrics for the WLS OHS Plug-In

Metric Name Description

websocketPhase

WebSocket communication in progress. The phase (time) between "WebSocket upgrade succeeded" and "WebSocket connection closed"

wlsWait

The phase (time) between "the request sent to Oracle WebLogic Server" and "Waiting for response".

Parent topic: Understanding WLS OHS Plug-In Performance Metrics

Deprecated Directives for Oracle HTTP Server

The WebLogic Server plug-in logs for the WLS OHS Plug-In are now part of the Web Server error log mechanism. References can be identified with module name as weblogic.

For example:

[2015-05-14T00:43:27.8355-06:00] [OHS] [TRACE:16] [OH99999] [weblogic] [client_id: ::1] [host_id: XXXXXXXX] [host_addr: XX.XXX.XXX.XXX] [pid: 1240] [tid: 2424] [user: sramavan] [ecid: 00iT9hK4DrhFw0zobn063z0BvEE3zsYyk0000JO00000H] [rid: 0] [VirtualHost: main] ================New Request: [GET /favicon.ico HTTP/1.1] =================

The WLLogFile and Debug directives are deprecated. If the configuration uses these directives, the following note appears in the node manager plug-in log file (ohs_nm.log):

<2015-05-14 00:36:25> <INFO> <OHS-0> <[Thu May 14 00:36:25.723286 2015] [weblogic:warn] [pid 5084:tid 668] The Debug directive is ignored. The web server log level is used instead.>

<2015-05-14 00:36:25> <INFO> <OHS-0> <[Thu May 14 00:36:25.724263 2015] [weblogic:warn] [pid 5084:tid 668] The WLLogFile directive is ignored. The web server log file is used instead.>

To enable plug-in logs:

  • If OraLogMode is set to ODL-text, set OraLogSeverity to TRACE:16. The logs appear in the directory OraLogDir (instance-name.log). This is the default.

  • If OraLogMode is set to apache, set LogLevel to debug. The directive ErrorLog points to the file where the errors are logged.

See Managing Oracle HTTP Server Logs in Administering Oracle HTTP Server guide.

Parent topic: Configuring the Plug-In for Oracle HTTP Server