MFT logger.properties 文件

Managed File Transfer 记录器具有一组配置属性。 在 logger.properties 文件中指定这些属性,该文件位于 MQ_DATA_PATH/mqft/config/coordination_qmgr_name/loggers/logger_name 目录中。

IBM® WebSphere® MQ 7.5开始,可以在表示文件或目录位置的某些 Managed File Transfer 属性中使用环境变量。 这允许在运行产品的各个部分时使用的文件或目录位置因环境更改而变化,例如哪个用户在运行进程。 有关更多信息,请参阅 在 MFT 属性中使用环境变量

[Windows]注:Windows上指定文件路径时,反斜杠 (\) 分隔符必须显示为双反斜杠 (\\) (即转义)。 或者,您也可以将单个正斜杠字符 (/) 用作分隔符。 有关 Oracle的 Java 属性文件中字符转义的更多信息,请参阅 Javadoc 以获取 Properties 类

绑定方式连接属性

表 1. 绑定方式的连接属性
属性名 描述 缺省值
wmqfte.logger.type 正在使用的记录器类型:文件或数据库。 将该值设置为 FILEDATABASE 无缺省值
wmqfte.max.transaction.messages 落实事务之前在该事务中处理的消息的最大数目。 在循环日志记录方式下,队列管理器可用于实时数据的空间容量是固定的。 确保您将该属性设置为足够低的值,以便可用空间不会耗尽。 50
wmqfte.max.transaction.time 前后两次事务落实之间所经过的最大时间长度(毫秒)。 5000
wmqfte.max.consecutive.reject 可连续拒绝的最大消息数(即未遇到有效消息)。

如果超过该数量,那么记录器将认定问题不在于消息自身,而在于配置。 例如,如果您使数据库中某个代理名称列的宽度小于所有代理名称,那么引用代理的所有消息都将被拒绝。

50
wmqfte.reject.queue.name 记录器将自己无法处理的消息放置到的队列的名称。 如果您有数据库记录器,请参阅 MFT 记录器错误处理和拒绝 ,以获取可能将哪些消息放入此队列的详细信息。 SYSTEM.FTE.LOG.RJCT.logger_name
wmqfte.command.queue.name 记录器从中读取控制其行为的命令消息的队列的名称。 SYSTEM.FTE.LOG.CMD.logger_name
wmqfte.queue.manager 记录器连接到的队列管理器。 此参数是必需的,并且是与队列管理器的绑定方式连接所需要的所有参数。 (有关用于连接到远程队列管理器的属性,请参阅 表 2。) 无缺省值
wmqfte.message.source.type 以下某个值:
自动预订
缺省值。 记录器在 SYSTEM.FTE/Log/# 中定义的队列管理器上创建并使用其自己的持久的受管预订。 这是适合大多数场景的值。
管理预订
如果自动预订不适用,那么可以定义其他预订 (例如,使用 IBM MQ Explorer, MQSC 或 PCF) 并指示记录器使用该预订。 例如,使用该值将日志空间分区,以便一个记录器处理代理 A 到 H,另一个记录器处理 I 到 P,第三个记录器处理 Q 到 Z。
队列
如果 IBM MQ 拓扑表示不方便为记录器创建预订,那么可以改为使用队列。 配置 IBM MQ ,以便队列接收通常由 SYSTEM.FTE/Log/#。
自动预订
wmqfte.message.source.name 如果消息源类型是管理预订队列,那么使用预订或队列的名称。 如果源类型是自动预订,那么忽略该属性。 无缺省值
wmqfte.database.credentials.file 包含用于连接至数据库的用户名和密码的文件。

对于 IBM WebSphere MQ 7.5或更高版本,此属性的值可以包含环境变量。

有关更多信息,请参阅 MFT 凭证文件格式

[z/OS]有关创建认证凭证文件的详细信息,请参阅 z/OS® 上配置 MQMFTCredentials.xml

[UNIX、Linux、Windows]请参阅 配置 MQMFTCredentials.xml ,以获取有关此文件的位置和许可权的信息。

