OTP-8395: Sequence number in Audit Trail Logs.

4 files changed, 90 insertions, 18 deletions

diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml
index 96a444227d..7984f2a536 100644
--- a/lib/snmp/doc/src/notes.xml
+++ b/lib/snmp/doc/src/notes.xml
@@ -4,7 +4,7 @@
 <chapter>
   <header>
     <copyright>
-      <year>1996</year><year>2009</year>
+      <year>1996</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -13,12 +13,12 @@
       compliance with the License. You should have received a copy of the
       Erlang Public License along with this software. If not, it can be
       retrieved online at http://www.erlang.org/.
-    
+
       Software distributed under the License is distributed on an "AS IS"
       basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
       the License for the specific language governing rights and limitations
       under the License.
-    
+
     </legalnotice>
 
     <title>SNMP Release Notes</title>
@@ -33,6 +33,59 @@
   </header>
 
   <section>
+    <title>SNMP Development Toolkit 4.16</title>
+    <p>Version 4.16 supports code replacement in runtime from/to
+      version 4.15, 4.14 and 4.13.5.</p>
+
+    <section>
+      <title>Improvements and new features</title>
+      <!-- 
+      <p>-</p> 
+      -->
+      <list type="bulleted">
+        <item>
+          <p>[agent|manager] Entries in the audit trail log can now be 
+            augmented by a sequence number. </p>
+          <p>This is enabled by the <c>seqno</c> option, which is part of the 
+            <seealso marker="snmp_config#audit_trail_log">Audit Trail Log</seealso> 
+            config option. </p>
+          <p>See the 
+            <seealso marker="snmp_app#configuration_params">reference manual</seealso> 
+            or the 
+            <seealso marker="snmp_config#configuration_params">Configuring the application</seealso> 
+            chapter of the User's Guide for further info. </p> 
+
+          <p>Own Id: OTP-8395</p>
+        </item>
+
+      </list>
+
+    </section>
+
+    <section>
+      <title>Reported Fixed Bugs and Malfunctions</title>
+      <p>-</p>
+
+      <!-- 
+      <list type="bulleted">
+        <item>
+          <p>TBD. </p>
+          <p>Own Id: OTP-8384</p>
+        </item>
+
+      </list>
+      -->
+
+    </section>
+
+    <section>
+      <title>Incompatibilities</title>
+      <p>-</p>
+    </section>
+  </section> <!-- 4.16 -->
+
+
+  <section>
     <title>SNMP Development Toolkit 4.15</title>
 
     <p>Version 4.15 supports code replacement in runtime from/to
diff --git a/lib/snmp/doc/src/snmp_app.xml b/lib/snmp/doc/src/snmp_app.xml
index 460f0b8018..e5a725d720 100644
--- a/lib/snmp/doc/src/snmp_app.xml
+++ b/lib/snmp/doc/src/snmp_app.xml
@@ -4,7 +4,7 @@
 <appref>
   <header>
     <copyright>
-      <year>1997</year><year>2009</year>
+      <year>1997</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -13,12 +13,12 @@
       compliance with the License. You should have received a copy of the
       Erlang Public License along with this software. If not, it can be
       retrieved online at http://www.erlang.org/.
-    
+
       Software distributed under the License is distributed on an "AS IS"
       basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
       the License for the specific language governing rights and limitations
       under the License.
-    
+
     </legalnotice>
 
     <title>snmp</title>
@@ -78,11 +78,11 @@
       ].
     </pre>
 
+    <!-- The info below is also found in the snmp_config.xml file -->
+
     <p>Each snmp component has it's own set of configuration parameters, 
       even though some of the types are common to both components. </p>
 
-    <!-- Also in snmp_config.xml -->
-
     <pre>
       snmp_components_config() -> [snmp_component_config()]
       snmp_component_config() -> {agent, agent_options()} | {manager, manager_options()}
@@ -642,10 +642,13 @@
           process performs a GC to remove the expired note's. Time in
           milli-seconds.</p>
         <p>Default is <c>30000</c>.</p>
+
+      <marker id="audit_trail_log"></marker>
       </item>
+
       <tag><c><![CDATA[audit_trail_log() = [audit_trail_log_opt()] <optional>]]></c></tag>
       <item>
