{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Log files are an important window into the operations of a HiveMQ deployment. By default any extension(s) HiveMQ loads will log into ","type":"text"},{"text":"hivemq.log","type":"text","marks":[{"type":"em"}]},{"text":". This can lead to distracting lines when trying to inspect either HiveMQ’s regular log output or that of the extension(s).","type":"text"},{"type":"hardBreak"},{"text":"To get a clearer picture for each, it is often advisable to separate log output into different files. ","type":"text"}]},{"type":"paragraph","content":[{"text":"In this guide we will demonstrate the necessary steps by example of the ","type":"text"},{"text":"File RBAC Extension.","type":"text","marks":[{"type":"em"}]},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Prerequisites","type":"text"}]},{"type":"paragraph","content":[{"text":"It is assumed you have ","type":"text"},{"text":"installed","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.hivemq.com/extension/file-rbac-extension/#installation"}}]},{"text":" the file-rbac extension and received a notification of success.","type":"text"}]},{"type":"paragraph","content":[{"text":"For further information on the necessary steps, please consult the extensions current ","type":"text"},{"text":"documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/hivemq/hivemq-file-rbac-extension/blob/master/README.adoc"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Upon startup of the extension you should receive a notification, similar to the following:","type":"text"}]},{"type":"paragraph","content":[{"text":"INFO - Extension \"File Role Based Access Control Extension\" version 4.0.0 started successfully.","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"HiveMQ’s logging configuration is configured in ","type":"text"},{"text":"logback.xml","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"Here we must define and ","type":"text"},{"text":"appender","type":"text","marks":[{"type":"em"}]},{"text":", which will define our output file, rolling policy, and the log pattern to be used as well as our ","type":"text"},{"text":"logger","type":"text","marks":[{"type":"em"}]},{"text":" which will act as a filter as to which output gets received by the appender.","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"In the following example, our new log file will be named ","type":"text"},{"text":"file-rbac.log","type":"text","marks":[{"type":"code"}]},{"text":" and placed in the log directory.","type":"text"}]},{"type":"paragraph","content":[{"text":"The rollingPolicy will ensure the file does not grow to an unreasonable size, by replacing it every 30 days while compressing the previous month’s copy. ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"text":"\n ${hivemq.home}/log/file-rbac.log\n true\n \n %-30(%d [%thread]) - %level - %logger{32} - %msg%n%ex\n \n \n \n ${hivemq.home}/log/file-rbac.%d{yyyy-MM-dd}.log.gz\n \n 30\n \n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"The logger name must match the package name of the extension we wish to apply it to. ","type":"text"}]},{"type":"paragraph","content":[{"text":"appender-ref must match the name of our defined appender","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n\t\n\n","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"name=“com.hivemq.extensions.rbac”","type":"text","marks":[{"type":"code"}]},{"text":" must be modified to match the package of your custom extension","type":"text"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"In order to apply the new logging configuration, we will need to restart HiveMQ.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Verification","type":"text"}]},{"type":"paragraph","content":[{"text":"With this configuration in place, we should see a new file named ","type":"text"},{"text":"file-rbac.log","type":"text","marks":[{"type":"code"}]},{"text":" in our log directory.","type":"text"}]},{"type":"paragraph","content":[{"text":"Upon inspecting it we should now see our extensions startup message and all further messages produced by it","type":"text"}]},{"type":"paragraph","content":[{"text":"appear here. ","type":"text"}]}],"version":1}

Browser not supported