From 16b4d05ab194d40c62de5d68e365a4daa28dd868 Mon Sep 17 00:00:00 2001
From: lfrost <lfrost@localhost>
Date: Tue, 29 Jan 2008 07:08:43 +0000
Subject: [PATCH] Doc changes to Log Publisher Configuration docs and some copyright changes. Thanks to Daniel for the review.
---
opends/src/admin/defn/org/opends/server/admin/std/AccessLogPublisherConfiguration.xml | 13 +++-
opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml | 46 ++++++++++-----
opends/src/admin/defn/org/opends/server/admin/std/FileBasedDebugLogPublisherConfiguration.xml | 16 ++--
opends/src/admin/defn/org/opends/server/admin/std/LogPublisherConfiguration.xml | 4
opends/src/admin/defn/org/opends/server/admin/std/ErrorLogPublisherConfiguration.xml | 48 ++++++++++------
opends/src/admin/defn/org/opends/server/admin/std/DebugLogPublisherConfiguration.xml | 15 +++-
opends/src/admin/defn/org/opends/server/admin/std/FileBasedErrorLogPublisherConfiguration.xml | 10 +-
7 files changed, 95 insertions(+), 57 deletions(-)
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/AccessLogPublisherConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/AccessLogPublisherConfiguration.xml
index c63eb6c..9e95338 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/AccessLogPublisherConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/AccessLogPublisherConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="access-log-publisher"
plural-name="access-log-publishers"
@@ -36,6 +36,10 @@
are responsible for distributing access log messages from the access
logger to a destination.
</adm:synopsis>
+ <adm:description>
+ Access log messages provide information about the types of operations
+ processed by the server.
+ </adm:description>
<adm:profile name="ldap">
<ldap:object-class>
<ldap:name>ds-cfg-access-log-publisher</ldap:name>
@@ -66,7 +70,9 @@
</adm:property>
<adm:property name="suppress-internal-operations" advanced="true">
<adm:synopsis>
- Suppress access messages generated by internal operations.
+ Indicates whether internal operations (for example, operations
+ that are initiated by plugins) should be logged along with the
+ operations that are requested by users.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
@@ -85,7 +91,8 @@
<adm:property name="suppress-synchronization-operations"
advanced="true">
<adm:synopsis>
- Suppress access messages generated by synchronization operations.
+ Indicates whether access messages that are generated by
+ synchronization operations should be suppressed.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/DebugLogPublisherConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/DebugLogPublisherConfiguration.xml
index b6cb08a..4a10845 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/DebugLogPublisherConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/DebugLogPublisherConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="debug-log-publisher"
plural-name="debug-log-publishers"
@@ -36,6 +36,11 @@
are responsible for distributing debug log messages from the debug
logger to a destination.
</adm:synopsis>
+ <adm:description>
+ Debug log messages provide information that can be used for debugging
+ or troubleshooting problems in the server, or for providing more
+ detailed information about the processing that the server performs.
+ </adm:description>
<adm:profile name="ldap">
<ldap:object-class>
<ldap:name>ds-cfg-debug-log-publisher</ldap:name>
@@ -180,7 +185,7 @@
</adm:property>
<adm:property name="default-omit-method-entry-arguments">
<adm:synopsis>
- Property to indicate whether to include method arguments in debug
+ Indicates whether to include method arguments in debug
messages logged by default.
</adm:synopsis>
<adm:default-behavior>
@@ -201,7 +206,7 @@
</adm:property>
<adm:property name="default-omit-method-return-value">
<adm:synopsis>
- Property to indicate whether to include the return value in debug
+ Indicates whether to include the return value in debug
messages logged by default.
</adm:synopsis>
<adm:default-behavior>
@@ -220,7 +225,7 @@
</adm:property>
<adm:property name="default-include-throwable-cause">
<adm:synopsis>
- Property to indicate whether to include the cause of exceptions in
+ Indicates whether to include the cause of exceptions in
exception thrown and caught messages logged by default.
</adm:synopsis>
<adm:default-behavior>
@@ -239,7 +244,7 @@
</adm:property>
<adm:property name="default-throwable-stack-frames">
<adm:synopsis>
- Property to indicate the number of stack frames to include in the
+ Indicates the number of stack frames to include in the
stack trace for method entry and exception thrown messages.
</adm:synopsis>
<adm:default-behavior>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/ErrorLogPublisherConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/ErrorLogPublisherConfiguration.xml
index 9109c8f..6f58ef4 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/ErrorLogPublisherConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/ErrorLogPublisherConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="error-log-publisher"
plural-name="error-log-publishers"
@@ -36,6 +36,10 @@
are responsible for distributing error log messages from the error
logger to a destination.
</adm:synopsis>
+ <adm:description>
+ Error log messages provide information about any warnings, errors,
+ or significant events that are encountered during server processing.
+ </adm:description>
<adm:profile name="ldap">
<ldap:object-class>
<ldap:name>ds-cfg-error-log-publisher</ldap:name>
@@ -66,7 +70,7 @@
</adm:property>
<adm:property name="default-severity" multi-valued="true">
<adm:synopsis>
- Property to specify the default severity levels for the logger.
+ Specifies the default severity levels for the logger.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
@@ -79,12 +83,12 @@
<adm:enumeration>
<adm:value name="all">
<adm:synopsis>
- Messages of all severity levels will be logged.
+ Messages of all severity levels are logged.
</adm:synopsis>
</adm:value>
<adm:value name="none">
<adm:synopsis>
- No messages of any severity will be logged by default. This
+ No messages of any severity are logged by default. This
value is intended to be used in conjunction with the
override-severity property to define an error logger that
will publish no error message beside the errors of a given
@@ -93,7 +97,7 @@
</adm:value>
<adm:value name="fatal-error">
<adm:synopsis>
- The error log severity that will be used for messages that
+ The error log severity that is used for messages that
provide information about fatal errors which may force the
server to shut down or operate in a significantly degraded
state.
@@ -101,28 +105,28 @@
</adm:value>
<adm:value name="info">
<adm:synopsis>
- The error log severity that will be used for messages that
+ The error log severity that is used for messages that
provide information about significant events within the
server that are not warnings or errors.
</adm:synopsis>
</adm:value>
<adm:value name="mild-error">
<adm:synopsis>
- The error log severity that will be used for messages that
+ The error log severity that is used for messages that
provide information about mild (recoverable) errors
encountered during processing.
</adm:synopsis>
</adm:value>
<adm:value name="mild-warning">
<adm:synopsis>
- The error log severity that will be used for messages that
+ The error log severity that is used for messages that
provide information about mild warnings triggered during
processing.
</adm:synopsis>
</adm:value>
<adm:value name="notice">
<adm:synopsis>
- The error log severity that will be used for the most
+ The error log severity that is used for the most
important informational messages (i.e., information that
should almost always be logged but is not associated with a
warning or error condition).
@@ -130,21 +134,21 @@
</adm:value>
<adm:value name="severe-error">
<adm:synopsis>
- The error log severity that will be used for messages that
+ The error log severity that is used for messages that
provide information about severe errors encountered during
processing.
</adm:synopsis>
</adm:value>
<adm:value name="severe-warning">
<adm:synopsis>
- The error log severity that will be used for messages that
+ The error log severity that is used for messages that
provide information about severe warnings triggered during
processing.
</adm:synopsis>
</adm:value>
<adm:value name="debug">
<adm:synopsis>
- The error log severity that will be used for messages that
+ The error log severity that is used for messages that
provide debugging information triggered during processing.
</adm:synopsis>
</adm:value>
@@ -162,13 +166,13 @@
defaults to the default-severity. See issue 2503.
</adm:TODO>
<adm:synopsis>
- Property to specify the override severity levels for the logger
+ Specifies the override severity levels for the logger
based on the category of the messages.
</adm:synopsis>
<adm:description>
Each override severity level should include the category and the
- severity levels to log for that category. (i.e.,
- core=mild-error,info,mild-warning). Valid categories are: core,
+ severity levels to log for that category, for example,
+ core=mild-error,info,mild-warning. Valid categories are: core,
extensions, protocol, config, log, util, schema, plugin, jeb,
backend, tools, task, access-control, admin, sync, version,
quicksetup, admin-tool, dsconfig, user-defined. Valid severities
@@ -178,12 +182,20 @@
<adm:default-behavior>
<adm:alias>
<adm:synopsis>
- All messages with the default severity levels will be logged.
+ All messages with the default severity levels are logged.
</adm:synopsis>
</adm:alias>
</adm:default-behavior>
- <adm:syntax>
- <adm:string />
+ <adm:syntax>
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>STRING</adm:usage>
+ <adm:synopsis>
+ A string in the form category=severity1,severity2...
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml
index 86d5c0d..00b30bc 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="file-based-access-log-publisher"
plural-name="file-based-access-log-publishers"
@@ -51,7 +51,7 @@
</adm:property-override>
<adm:property name="asynchronous" mandatory="true" advanced="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
will publish records asynchronously.
</adm:synopsis>
@@ -74,7 +74,15 @@
The maximum number of log records that can be stored in the
asynchronous queue.
</adm:synopsis>
- <adm:default-behavior>
+ <adm:requires-admin-action>
+ <adm:other>
+ <adm:synopsis>
+ The <adm:user-friendly-name /> must be restarted if this property
+ is changed and the asynchronous property is set to true.
+ </adm:synopsis>
+ </adm:other>
+ </adm:requires-admin-action>
+ <adm:default-behavior>
<adm:defined>
<adm:value>5000</adm:value>
</adm:defined>
@@ -91,14 +99,22 @@
<adm:property name="log-file" mandatory="true">
<adm:synopsis>
The file name to use for the log files generated by the
- <adm:user-friendly-name />
- . The path to the file is relative to the server root.
+ <adm:user-friendly-name />.
+ The path to the file is relative to the server root.
</adm:synopsis>
<adm:requires-admin-action>
<adm:component-restart />
</adm:requires-admin-action>
- <adm:syntax>
- <adm:string />
+ <adm:syntax>
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>FILE</adm:usage>
+ <adm:synopsis>
+ A path to an existing file that is readable by the server.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
@@ -109,8 +125,7 @@
<adm:property name="log-file-permissions" mandatory="true">
<adm:synopsis>
The UNIX permissions of the log files created by this
- <adm:user-friendly-name />
- .
+ <adm:user-friendly-name />.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
@@ -123,7 +138,7 @@
<adm:regex>^([0-7][0-7][0-7])$</adm:regex>
<adm:usage>MODE</adm:usage>
<adm:synopsis>
- An valid UNIX mode string. The mode string must contain
+ A valid UNIX mode string. The mode string must contain
three digits between zero and seven.
</adm:synopsis>
</adm:pattern>
@@ -137,8 +152,8 @@
</adm:property>
<adm:property name="time-interval" advanced="true">
<adm:synopsis>
- Specifies the interval to check whether the log files need to be
- rotated.
+ Specifies the interval at which to check whether the log files
+ need to be rotated.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
@@ -175,7 +190,7 @@
Specifies whether to flush the writer after every log record.
</adm:synopsis>
<adm:description>
- If the asynchronous writes option is used, the writer will be
+ If the asynchronous writes option is used, the writer is
flushed after all the log records in the queue are written.
</adm:description>
<adm:default-behavior>
@@ -244,14 +259,13 @@
.
</adm:synopsis>
<adm:description>
- When multiple policies are used, log files will be cleaned when
+ When multiple policies are used, log files are cleaned when
any of the policy's conditions are met.
</adm:description>
<adm:default-behavior>
<adm:alias>
<adm:synopsis>
- No retention policy is used and log files will never be
- cleaned.
+ No retention policy is used and log files are never cleaned.
</adm:synopsis>
</adm:alias>
</adm:default-behavior>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedDebugLogPublisherConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedDebugLogPublisherConfiguration.xml
index 8f1586c..f599a9c 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedDebugLogPublisherConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedDebugLogPublisherConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="file-based-debug-log-publisher"
plural-name="file-based-debug-log-publishers"
@@ -51,7 +51,7 @@
</adm:property-override>
<adm:property name="asynchronous" mandatory="true" advanced="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
will publish records asynchronously.
</adm:synopsis>
@@ -126,7 +126,7 @@
<adm:regex>^([0-7][0-7][0-7])$</adm:regex>
<adm:usage>MODE</adm:usage>
<adm:synopsis>
- An valid UNIX mode string. The mode string must contain
+ A valid UNIX mode string. The mode string must contain
three digits between zero and seven.
</adm:synopsis>
</adm:pattern>
@@ -140,8 +140,8 @@
</adm:property>
<adm:property name="time-interval" advanced="true">
<adm:synopsis>
- Specifies the interval to check whether the log files need to be
- rotated.
+ Specifies the interval at which to check whether the log files
+ need to be rotated.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
@@ -178,7 +178,7 @@
Specifies whether to flush the writer after every log record.
</adm:synopsis>
<adm:description>
- If the asynchronous writes option is used, the writer will be
+ If the asynchronous writes option is used, the writer is
flushed after all the log records in the queue are written.
</adm:description>
<adm:default-behavior>
@@ -247,13 +247,13 @@
.
</adm:synopsis>
<adm:description>
- When multiple policies are used, log files will be cleaned when
+ When multiple policies are used, log files are cleaned when
any of the policy's conditions are met.
</adm:description>
<adm:default-behavior>
<adm:alias>
<adm:synopsis>
- No retention policy is used and log files will never be
+ No retention policy is used and log files are never
cleaned.
</adm:synopsis>
</adm:alias>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedErrorLogPublisherConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedErrorLogPublisherConfiguration.xml
index d1929d6..c5975e5 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedErrorLogPublisherConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedErrorLogPublisherConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="file-based-error-log-publisher"
plural-name="file-based-error-log-publishers"
@@ -51,7 +51,7 @@
</adm:property-override>
<adm:property name="asynchronous" mandatory="true" advanced="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
will publish records asynchronously.
</adm:synopsis>
@@ -126,7 +126,7 @@
<adm:regex>^([0-7][0-7][0-7])$</adm:regex>
<adm:usage>MODE</adm:usage>
<adm:synopsis>
- An valid UNIX mode string. The mode string must contain
+ A valid UNIX mode string. The mode string must contain
three digits between zero and seven.
</adm:synopsis>
</adm:pattern>
@@ -140,8 +140,8 @@
</adm:property>
<adm:property name="time-interval" advanced="true">
<adm:synopsis>
- Specifies the interval to check whether the log files need to be
- rotated.
+ Specifies the interval at which to check whether the log files
+ need to be rotated.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/LogPublisherConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/LogPublisherConfiguration.xml
index bc41a44..00f96e4 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/LogPublisherConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/LogPublisherConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="log-publisher" plural-name="log-publishers"
package="org.opends.server.admin.std" abstract="true"
@@ -43,7 +43,7 @@
</adm:profile>
<adm:property name="enabled" mandatory="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
is enabled for use.
</adm:synopsis>
--
Gitblit v1.10.0