Table 3-3 lists and defines the system events included in the core application programming interface (API).

Table 3-4 lists and describes the events that the SARM can issue.

Table 3-5 lists and describes the events that the Control server can issue.

Table 3-6 lists and describes the events that the NEP can issue.

To control the volume of log messages generated and written to the output destinations (the console and the WebLogic Server log file, which are referred to as Appenders by log4j), you assign severity levels to the various areas of the application that generate their own, discreet messages (these areas are referred to as Categories by log4j. If an event occurs inside a given category that triggers a message below the severity level assigned to the category (that is, less severe than the assigned level), log4j does not generate the message.

Example

If you assigned the severity level Warning to a given category, log4j does not generate any messages for that category that are flagged in the ASAP code as Debug or Info level messages. log4j will, however, generate all messages that are flagged as Warning, Error, and Fatal.

You can further control the number of messages written to the output destinations, or Appenders, by also assigning a severity level to them. When you assign a severity level to an Appender, it rejects messages below that severity level, even if log4j passes the message to it.

Example

If you configure the console to the Warning severity level, and one of the Categories is configured with the Info level, the console will not display the Info message, even though log4j generates the message and passes it on to the console, because the message's severity level falls below the threshold for which the Appender is configured. If, however, that same Category later generates an Error level message, the console will accept and display the message, because it carries a severity level equal to or higher than the console's threshold.

By default, the console and the WebLogic Server log file accept all error messages, from the least severe to the most severe.

The Levels

The following is an ascending list of the severity levels, starting with the least severe:

• Debug – (Least severe) Designates fine-grained informational events that are most useful to debug an application

• Info – Designates informational messages that highlight the progress of the application at coarse-grained level

• Warning – Designates potentially harmful situations

• Error – Designates error events that might still allow the application to continue running

• Fatal – (Most severe) Designates very severe error events that will presumably lead the application to terminate

There are two methods by which you can configure the severity levels:

• log4j.xml – The log4j.xml file is located in asap$ENV_ID.ear:APP-INF/lib/asaplibcommon.jar. This method allows you to modify the log4j configuration (like log message format, name of the log file, volume of the log files, how many are saved, and so on) and requires you to stop, then restart the servers before the changes will to take effect. For more information, see "Configuring the log4j.xml File."

• log4jAdmin – The log4jAdmin web page lets you to dynamically change the severity levels while the servers are running. The changes take effect immediately. As the changes are persisted to the database the severity levels remain at the new level when you restart the server. For more information, see "Using the log4jAdmin Web Page."

The logging levels configured in the database take precedence; all other configuration is controlled by the log4j.xml configuration file embedded inside asap$ENV_ID.ear:APP-INF/lib/asaplibcommon.jar.

Use this method to modify the log4j configuration as described in "Configuring the Severity Levels." To change the log4j configurations later, you must stop the server, modify the log4j.xml file, then restart the server. In most cases, therefore, if you need to modify the logging levels, you should use the log4jAdmin web page, as described in "Using the log4jAdmin Web Page."

There are two sections of the log4j.xml file that you need to look at when configuring this file:

• Appenders – This section defines the output destination for the messages. At installation, the Appenders section contains two entries:

  • Console – From this entry, you control the level of messages that the WebLogic Server Administration Console accepts.

  • WebLogic – From this entry, you control the level of messages that the WebLogic Server log file accepts.

• Categories – This section contains references to all of the ASAP categories that generate messages and gives you the ability to control the level of messages they generate.

To configure the log4j.xml file:

1. Unpack the asap.ear or the srt.ear file, depending on the application for which you are configuring logging parameters.

   • The asap.ear file is found in the $ASAP_BASE/lib directory. After the .ear file is unpacked, unpack APP-INF/lib/asaplibcommon.jar. The log4j.xml file is located in the root directory.

   • The srt.ear files is found in the $ASAP_BASE/SRT/lib directory. After the .ear file is unpacked, unpack APP-INF/lib/asaplibcommon.jar. The log4j.xml file is located in the root directory.

2. In the Appenders section of the log4j.xml file, search for the following string, which appears at the top of the Appenders section:

   <!-- Append messages to the console -->
   

   The Console entry governs what level of messages are written to the console.

3. If necessary, change the threshold level. By default, it is configured to DEBUG, allowing the console to display all messages sent to it. If you want to restrict the number of messages displayed, change the threshold entry to the severity level appropriate for your installation (see "Severity levels" above, for a description of the severity levels).

   In the example below, the level is changed from DEBUG to INFO.

   Before

   <param name="Threshold" value="DEBUG"/>

   After

   <param name="Threshold" value="INFO"/>
   

4. In the Appenders section, search for the following string:

   <!-- Append messages to the weblogic's log file-->
   

   The WebLogic Server log file entry governs what level of messages are written to the WebLogic Server log file.

5. If necessary, change the threshold level as described in Step 3.

6. Go to top of the file and search for the following string:

   category name
   

   This takes you to the first category entry in the file.

7. Review each of the categories in this section, changing the severity level where necessary. In the example below, the level is changed from INFO to WARNING.

   Before

   <category name="com.mslv.system"> <priority value="info"/> </category>
   

   After

   <category name="com.mslv.system"> <priority value="warning"/> </category>
   

8. When you finish updating the categories, save and close the log4j.xml file.

9. Repack the .ear file.

10. Redeploy the .ear file:

    • For Java Service Request Processor (JSRP):

      In $ASAP_BASE/lib, run the following commands:

      ModDeployDescriptor -u <WebLogic Admin Id>
      java weblogic.Deployer -adminurl http://$WLS_HOST:$WLS_PORT
      -user $WLS_USER -password $WLS_PASSWORD -name asap$ENV_ID -remove
      java weblogic.Deployer -adminurl http://$WLS_HOST:$WLS_PORT 
      -user $WLS_USER -password $WLS_PASSWORD -upload 
      -source $ASAP_BASE/lib/asap$ENV_ID.ear -name asap$ENV_ID 
      -targets $TARGET_WLS_SERVER -activate
      

    • For SRT:

      In $ASAP_BASE/SRT run the following commands:

      ant -f install.xml undeploy
      ant -f install.xml deploy

Use log4jAdmin web page to check the current logging levels or to change the logging levels dynamically.

The changes you make to the logging severity levels using this method are persisted to the database in the table tbl_code_list on the Control server.

You can use the Filter Loggers feature at the top of the page to check the logging level of specific categories or subcomponents. If you know the name of the category or subcomponent that you want to check, you can use the filter to display only that category, or related, categories.

To check logging levels:

1. Open the log4jAdmin web page by entering the following path in the browser's address line (the URLs are case sensitive):

   • JSRP:

     http://Weblogic_Host:WebLogic_PORT/ASAP_ENVID/log4jAdmin.jsp
     

     or

     https://Weblogic_Host:WLS_SSL_PORT/ASAP_ENVID/log4jAdmin.jsp
     

   • SRT:

     http://Weblogic_Host:WebLogic_PORT/ASAP_ENVID/SRT/log4jAdmin.jsp
     

     or

     https://Weblogic_Host:WLS_SSL_PORT/ASAP_ENVID/SRT/log4jAdmin.jsp
     

2. In the Filter Loggers field, enter the beginning of the name or a part of the name.

3. Do one of the following:

   • Click Begins With to filter on the beginning of the name.

   • Click Contains to filter on part of the name.

     The list displays the categories and subcategories that match the entry in the Filter Loggers field.

   • (Optional) To change the logging level do the following:

     1. Scan the entries in the left-hand column and find the category or sub-component which you want to change.

     2. Scan across the row to the severity levels. The level that currently is selected is highlighted in a different color from the other levels and appears in the Effective Level column.

     3. Click the logging level which you want to change:

        To change an entire category, click the category name.

        To change the subcomponent, click the sub-component name.

        The change takes place immediately.

     4. When you finish making the changes, close the page.

Configure the scrape job in Prometheus by updating the prometheus.yml file as follows:

scrape_configs:
  - job_name: 'asapmetrics'
    scrape_interval: 120s    
    scrape_timeout: 60s
    metrics_path: /ENV_ID/OrderMetrics
    scheme: http/https
    basic_auth:
      username: WebLogic user name
      password: WebLogic password
    static_configs:
      - targets: ['hostname:port number']
    tls_config:
      insecure_skip_verify: true 
    params:
         query: [all] 

The ASAP metrics can be viewed at:

http://hostname:port/ENVID/OrderMetrics

This only provides metrics of the server that is serving the request. It does not provide the consolidated metrics for the entire cluster. Only Prometheus Query and Grafana dashboards can provide the consolidated metrics.

ASAP metrics scraped by Prometheus can be made available for further processing and visualization. ASAP comes with sample Grafana dashboards to get you started with visualizations.

Import the dashboard JSON files from $ASAP_CNTK/samples/grafana into your Grafana environment. See ASAP Cloud Native Deployment Guide for more information.

Work order metrics can be queried with different parameter values. Use the following URL to query the work order metrics:

http://host:port/env_id/OrderMetrics?query=parameter

The following ASAP metrics are exposed via ASAP Servlet APIs.

Order Metrics

The following table lists the order metrics exposed.