[UNIX、Linux、Windows]有关创建认证凭证文件的更多详细信息,请参阅 MFTIBM MQ 连接认证

wmqfte.database.driver 数据库的 JDBC 驱动程序类的位置。 这通常是 JAR 文件的路径和文件名。

[AIX]例如, AIX® 系统上 Db2® 的类型 2 驱动程序需要文件 /opt/IBM/db2/V9.5/java/db2jcc.jar

[Windows]Windows 系统上,将路径分隔符指定为正斜杠字符 (/) ,例如 C:/Program Files/IBM/SQLLIB/java/db2jcc.jar

[z/OS]z/OS上,指定 db2jcc.jar 文件的完整路径。 例如,wmqfte.database.driver=/db2/db2v10/jdbc/classes/db2jcc.jar

[z/OS]z/OS 系统上,必须引用以下所有 JAR 文件:
  • db2jcc.jar
  • db2jcc_license_cisuz.jar
  • db2jcc_javax.jar

如果数据库驱动程序包含多个 JAR 文件(例如,Db2 V9.1 需要一个驱动程序 JAR 文件和一个许可证 JAR 文件),请将所有这些 JAR 文件包含在此属性中。 使用针对您平台的类路径分隔符(即 Windows 系统上为分号字符 (;),其他平台上为冒号字符 (:))来分隔多个文件名。

无缺省值
wmqfte.database.exclude .duplicate.metadata 控制是否在元数据表中存储条目来包含可在数据库记录器模式内的其他表中找到的信息。 将此值设置为 truefalse。 缺省情况下,不再存储这些元数据条目,因为这与现有数据重复,因此会浪费数据库存储容量。 属性条目以及表(其中显示相同数据)如下所示:
  • com.ibm.wmqfte.SourceAgent TRANSFER_EVENT 或 CALL_REQUEST
  • com.ibm.wmqfte.DestinationAgent TRANSFER_EVENT
  • com.ibm.wmqfte.MqmdUser TRANSFER_EVENT 或 CALL_REQUEST
  • com.ibm.wmqfte.OriginatingUser TRANSFER_EVENT 或 CALL_REQUEST
  • com.ibm.wmqfte.OriginatingHost TRANSFER_EVENT 或 CALL_REQUEST
  • com.ibm.wmqfte.TransferId TRANSFER 或 CALL_REQUEST
  • com.ibm.wmqfte.JobName TRANSFER 或 CALL_REQUEST

将此属性的值设置为 false 会使这些元数据条目存储在元数据表中。

true
wmqfte.database.host

仅限 Db2 :

对于 IBM WebSphere MQ 7.5或更高版本,这是要使用类型 4 JDBC 驱动程序连接到的数据库服务器的主机名。 如果指定了此属性的值,那么也必须指定 wmqfte.database.port 的值。 如果这两个属性都没有定义,那么数据库记录器将使用缺省类型 2 JDBC 驱动程序进行连接。

如果指定了此属性的值,那么必须具有此记录器的凭证文件(文件路径由 wmqfte.database.credentials.file 属性定义),并且必须能够访问该文件以定义用于连接至数据库的用户名和密码,即使数据库位于本地系统上也是如此。

无缺省值
wmqfte.database.name 包含 Managed File Transfer 日志表的数据库实例 (或使用 Db2 for z/OS时的子系统) 的名称。 无缺省值
wmqfte.database.type

正在使用的数据库管理系统:Db2 或 Oracle。 将该值设置为 db2oracle

db2
wmqfte.database.port

仅限 Db2 :

对于 IBM WebSphere MQ 7.5或更高版本,这是要使用类型 4 JDBC 驱动程序连接到的数据库服务器的端口号。 如果指定了此属性的值,那么也必须指定 wmqfte.database.host 的值。 如果这两个属性都没有定义,那么数据库记录器将使用缺省类型 2 JDBC 驱动程序进行连接。

