4.18. 为代理配置日志记录

流程

1. 准备包含您要与 AMQ Broker 搭配使用的 log4j 2 配置的文件。

   代理使用的默认 Log4j 2 配置文件位于每个代理 Pod 上的 /home/jboss/amq-broker/etc/log4j2.properties 文件中。您可以使用默认配置文件的内容作为在 secret 或 configMap 中创建新的 Log4j 2 配置的基础。要获取默认 Log4j 2 配置文件的内容，请完成以下步骤。

   1. 使用 OpenShift Container Platform Web 控制台：

      1. 单击 Workloads Pods。
      2. 点 ex-aao-ss Pod。
      3. 点击 Terminal 选项卡。
      4. 使用 cat 命令显示代理 Pod 上 /home/jboss/amq-broker/etc/log4j2.properties 文件的内容并复制其内容。
      5. 将内容粘贴到安装 OpenShift Container Platform CLI 的本地文件中，并将文件保存为 logging.properties。

   2. 使用 OpenShift 命令行界面：

      1. 获取部署中的 Pod 的名称。

         $ oc get pods -o wide
         
         NAME                          STATUS   IP
         amq-broker-operator-54d996c   Running  10.129.2.14
         ex-aao-ss-0                   Running  10.129.2.15

         Copy to Clipboard Toggle word wrap

      2. 使用 oc cp 命令将日志配置文件从 Pod 复制到您的本地目录。

         $ oc cp <pod name>:/home/jboss/amq-broker/etc/log4j2.properties logging.properties -c <name>-container

         Copy to Clipboard Toggle word wrap

         其中，容器名称的 <name> 部分是 Pod 名称的 -ss 字符串前的前缀。例如：

         $ oc cp ex-aao-ss-0:/home/jboss/amq-broker/etc/log4j2.properties logging.properties -c ex-aao-container

         Copy to Clipboard Toggle word wrap
         注意

         从文件创建 configMap 或 secret 时，configMap 或 secret 中的键默认为文件名，值默认为文件内容。从名为 logging.properties 的文件创建 secret，新日志记录配置所需的密钥会插入到 secret 或 configMap 中。

2. 编辑 logging.properties 文件，并创建您要与 AMQ Broker 搭配使用的 Log4j 2 配置。

   例如，在使用默认配置时，AMQ Broker 只会将信息记录到控制台。您可能想要更新配置，以便 AMQ Broker 也会将信息记录到磁盘。

3. 将更新的 Log4j 2 配置添加到 secret 或 ConfigMap 中。

   1. 以具有在项目中为代理部署创建 secret 或 ConfigMap 的用户身份登录 OpenShift。

      oc login -u <user> -p <password> --server=<host:port>

      Copy to Clipboard Toggle word wrap

   2. 如果要在 secret 中配置日志设置，请使用 oc create secret 命令。例如：

      oc create secret generic newlog4j-logging-config --from-file=logging.properties

      Copy to Clipboard Toggle word wrap

   3. 如果要在 ConfigMap 中配置日志设置，请使用 oc create configmap 命令。例如：

      oc create configmap newlog4j-logging-config --from-file=logging.properties

      Copy to Clipboard Toggle word wrap

      configMap 或 secret 名称必须具有 -logging-config 的后缀，因此 Operator 可以识别 secret 包含新的日志记录配置。

4. 将 secret 或 ConfigMap 添加到代理部署的自定义资源(CR)实例中。

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权的用户身份登录 OpenShift，以便在代理部署的项目中部署 CR。

         oc login -u <user> -p <password> --server=<host:port>

         Copy to Clipboard Toggle word wrap

      2. 编辑 CR。

          oc edit ActiveMQArtemis <CR instance name> -n <namespace>

         Copy to Clipboard Toggle word wrap

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以具有特权的用户身份登录控制台，以便在代理部署的项目中部署 CR。
      2. 在左侧窗格中，点 Operators Installed Operator。
      3. 点 Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) operator。
      4. 点 AMQ Broker 选项卡。
      5. 单击 ActiveMQArtemis 实例名称的名称

      6. 点 YAML 标签。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

   3. 将包含 Log4j 2 日志记录配置的 secret 或 configMap 添加到 CR。以下示例显示了一个 secret，并在 CR 中添加 configMap。

      apiVersion: broker.amq.io/v1beta1
      kind: ActiveMQArtemis
      metadata:
        name: ex-aao
      spec:
        deploymentPlan:
          ...
          extraMounts:
            secrets:
            - "newlog4j-logging-config"
          ...

      Copy to Clipboard Toggle word wrap

      apiVersion: broker.amq.io/v1beta1
      kind: ActiveMQArtemis
      metadata:
        name: ex-aao
      spec:
        deploymentPlan:
          ...
          extraMounts:
            configMaps:
            - "newlog4j-logging-config"
          ...

      Copy to Clipboard Toggle word wrap
5. 保存 CR。