]> git.sur5r.net Git - bacula/docs/commitdiff
Add new messageid documentation Release-7.9.0
authorKern Sibbald <kern@sibbald.com>
Thu, 25 May 2017 10:44:37 +0000 (12:44 +0200)
committerKern Sibbald <kern@sibbald.com>
Thu, 25 May 2017 10:44:49 +0000 (12:44 +0200)
docs/manuals/en/main/newfeatures.tex

index a271ff59775f13a73f03d190812943eb97b472f7..35f23f559e5b1d52df3cde868d02bdf80d0b93dc 100644 (file)
@@ -864,6 +864,70 @@ Deduplication Optimized Volumes whitepaper.
 This feature is available if you have Bacula Community produced binaries
 and the Aligned Volumes plugin.
 
 This feature is available if you have Bacula Community produced binaries
 and the Aligned Volumes plugin.
 
+\subsection{New Message Identification Format}
+We are starting to add unique message indentifiers to each message (other
+than debug and the Job report) that Bacula prints.  At the current time
+only two files in the Storage Daemon have these message identifiers and 
+over time with subsequent releases we will modify all messages.
+
+\smallskip
+The message identifier will be kept unique for each message and once
+assigned to a message it will not change even if the text of the message
+changes.  This means that the message identifier will be the same no matter
+what language the text is displayed in, and more importantly, it will allow
+us to make listing of the messages with in some cases, additional
+explanation or instructions on how to correct the problem.  All this will
+take several years since it is a lot of work and requires some new programs
+that are not yet written to manage these message identifiers.
+
+\smallskip
+The format of the message identifier is:
+
+\begin{verbatim}
+   [AAnnnn]
+\end{verbatim}
+where A is an upper case character and nnnn is a four digit number, where
+the first charcter indicates the software component (daemon); the second
+letter indicates the severity, and the number is unique for a given
+componet and severity.
+
+\smallskip
+For example:
+
+\begin{verbatim}
+   [SF0001]
+\end{verbatim}
+
+The first charcter representing the componend at the current time one of
+the following:
+
+\begin{verbatim}
+   S      Storage daemon
+   D      Director
+   F      File daemon
+\end{verbatim}
+
+\smallskip
+The second character representing the severity or level can be:
+
+\begin{verbatim}
+   A      Abort 
+   F      Fatal
+   E      Erropr
+   W      Warning
+   S      Security
+   I      Info
+   D      Debug
+   O      OK (i.e. operation completed normallly)
+\end{verbatim}
+
+So in the example above [SF0001] indicates it is a message id, because of
+the brackets and because it is at the beginning of the message, and that
+it was generated by the Storage daemon as a fatal error.
+\smallskip
+As mentioned above it will take some time to implement these message ids
+everywhere, and over time we may add more component letters and more
+severity levels as needed.
 
 
 \chapter{New Features in 7.4.0}
 
 
 \chapter{New Features in 7.4.0}