如果指定了此属性的值,那么必须具有此记录器的凭证文件(文件路径由 wmqfte.database.credentials.file 属性定义),并且必须能够访问该文件以定义用于连接至数据库的用户名和密码,即使数据库位于本地系统上也是如此。

无缺省值
wmqfte.database.schema

仅限 Db2 :

包含 Managed File Transfer 日志记录表的数据库模式。 在大多数情况下缺省值都适用,但您可能需要出于自身特定于站点的数据库考虑,指定其他值。

FTELOG
wmqfte.database.native.library.path 包含所选数据库驱动程序(如果有)所需的本机库的路径。

[AIX]例如, AIX 系统上 Db2 的类型 2 驱动程序需要来自 /opt/IBM/db2/V9.5/lib32/的库。 作为该属性的替代方案,您可以使用其他方法设置 java.library.path 系统属性。

[Solaris]Solaris上,在运行 fteStartLogger 命令之前,还必须设置并导出 LD_LIBRARY_PATH 环境变量以包含路径。

无缺省值
wmqfte.file.logger.fileDirectory 文件记录器日志文件所在的目录。 mqft/logs/coordination_dir/loggers/logger_name/logs
wmqfte.file.logger.fileSize 允许一个日志文件增大到的最大大小。 该大小值是大于零的正整数,后跟以下某个单位:KB、MB、GB、m(分钟)、h(小时)、d(天)、w(周)。 例如, wmqfte.file.logger.fileSize=5MB 指定最大文件大小为 5MB。 wmqfte.file.logger.fileSize=2d 指定最大文件大小为 2 天的数据。 10MB
wmqfte.file.logger.fileCount 要创建的日志文件的最大数目。 数据量超过此数目的文件中可以存储的最大量时,将删除最旧的文件,以便文件数从不超过指定的值。 3
wmqfte.file.logger.mode 正在使用的记录器方式:circular 或 linear。 将该值设置为 CIRCULARLINEAR
CIRCULAR - 文件记录器将信息写入文件,直至该文件达到其最大大小(使用 wmqfte.file.logger.fileSize 属性定义)。 达到最大大小时,文件记录器将启动新文件。 在该方式下写入了信息的文件的最大数量由使用 wmqfte.file.logger.fileCount 属性定义的值来控制。 达到该最大文件数时,文件记录器将删除首个文件并重新创建该文件以用作当前活动文件。 如果 wmqfte.file.logger.fileSize 属性中定义的值为固定大小的字节单位(例如,KB、MB 或 GB),那么该方式下使用的磁盘空间的上限等于 fileSize 乘以 fileCount。 如果 wmqfte.file.logger.fileSize 属性中定义的值为时间单位(例如,mhdw),那么最大大小将取决于这些时间段内系统中的日志消息吞吐量。 在该方式下运行时使用的日志文件命名约定为:logger_namenumber-timestamp.log,其中:
  • logger_name 是在 fteCreateLogger 命令中为记录器指定的名称。
  • number 是文件在集合内的编号。
  • timestamp 是创建文件时的时间戳记。

例如, LOGGER1-20111216123430147.log

LINEAR - 文件记录器将信息写入文件,直至该文件达到其最大大小(使用 wmqfte.file.logger.fileSize 属性定义)。 达到最大大小时,文件记录器将启动新文件。 先前已写入信息的文件将不会删除,从而允许将其保留为日志消息的历史记录。 在 linear 方式下运行时不会删除文件,从而将忽略 wmqfte.file.logger.fileCount 属性,这是因为可创建的文件数量没有上限。 因为在该方式下运行时没有上限,所以有必要跟踪日志文件所用的磁盘空间量以避免磁盘空间不足。 在该方式下运行时使用的日志文件命名约定为:logger_name-timestamp.log,其中:
  • logger_name 是在 fteCreateLogger 命令中为记录器指定的名称。
  • timestamp 是创建文件时的时间戳记。

例如, LOGGER-20111216123430147.log

无缺省值
wmqfte.max.retry.interval 记录器遇到持续性错误时,两次重试之间的最长时间(秒)。

