You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by or...@apache.org on 2020/08/24 19:31:27 UTC

[qpid-broker-j] branch master updated: QPID-8368: [Broker-J] Update GraylogLogger section in broker documentation

This is an automated email from the ASF dual-hosted git repository.

orudyy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/qpid-broker-j.git


The following commit(s) were added to refs/heads/master by this push:
     new 6d75b73  QPID-8368: [Broker-J] Update GraylogLogger section in broker documentation
6d75b73 is described below

commit 6d75b73f617092b84de986a76e0b5616e6ae22dc
Author: Alex Rudyy <or...@apache.org>
AuthorDate: Mon Aug 24 20:30:54 2020 +0100

    QPID-8368: [Broker-J] Update GraylogLogger section in broker documentation
    
    The documentation clerarly states that Graylog integration depends on LGPL licenced library 'de.siegmar:logback-gelf'
---
 .../src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml  | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml
index a4ba2b8..eea35df 100644
--- a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml
+++ b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml
@@ -171,10 +171,17 @@
     <section xml:id="Java-Broker-Runtime-Logging-Loggers-GraylogLogger">
       <title>GraylogLogger</title>
       <para><emphasis>GraylogLogger</emphasis> - sends log messages to a Graylog server in
-        <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://docs.graylog.org/en/3.2/pages/gelf.html">GELF format</link> via TCP.
-        The hostname and port number of the Graylog server has to be configured. The content of the log messages is also configurable.</para>
-      <para>The Broker has to be built using option <code>-Dgraylog</code> to support Graylog logger, please visit
-        <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://github.com/apache/qpid-broker-j/blob/master/doc/developer-guide/src/main/markdown/build-instructions.md#maven-commands">build instructions</link>.
+        <link xmlns:xlink="http://www.w3.org/1999/xlink"
+              xlink:href="https://docs.graylog.org/en/3.2/pages/gelf.html">GELF format</link> via TCP.
+        The hostname and port number of the Graylog server has to be configured. The content of the log messages
+        is also configurable.</para>
+      <para>The logger is implemented on top of LGPL licenced library <literal>de.siegmar:logback-gelf</literal>.
+        The LGPL license is incompatible with Apache License. Thus, the Graylog integration module is not included
+        into standard broker distribution. It has to be built using option <code>-Dgraylog</code>. The built jar
+        <literal>org.apache.qpid:qpid-broker-plugins-graylog-logging-logback</literal> and
+        <literal>de.siegmar:logback-gelf</literal> jar should be copied manually under broker
+        <literal>lib</literal> folder. The broker restart is required to have <emphasis>GraylogLogger</emphasis>
+        available for the use.
       </para>
     </section>
   </section>


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org