{"type":"doc","content":[{"type":"paragraph","content":[{"text":"By default, HiveMQ logs information to the ","type":"text"},{"text":"hivemq.log","type":"text","marks":[{"type":"code"}]},{"text":" file for each HiveMQ extension that you run. The additional entries can make it more difficult to evaluate information in the log output. The use of separate log files for your HiveMQ extensions can make it easier for you to efficiently monitor and troubleshoot your applications.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows you how to create a separate log file for the HiveMQ ","type":"text"},{"text":"MQTT Message Log Extension","type":"text","marks":[{"type":"em"}]},{"text":". The steps are similar for all HiveMQ extensions.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"emoji","attrs":{"id":"1f4d8","text":"\\uD83D\\uDCD8","shortName":":blue_book:"}},{"text":" Instructions","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Prerequisites","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An installed version of the HiveMQ MQTT Message Log Extension.","type":"text"},{"type":"hardBreak"},{"text":"For more information, see ","type":"text"},{"text":"MQTT Message Log Extension","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.hivemq.com/products/extensions/mqtt-message-log-extension/"}}]},{"text":" and ","type":"text"},{"text":"MQTT Message Log Extension GitHub repository","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/hivemq/hivemq-mqtt-message-log-extension"}}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"Once you have successfully installed the MQTT Message Log extension, a log entry similar to the following statement confirms your installation.","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"INFO - Extension \"HiveMQ Mqtt Message Log Extension\" version 1.1.3 started successfully.","type":"text"}]},{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Extension Log File Configuration","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"To create a separate log file for the extension, you must add an appropriately defined appender to the ","type":"text"},{"text":"logback.xml","type":"text","marks":[{"type":"code"}]},{"text":" of your HiveMQ configuration.","type":"text"}]},{"type":"paragraph","content":[{"text":"The additional appender and logger configurations specify the output file, rolling policy, log pattern, and logger that are used to log extension information.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following code example places a log file named ","type":"text"},{"text":"mqtt-message.log","type":"text","marks":[{"type":"code"}]},{"text":" in the ","type":"text"},{"text":"log","type":"text","marks":[{"type":"code"}]},{"text":" folder of your HiveMQ installation.","type":"text"}]},{"type":"paragraph","content":[{"text":"This configuration sets up a rolling file appender that writes logs to a file named ","type":"text"},{"text":"mqtt-message.log","type":"text","marks":[{"type":"code"}]},{"text":", rolls over to the next file when the maximum file size reaches 100MB, and keeps a fixed window of log files from index 1 to index 5. The rolled files are compressed and named with the pattern ","type":"text"},{"text":"mqtt-message.%date.%i.log.gz","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Example appender for MQTT Message Log extension log file configuration","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n ${hivemq.log.folder}/mqtt-message.log\n true\n \n %-30(%d %level)- %msg%n%ex\n \n \n ${hivemq.log.folder}/mqtt-message.%d{yyyy-MM-dd}.%i.log.gz\n 1\n 5\n \n \n 100MB\n 10000\n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example logger configuration adds the required logger.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example MQTT Message Log extension logger configuration","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"In the logger configuration, the ","type":"text"},{"text":"logger name","type":"text","marks":[{"type":"code"}]},{"text":" must match the ","type":"text"},{"text":"package name","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" of the associated extension and the ","type":"text"},{"text":"appender-ref","type":"text","marks":[{"type":"code"}]},{"text":" must match the name of the defined ","type":"text"},{"text":"appender","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]}]},{"type":"orderedList","attrs":{"order":4},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Extension Log File Verification","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"To verify creation of the extension log file, go to the ","type":"text"},{"text":"log","type":"text","marks":[{"type":"code"}]},{"text":" folder of your HiveMQ installation. Based on the ","type":"text"},{"text":"scanPeriod","type":"text","marks":[{"type":"code"}]},{"text":" that is set in the ","type":"text"},{"text":"logback.xml","type":"text","marks":[{"type":"code"}]},{"text":" file in your ","type":"text"},{"text":"conf","type":"text","marks":[{"type":"code"}]},{"text":" folder, HiveMQ scans the changes and updates your configuration. If you have disabled automatic scanning (","type":"text"},{"text":"scan=false","type":"text","marks":[{"type":"code"}]},{"text":"), you must restart HiveMQ to apply the changes.","type":"text"}]},{"type":"paragraph","content":[{"text":"Look for a new file named ","type":"text"},{"text":"mqtt-message.log","type":"text","marks":[{"type":"code"}]},{"text":" in the ","type":"text"},{"text":"log","type":"text","marks":[{"type":"code"}]},{"text":" directory.","type":"text"}]},{"type":"paragraph","content":[{"text":"Open the ","type":"text"},{"text":"mqtt-message.log","type":"text","marks":[{"type":"code"}]},{"text":" file and confirm that an extension start entry or other INFO entries are visible.","type":"text"}]},{"type":"codeBlock","content":[{"text":"INFO - HiveMQ MQTT Message Log Extension: Will try to read config properties from mqttMessageLog.properties\nINFO - HiveMQ MQTT Message Log Extension: Properties initialized to: {subscribe-received=true, pubcomp-send=true, unsuback-send=true, topic-regex=, client-regex=, pubcomp-received=true, client-disconnect=true, puback-received=true, connack-send=true, publish-send=true, suback-send=true, unsubscribe-received=true, pubrec-send=true, pubrec-received=true, verbose=false, ping-request-received=true, pubrel-send=true, client-connect=true, publish-received=true, ping-response-send=true, puback-send=true, pubrel-received=true}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"emoji","attrs":{"id":"1f4cb","text":"\\uD83D\\uDCCB","shortName":":clipboard:"}},{"text":" Related articles","type":"text"}]},{"type":"paragraph","content":[{"type":"placeholder","attrs":{"text":"The content by label feature automatically displays related articles based on labels you choose. To edit options for this feature, select the placeholder and tap the pencil icon."}}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"contentbylabel","parameters":{"macroParams":{"showLabels":{"value":"false"},"max":{"value":"5"},"spaces":{"value":"com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@d1770c07"},"showSpace":{"value":"false"},"sort":{"value":"modified"},"type":{"value":"page"},"reverse":{"value":"true"},"labels":{"value":"kb-how-to-article"},"cql":{"value":"label in ( \"extension\" , \"extennsions\" ) and type = \"page\" and space = \"~131801395\""}},"macroMetadata":{"macroId":{"value":"8ab4a2f2-1c97-45f7-9bd4-60ef943d5bf2"},"schemaVersion":{"value":"4"},"title":"List by label (Content by label)"}},"localId":"0e88366d-f7d8-46fd-b88c-fce46a31734f"}}],"version":1}

Browser not supported