某些错误情况(例如,丢失数据库连接)会使记录器无法继续运行。 当出现这种类型的情况时,记录器将回滚当前事务,等待一段时间,然后重试。 记录器等待的时间最初很短,这样短暂错误可以快速得以解决。 但是,记录器每次重试时,其等待的时间都会延长。 这可防止在错误情况持续较长时间时(例如,数据库关闭进行维护时)执行过多的不必要工作。

使用此属性可设置等待时间长度的限制,以便在解决错误情况的合理时间内进行重试。

600
[V9.1.3 2019 年 7 月]immediateShutdownTimeout [V9.1.3 2019 年 7 月]

记录器等待任何未完成的操作正常完成和关闭的时间 (以秒计)。 缺省情况下,记录器等待 10 秒以完成操作。 如果在超时之前未完成操作,那么记录器会将以下事件消息写入 output0.log 并结束:BFGDB0082I: The logger is ending immediately.

如果指定值为零,那么记录器将等待任何时间来完成当前操作。

如果 immediateShutdownTimeout 的值设置为小于零,那么将使用缺省值。

此属性同时适用于独立数据库记录器和文件类型记录器。

[V9.1.3 2019 年 7 月]10
loggerQMgrRetryInterval 记录器的进程控制器对队列管理器的可用性进行检查的时间间隔(秒)。 30
maxRestartCount 在 maxRestartInterval 属性值所指定的时间间隔内可发生的最大重新启动次数。 当超出该值时,记录器的进程控制器会停止重新启动记录器,而改为执行基于 maxRestartDelay 属性值的操作。 4
maxRestartInterval 一段时间间隔(秒),记录器的进程控制器度量此时间间隔内记录器的重新启动次数。 如果该时间间隔内的重新启动次数超过 maxRestartCount 属性的值,那么记录器的进程控制器会停止重新启动记录器。 记录器的进程控制器会改为执行基于 maxRestartDelay 属性值的操作。 120
maxRestartDelay 确定当记录器重新启动的频率超过 maxRestartCount 和 maxRestartInterval 属性值时,记录器的进程控制器的行为。 如果指定小于或等于零的值,那么记录器的进程控制器会停止。 如果指定大于零的值,那么这是重置记录器的进程控制器保存的重新启动历史记录信息并重新启动记录器之前等待的秒数。 -1
wmqfte.oracle.port 记录器用于连接到 Oracle 实例的端口。 此端口也称为 TNS 侦听器。 1521
wmqfte.oracle.host 记录器用于连接到 Oracle 实例的主机。 localhost
armELEMTYPE 可选属性。 如果 Automatic Restart Manager (ARM) 将记录器配置为重新启动,那么请将此属性设置为关联的 ARM 策略中指定的 ARM ELEMTYPE 参数值。 对于记录器,请将 ELEMTYPE 设置为 SYSBFGLG。 未设定
armELEMENT 可选属性。 如果 Automatic Restart Manager (ARM) 将记录器配置为重新启动,那么请将此属性设置为关联的 ARM 策略中指定的 ARM ELEMENT 参数值。 您可以将 ELEMENT 值设置为与记录器名称相对应。 未设定
loggerQMgrAuthenticationCredentialsFile 包含用于连接到记录器的协调队列管理器的 MQ 连接凭证的文件的路径。

[z/OS]有关创建认证凭证文件的详细信息,请参阅 z/OS 上配置 MQMFTCredentials.xml

[UNIX、Linux、Windows]请参阅 配置 MQMFTCredentials.xml ,以获取有关此文件的位置和许可权的信息。

[UNIX、Linux、Windows]有关创建认证凭证文件的更多详细信息,请参阅 MFTIBM MQ 连接认证

跟踪 可选属性。 要在记录器启动时启用跟踪的情况下运行记录器时的跟踪规范。 跟踪规范是以逗号分隔的类、等于字符以及跟踪级别列表。

例如,com.ibm.wmqfte.databaseloggercom.ibm.wmqfte.databaselogger.operation=all

