8.12. 为可引导 JAR 启用 JSON 日志记录

流程

1. 将由 BOM 管理的 JBoss Logging 和 Jakarta RESTful Web Services 依赖项添加到项目的 pom.xml 文件的 <dependencies> 部分。例如：

   <dependencies>
       <dependency>
           <groupId>org.jboss.logging</groupId>
           <artifactId>jboss-logging</artifactId>
           <scope>provided</scope>
       </dependency>
       <dependency>
           <groupId>org.jboss.spec.javax.ws.rs</groupId>
           <artifactId>jboss-jaxrs-api_2.1_spec</artifactId>
           <scope>provided</scope>
       </dependency>
   </dependencies>

   Copy to Clipboard Toggle word wrap

2. 将以下内容添加到 pom.xml 文件的 <build> 元素 中。您必须指定任何 Maven 插件的最新版本，以及 org.jboss.eap:wildfly-galleon-pack Galleon 功能包的最新版本。例如：

   <plugins>
       <plugin>
           <groupId>org.wildfly.plugins</groupId>
           <artifactId>wildfly-jar-maven-plugin</artifactId>
           <version>${bootable.jar.maven.plugin.version}</version>
           <configuration>
               <feature-packs>
                   <feature-pack>
                       <location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</location>
                   </feature-pack>
               </feature-packs>
               <layers>
                   <layer>jaxrs-server</layer>
                </layers>
           </configuration>
           <executions>
               <execution>
                   <goals>
                       <goal>package</goal>
                   </goals>
               </execution>
           </executions>
       </plugin>
   </plugins>

   Copy to Clipboard Toggle word wrap

3. 创建用于存储 Java 文件的目录：

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/logging/

   Copy to Clipboard Toggle word wrap

   其中 APPLICATION_ROOT 是含有应用的 pom.xml 配置文件的目录。

4. 创建包含以下内容的 Java 文件 RestApplication.java，并将该文件保存到 APPLICATION_ROOT/src/main/java/com/example/logging/ 目录中：

   package com.example.logging;
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/")
   public class RestApplication extends Application {
   }

   Copy to Clipboard Toggle word wrap

5. 创建包含以下内容的 Java 文件 HelloWorldEndpoint.java，并将该文件保存到 APPLICATION_ROOT/src/main/java/com/example/logging/ 目录中：

   package com.example.logging;
   
   import javax.ws.rs.Path;
   import javax.ws.rs.core.Response;
   import javax.ws.rs.GET;
   import javax.ws.rs.Produces;
   
   import org.jboss.logging.Logger;
   @Path("/hello")
   public class HelloWorldEndpoint {
   
       private static Logger log = Logger.getLogger(HelloWorldEndpoint.class.getName());
       @GET
       @Produces("text/plain")
       public Response doGet() {
           log.debug("HelloWorldEndpoint.doGet called");
           return Response.ok("Hello from XP bootable jar!").build();
       }
   }

   Copy to Clipboard Toggle word wrap

6. 创建 CLI 脚本，如 logging.cli，并将它保存在可引导 JAR 中的可访问目录中，如 APPLICATION_ROOT/scripts 目录，其中 APPLICATION_ROOT 是 Maven 项目的根目录。该脚本必须包含以下命令：

   /subsystem=logging/logger=com.example.logging:add(level=ALL)
   /subsystem=logging/json-formatter=json-formatter:add(exception-output-type=formatted, pretty-print=false, meta-data={version="1"}, key-overrides={timestamp="@timestamp"})
   /subsystem=logging/console-handler=CONSOLE:write-attribute(name=level,value=ALL)
   /subsystem=logging/console-handler=CONSOLE:write-attribute(name=named-formatter, value=json-formatter)

   Copy to Clipboard Toggle word wrap

7. 将以下配置提取添加到插件 <configuration> 元素中：

   <cli-sessions>
           <cli-session>
           <script-files>
               <script>scripts/logging.cli</script>
           </script-files>
       </cli-session>
   </cli-sessions>

   Copy to Clipboard Toggle word wrap

   本例显示了 logging.cli CLI 脚本，该脚本修改服务器日志配置文件，以为您的应用启用 JSON 日志记录。

8. 将应用打包为可引导 JAR。

   $ mvn package

   Copy to Clipboard Toggle word wrap

9. 可选 ： 要在 JBoss EAP 裸机平台上运行应用，请按照在 JBoss EAP 裸机平台上使用可引导 JAR 中所述的步骤进行操作， 但会有以下差异：

   1. 启动应用程序：

      mvn wildfly-jar:run

      Copy to Clipboard Toggle word wrap

   2. 验证：您可以通过在浏览器中指定以下 URL 来访问应用 ：

      预期输出：您可以在应用程序控制台中查看 JSON 格式的日志，包括 com.example.logging.HelloWorldEndpoint 调试追踪。

10. 可选 ： 要在 JBoss EAP OpenShift 平台上运行应用程序，请完成以下步骤：

    1. 在插件配置中添加 <cloud/> 元素。例如：

       <plugins>
          <plugin>
              ... <!-- You must evolve the existing configuration with the <cloud/> element  -->
              <configuration >
                  ...
                  <cloud/>
               </configuration>
           </plugin>
       </plugins>

       Copy to Clipboard Toggle word wrap

    2. 重新构建应用程序：

       $ mvn clean package

       Copy to Clipboard Toggle word wrap
    3. 使用 oc login 命令登录 您的 OpenShift 实例。

    4. 在 OpenShift 中创建新项目：例如：

       $ oc new-project bootable-jar-project

       Copy to Clipboard Toggle word wrap

    5. 输入以下 oc 命令来创建应用程序镜像：

       $ mkdir target/openshift && cp target/logging-bootable.jar target/openshift 

       1

       
       
       $ oc import-image ubi8/openjdk-11 --from=registry.redhat.io/ubi8/openjdk-11 --confirm
        

       2

       
       
       $ oc new-build --strategy source --binary --image-stream openjdk-11 --name logging 

       3

       
       
       $ oc start-build logging --from-dir target/openshift 

       4

       Copy to Clipboard Toggle word wrap

       1

       创建 target/openshift 子目录。打包的应用复制到 openshift 子目录中。

       2

       将最新的 OpenJDK 11 镜像流标签和镜像信息导入到 OpenShift 项目中。

       3

       根据日志记录目录和 OpenJDK 11 镜像流创建构建配置。

       4

       使用 target/openshift 子目录作为二进制输入来构建应用。

    6. 部署应用程序：

       $ oc new-app logging
       
       $ oc expose svc/logging

       Copy to Clipboard Toggle word wrap

    7. 获取路由的 URL。

       $ oc get route logging --template='{{ .spec.host }}'

       Copy to Clipboard Toggle word wrap

    8. 使用上一命令返回的 URL 访问 Web 浏览器中的应用。例如：

       http://ROUTE_NAME/hello

       Copy to Clipboard Toggle word wrap

    9. 验证： 运行以下命令来查看可用的 OpenShift pod 列表，并检查 pod 构建状态：

       $ oc get pods

       Copy to Clipboard Toggle word wrap

       访问应用的正在运行的容器集日志。其中 APP_POD_NAME 是正在运行的容器集日志记录应用程序的名称。

       $ oc logs APP_POD_NAME

       Copy to Clipboard Toggle word wrap

       预期结果：pod 日志采用 JSON 格式，包括 com.example.logging.HelloWorldEndpoint 调试追踪。