CR-6545 OPENDJ-1876 Log configuration commands no longer work

Mark Craig

07.11.2015 c55abef67771c28581176d945281b349f056dbea

CR-6545 OPENDJ-1876 Log configuration commands no longer work

This patch repairs the broken examples in the Admin Guide.

 opendj-sdk/opendj-server-legacy/src/main/docbkx/admin-guide/chap-samba.xml

@@ -9,8 +9,7 @@
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
@@ -20,15 +19,15 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2014 ForgeRock AS
  !      Copyright 2011-2015 ForgeRock AS.
  !    
-->
<chapter xml:id='chap-samba'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook
                     http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'>
         xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
         xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
         xsi:schemaLocation='http://docbook.org/ns/docbook
                             http://docbook.org/xml/5.0/xsd/docbook.xsd'
         xmlns:xlink='http://www.w3.org/1999/xlink'>
 <title>Samba Password Synchronization</title>
 <indexterm><primary>Samba</primary></indexterm>
 
@@ -177,6 +176,17 @@

   <screen>
$ <userinput>dsconfig \
 set-log-publisher-prop \
 --hostname opendj.example.com \
 --port 4444 \
 --bindDN "cn=Directory Manager" \
 --bindPassword password \
 --publisher-name "File-Based Debug Logger" \
 --set enabled:true \
 --no-prompt \
 --trustAll</userinput>

$ <userinput>dsconfig \
 create-debug-target \
 --port 4444 \
 --hostname opendj.example.com \
@@ -184,20 +194,11 @@
 --bindPassword password \
 --publisher-name "File-Based Debug Logger" \
 --target-name org.opends.server.plugins.SambaPasswordPlugin \
 --set debug-level:all \
 --trustAll \
 --no-prompt</userinput>

$ <userinput>dsconfig \
 set-log-publisher-prop \
 --port 4444 \
 --hostname opendj.example.com \
 --bindDN "cn=Directory Manager" \
 --bindPassword password \
 --publisher-name "File-Based Debug Logger" \
 --set enabled:true \
 --trustAll \
 --no-prompt</userinput>

$ <userinput>tail -f /path/to/opendj/logs/debug</userinput>
   </screen>
  </step>
 </procedure>

 opendj-sdk/opendj-server-legacy/src/main/docbkx/admin-guide/chap-troubleshooting.xml

@@ -9,8 +9,7 @@
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
@@ -20,7 +19,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2014 ForgeRock AS
  !      Copyright 2011-2015 ForgeRock AS.
  !    
-->
<chapter xml:id='chap-troubleshooting'
@@ -241,13 +240,9 @@
 --bindPassword password \
 --publisher-name "File-Based Debug Logger" \
 --set enabled:true \
 --set default-debug-level:all \
 --no-prompt \
 --trustAll</userinput>
    </screen>

    <para>You can set <literal>default-debug-level</literal> to a less verbose
    level if necessary.</para>
   </step>

   <step>
@@ -266,8 +261,8 @@
 --no-prompt \
 --trustAll</userinput>
<computeroutput>
Debug Target : debug-level : debug-category
-------------:-------------:---------------
Debug Target : enabled : debug-exceptions-only
-------------:---------:----------------------
</computeroutput>
$
    </screen>
@@ -286,7 +281,7 @@
 --publisher-name "File-Based Debug Logger" \
 --type generic \
 --target-name org.opends.server.api \
 --set debug-level:all \
 --set enabled:true \
 --no-prompt \
 --trustAll</userinput>
    </screen>
@@ -296,15 +291,32 @@
    <para>Restart OpenDJ to see debug messages in the log.</para>

    <screen>
$ <userinput>/path/to/opendj/bin/stop-ds --restart</userinput>
$ <userinput>stop-ds --restart</userinput>
...
$ <userinput>dsconfig \
 list-debug-targets \
 --hostname opendj.example.com \
 --port 4444 \
 --bindDN "cn=Directory Manager" \
 --bindPassword password \
 --publisher-name "File-Based Debug Logger" \
 --no-prompt \
 --trustAll</userinput>
<computeroutput>
Debug Target          : enabled : debug-exceptions-only
----------------------:---------:----------------------
org.opends.server.api : true    : false
</computeroutput>
$ <userinput>tail -f /path/to/opendj/logs/debug</userinput>
...
    </screen>

    <para>If you have set <literal>debug-level:all</literal>, OpenDJ generates
    a great deal of output in the debug log file. Use debug logging very
    sparingly on production systems.</para>
    <caution>
     <para>
      OpenDJ directory server can generate lots of debug output.
      Use debug logging very sparingly on production systems.
     </para>
    </caution>
   </step>
  </procedure>
 </section>