您可以在冒号分隔的列表中指定多个跟踪规范。 例如,com.ibm.wmqfte.databaselogger=moderate:com.ibm.wmqfte.databaselogger.operation=all

None
traceFiles 可选属性。 保存的跟踪文件的总数。 该值适用于记录器的进程控制器以及记录器自身。 5
traceSize 可选属性。 将跟踪合并到下一个文件之前,每个跟踪文件的最大大小(MB)。 该值适用于记录器的进程控制器以及记录器自身。 20
[V9.1.4 Dec 2019]wmqfte.file.logger.filePermissions 可选属性。 用于指定记录器的日志文件所需的许可权类型。

该属性适用于线性和圆形原木,可取值 UserReadWriteOnlyUserReadWriteAllRead

UserReadWriteOnly的现有等效权限为600, UserReadWriteAllRead等效权限为644。

许可权中的任何更改都适用于新创建的记录器文件。

如果为属性输入值无效,那么记录器将采用缺省值并向输出日志发出消息 BFGDB0083W

UserReadWriteOnly
[V9.1.0 2018 年 7 月]

客户机方式连接属性

下表显示了支持到记录器队列管理器的客户机方式连接时需要的其他记录器属性。
表 2. 客户机方式的连接属性
属性名 描述 缺省值
wmqfte.queue.manager.host 记录器队列管理器的主机名或 IP 地址。 无缺省值
wmqfte.queue.manager.port 记录器队列管理器正在侦听的端口。 1414
wmqfte.queue.manager.channel 记录器队列管理器上服务器连接通道的名称。 SYSTEM.DEF.SVRCONN
wmqfte.Ssl.CipherSuite

指定记录器和记录器队列管理器交换数据方式的 TLS 方面。

wmqfte.Ssl.CipherSuite 的值为 CipherSuite 名称。 CipherSuite 名称将映射到记录器队列管理器通道中使用的 CipherSpec 名称。

有关更多信息,请参阅 CipherSuite 和 CipherSpec 名称映射

无缺省值
wmqfte.Ssl.PeerName 指定必须与记录器队列管理器提供的名称相匹配的专有名称框架。 专有名称用于检查连接时队列管理器提供的标识证书。 无缺省值
wmqfte.Ssl.TrustStore 指定记录器信任的证书的位置。 wmqfte.Ssl.TrustStore 的值为文件路径。

[Windows]如果文件路径是 Windows 文件路径,那么必须使用另一个反斜杠字符 (\\) 对反斜杠字符 (\) 进行转义。

请注意,此属性的值可以包含环境变量。

无缺省值
wmqfte.Ssl.TrustStoreCredentialsFile 包含 wmqfte.Ssl.TrustStore 凭证的文件的路径。

请注意,此属性的值可以包含环境变量。

无缺省值
wmqfte.Ssl.TrustStoreType 您要使用的 SSL 密钥库的类型。 支持 JKS 和 PKCS#12 密钥库。 该属性的值可以为 jks 或 pkcs12。 jks
wmqfte.Ssl.KeyStore 指定记录器的专用密钥的位置。 wmqfte.Ssl.KeyStore 的值是文件路径。

[Windows]如果文件路径是 Windows 文件路径,那么必须使用另一个反斜杠字符 (\\) 对反斜杠字符 (\) 进行转义。

请注意,此属性的值可以包含环境变量。

无缺省值
wmqfte.Ssl.KeyStore.CredentialsFile 包含 wmqfte.Ssl.KeyStore 凭证的文件的路径。

请注意,此属性的值可以包含环境变量。

无缺省值
wmqfte.Ssl.KeyStoreType 您要使用的 SSL 密钥库的类型。 支持 JKS 和 PKCS#12 密钥库。 该属性的值可以为 jks 或 pkcs12。 jks
wmqfte.Ssl.FipsRequired 指定要在记录器级别启用 FIPS 支持。 该属性的值可以为 true 或 false。 有关更多信息,请参阅 MFT 中的 FIPS 支持 false