[jira] [Created] (ARTEMIS-4177) Misleading documentation for "Logging the clients remote address"

["Dries Harnie (Jira)" <ji...@apache.org>]

Dries Harnie created ARTEMIS-4177:
-------------------------------------

             Summary: Misleading documentation for "Logging the clients remote address"
                 Key: ARTEMIS-4177
                 URL: https://issues.apache.org/jira/browse/ARTEMIS-4177
             Project: ActiveMQ Artemis
          Issue Type: Bug
          Components: Configuration, JAAS
    Affects Versions: 2.28.0, 2.27.1
            Reporter: Dries Harnie


In the [Logging chapter of the documentation|https://activemq.apache.org/components/artemis/documentation/latest/logging.html], there is the following section:
{quote}
h3. Logging the clients remote address

It is possible to configure the audit loggers to log the remote address of any calling clients either through normal clients or through the console and JMX. This is configured by enabling a specific login module in the login config file.

{{org.apache.activemq.artemis.spi.core.security.jaas.AuditLoginModule optional
       debug=false;}}
{quote}
This actually accomplishes nothing, for the following reason:

If you add this line to a block in login.conf and try to login to the broker, the Java {{LoginContext}} class will try to instantiate the class mentioned above using {{{}Class#newInstance{}}}. However, it is an interface (and has been for the past four years). It will thus throw an {{InstantiationException}} which is ignored because it is marked as an optional module.

I assume this is a leftover from earlier development, because several other login modules _do_ implement the AuditLoginModule interface.

Suggested fix is to remove this section entirely.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)