Oracle® Fusion Middleware Using Logging Services for Application Logging for Oracle WebLogic Server 11g Release 1 (10.3.6) E13704-05 November 2011 This document describes how you use WebLogic Server logging services to monitor application events. It describes WebLogic support for internationalization and localization of log messages, and shows you how to use the templates and tools provided with WebLogic Server to create or edit message catalogs that are locale-specific. Oracle Fusion Middleware Using Logging Services for Application Logging for Oracle WebLogic Server, 11g Release 1 (10.3.6) E13704-05 Copyright © 2007, 2011, Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Contents Preface ................................................................................................................................................................ vii Documentation Accessibility.................................................................................................................... vii Conventions ................................................................................................................................................ vii 1 Introduction and Roadmap 1.1 Document Scope and Audience................................................................................................ 1-1 1.2 Guide to This Document............................................................................................................ 1-1 1.3 Related Documentation.............................................................................................................. 1-2 1.4 Logging Samples and Tutorials ................................................................................................ 1-2 1.4.1 Avitek Medical Records Application (MedRec) and Tutorials..................................... 1-2 1.4.2 Logging Examples in the WebLogic Server Distribution .............................................. 1-3 1.4.3 Internationalizing Applications Using Simple Message Catalogs Example............... 1-3 1.5 New and Changed Features in This Release........................................................................... 1-3 2 Application Logging and WebLogic Logging Services 2.1 About WebLogic Logging Services .......................................................................................... 2-1 2.2 Integrating Application Logging with WebLogic Logging Services: Main Steps............. 2-2 2.3 Accessing the WebLogic Server Logger .................................................................................. 2-2 3 Internationalization and Localization for WebLogic Server 3.1 About Internationalization and Localization Standards....................................................... 3-1 3.2 Understanding Internationalization and Localization for WebLogic Server..................... 3-1 3.3 Understanding Message Catalogs............................................................................................ 3-2 3.4 Understanding Java Interfaces for Internationalization........................................................ 3-2 3.5 Main Steps for Creating an Internationalized Message ........................................................ 3-3 4 Using Message Catalogs with WebLogic Server 4.1 Overview of Message Catalogs................................................................................................. 4-1 4.2 Message Catalog Hierarchy....................................................................................................... 4-2 4.3 Guidelines for Naming Message Catalogs.............................................................................. 4-2 4.4 Using Message Arguments........................................................................................................ 4-3 4.5 Message Catalog Formats.......................................................................................................... 4-4 4.5.1 Example Log Message Catalog.......................................................................................... 4-4 4.5.2 Elements of a Log Message Catalog.................................................................................. 4-5 iii 4.5.2.1 message_catalog Element............................................................................................ 4-5 4.5.2.2 log_message Element................................................................................................... 4-6 4.5.2.3 Child Elements of log_message Element .................................................................. 4-8 4.5.3 Example Simple Text Catalog ............................................................................................ 4-9 4.5.4 Elements of a Simple Text Catalog.................................................................................... 4-9 4.5.4.1 message_catalog Element............................................................................................ 4-9 4.5.4.2 message Element ....................................................................................................... 4-10 4.5.4.3 messagebody Element .............................................................................................. 4-11 4.5.5 Example Locale-Specific Catalog.................................................................................... 4-11 4.5.6 Elements of a Locale-Specific Catalog ........................................................................... 4-12 4.5.6.1 locale_message_catalog Element............................................................................. 4-12 4.5.6.2 log_message Element................................................................................................ 4-12 4.5.6.3 Other locale_message_catalog Elements................................................................ 4-12 5 Writing Messages to the WebLogic Server Log 5.1 Using the I18N Message Catalog Framework: Main Steps................................................... 5-1 5.1.1 Create Message Catalogs .................................................................................................... 5-1 5.1.2 Compile Message Catalogs ................................................................................................ 5-2 5.1.3 Use Messages from Compiled Message Catalogs........................................................... 5-5 5.2