-        <p><c>audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} |  {size, atl_size()} |  {repair, atl_repair()}</c></p>
+        <p><c>audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} |  {size, atl_size()} |  {repair, atl_repair()} | {seqno, atl_seqno()}</c></p>
         <p>If present, this option specifies the options for the 
           audit trail logging. The <c>disk_log</c> module is used 
           to maintain a wrap log. If present, the <c>dir</c> and 
@@ -696,6 +699,13 @@
           analysis.</p>
         <p>Default is <c>true</c>.</p>
       </item>
+      <tag><c><![CDATA[atl_seqno() = true | false <optional>]]></c></tag>
+      <item>
+        <p>Specifies if the audit trail log entries will be (sequence)
+          numbered or not. The range of the sequence numbers are according
+          to RFC 5424, i.e. 1 through 2147483647. </p>
+        <p>Default is <c>false</c>.</p>
+      </item>
     </taglist>
   </section>
 
diff --git a/lib/snmp/doc/src/snmp_config.xml b/lib/snmp/doc/src/snmp_config.xml
index 073cdde308..6fc9cc49f2 100644
--- a/lib/snmp/doc/src/snmp_config.xml
+++ b/lib/snmp/doc/src/snmp_config.xml
@@ -4,7 +4,7 @@
 <chapter>
   <header>
     <copyright>
-      <year>1997</year><year>2009</year>
+      <year>1997</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -13,12 +13,12 @@
       compliance with the License. You should have received a copy of the
       Erlang Public License along with this software. If not, it can be
       retrieved online at http://www.erlang.org/.
-    
+
       Software distributed under the License is distributed on an "AS IS"
       basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
       the License for the specific language governing rights and limitations
       under the License.
-    
+
     </legalnotice>
 
     <title>Running the application</title>
@@ -73,13 +73,13 @@
       </item>
     </list>
 
+    <!-- The info below is also found in the snmp_app.xml file -->
+
     <p>The agent and manager uses (application) configuration parameters to 
       find out where these directories are located. The parameters should be
       defined in an Erlang system configuration file. The following
       configuration parameters are defined for the SNMP application:</p>
 
-    <!-- Also in snmp_app.xml -->
-
     <pre>
       agent_options() = [agent_option()]
       agent_option() = {restart_type,     restart_type()}     | 
@@ -649,11 +649,13 @@
           process performs a GC to remove the expired note's. Time in
           milli-seconds.</p>
         <p>Default is <c>30000</c>.</p>
+
+      <marker id="audit_trail_log"></marker>
       </item>
 
       <tag><c><![CDATA[audit_trail_log() [audit_trail_log_opt()] <optional>]]></c></tag>
       <item>
-        <p><c>audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} |  {size, atl_size()} |  {repair, atl_repair()}</c></p>
+        <p><c>audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} |  {size, atl_size()} |  {repair, atl_repair()} | {seqno, atl_seqno()}</c></p>
         <p>If present, this option specifies the options for the 
           <em>audit trail logging</em>. The <c>disk_log</c> module is used 
           to maintain a wrap log. If present, the <c>dir</c> and 
@@ -708,6 +710,13 @@
           analysis.</p>
         <p>Default is <c>true</c>.</p>
       </item>
+      <tag><c><![CDATA[atl_seqno() = true | false <optional>]]></c></tag>
+      <item>
+        <p>Specifies if the audit trail log entries will be (sequence)
+          numbered or not. The range of the sequence numbers are according
+          to RFC 5424, i.e. 1 through 2147483647. </p>
+        <p>Default is <c>false</c>.</p>
+      </item>
     </taglist>
   </section>
 
diff --git a/lib/snmp/doc/src/snmpa_conf.xml b/lib/snmp/doc/src/snmpa_conf.xml
index f383394b7a..d873574c6e 100644
--- a/lib/snmp/doc/src/snmpa_conf.xml
+++ b/lib/snmp/doc/src/snmpa_conf.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>2006</year><year>2009</year>
+      <year>2006</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -13,12 +13,12 @@
       compliance with the License. You should have received a copy of the
       Erlang Public License along with this software. If not, it can be
       retrieved online at http://www.erlang.org/.
-    
+
       Software distributed under the License is distributed on an "AS IS"
       basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
       the License for the specific language governing rights and limitations
       under the License.
-    
+
     </legalnotice>
 
     <title>snmpa_conf</title>