You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by ch...@apache.org on 2014/11/17 20:50:47 UTC

svn commit: r1640215 - in /uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook: logs.tex part4/ducc-aguide.tex part4/install.tex part4/system-logs.tex

Author: challngr
Date: Mon Nov 17 19:50:46 2014
New Revision: 1640215

URL: http://svn.apache.org/r1640215
Log:
UIMA-4109 Document system logs

Added:
    uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/logs.tex
    uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/system-logs.tex
Modified:
    uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/ducc-aguide.tex
    uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex

Added: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/logs.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/logs.tex?rev=1640215&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/logs.tex (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/logs.tex Mon Nov 17 19:50:46 2014
@@ -0,0 +1,48 @@
+% 
+% Licensed to the Apache Software Foundation (ASF) under one
+% or more contributor license agreements.  See the NOTICE file
+% distributed with this work for additional information
+% regarding copyright ownership.  The ASF licenses this file
+% to you under the Apache License, Version 2.0 (the
+% "License"); you may not use this file except in compliance
+% with the License.  You may obtain a copy of the License at
+% 
+%   http://www.apache.org/licenses/LICENSE-2.0
+% 
+% Unless required by applicable law or agreed to in writing,
+% software distributed under the License is distributed on an
+% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+% KIND, either express or implied.  See the License for the
+% specific language governing permissions and limitations
+% under the License.
+% 
+\documentclass[letterpaper]{article}
+
+% space between paragraphs
+\usepackage{parskip}
+
+\usepackage{hyperref}
+% Margins
+\usepackage[top=1in, bottom=.75in, left=.75in, right=.75in ]{geometry}
+
+\usepackage{xcolor}
+\usepackage{datetime}
+
+% turn off section numbering
+\setcounter{secnumdepth}{0}
+
+\title{Guide to DUCC System Logs \\
+Excerpt From Complete DUCC Documentation}
+\author{Written and maintained by the Apache \\
+UIMA\texttrademark Development Community}
+\date{}
+\begin{document}
+\maketitle
+\input{legal.tex}
+\newpage
+
+\input{common.tex}
+
+\input{part4/system-logs.tex}
+
+\end{document}

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/ducc-aguide.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/ducc-aguide.tex?rev=1640215&r1=1640214&r2=1640215&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/ducc-aguide.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/ducc-aguide.tex Mon Nov 17 19:50:46 2014
@@ -59,3 +59,6 @@
 
 %% A chapter
 \input {part4/web.tex}
+
+\chapter{Understanding the DUCC logs}
+\input{part4/system-logs.tex}

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex?rev=1640215&r1=1640214&r2=1640215&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/install.tex Mon Nov 17 19:50:46 2014
@@ -329,20 +329,6 @@ $HOME/ducc/logs/job-id
       Installation and Verification to set up multiple-user support and optionally, multi-node
       operation.
 
-\section{Logs}
-    The DUCC system logs are written to the directory
-\begin{verbatim}
-    $DUCC_HOME/logs
-\end{verbatim}
-
-    In that directory are found logs for each of the DUCC components plus one for each node DUCC is
-    installed on.
-
-    DUCC job/user logs are written by default to the user's HOME directory under
-\begin{verbatim}
-    $HOME/ducc/logs/<jobid>
-\end{verbatim}
-
 \section{Multi-User Installation and Verification}
   
     Multi-user installation consists of these steps over and above single-user installation:

Added: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/system-logs.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/system-logs.tex?rev=1640215&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/system-logs.tex (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part4/system-logs.tex Mon Nov 17 19:50:46 2014
@@ -0,0 +1,71 @@
+% 
+% Licensed to the Apache Software Foundation (ASF) under one
+% or more contributor license agreements.  See the NOTICE file
+% distributed with this work for additional information
+% regarding copyright ownership.  The ASF licenses this file
+% to you under the Apache License, Version 2.0 (the
+% "License"); you may not use this file except in compliance
+% with the License.  You may obtain a copy of the License at
+% 
+%   http://www.apache.org/licenses/LICENSE-2.0
+% 
+% Unless required by applicable law or agreed to in writing,
+% software distributed under the License is distributed on an
+% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+% KIND, either express or implied.  See the License for the
+% specific language governing permissions and limitations
+% under the License.
+% 
+% Create well-known link to this spot for HTML version
+    \section{Overview}
+
+    This chapter provides an overview of the DUCC process logs and how to interpret the
+    entries therin.
+
+    Each of the DUCC ``head node'' processes writes a detailed log of its operation to
+    the directory \ducchome/logs.  The logs are managed by Apache log4j.  All logs are
+    managed by a single log4j configuration file
+\begin{verbatim}
+        DUCC_HOME/resources/log4j.xml
+\end{verbatim}
+
+    The logs are set to roll after some reaching a given size and the number of generations
+    is limited to prevent overrunning disk space.  In general the log level is set to
+    provide sufficient diagnostic output to resolve most issues.
+
+    Each DUCC component writes its own log as defined in the following table:
+
+    \begin{tabular} {| l | l |}
+       \hline
+          Component & Log Name \\
+      \hline
+      \hline
+          Resource Manager & rm.log \\
+      \hline
+          Service Manager & sm.log \\
+      \hline
+          Orchestrator & or.log \\
+      \hline
+          Process Manager & pm.log \\
+      \hline
+          Agent & {\em [hostname].agent.log } \\
+      \hline
+    \end{tabular}
+    
+    Because there may be many agents, the agent log is prefixed with the name of the host for
+    each running agent.
+
+\section{Resource Manager Log (rm.log)}
+    To be filled in.
+
+\section{Service  Manager Log (sm.log)}
+    To be filled in.
+
+\section{ (Orchestrator Log or.log)}
+    To be filled in.
+
+\section{Process Manager Log (pm.log)}
+    To be filled in.
+
+\section{Agent log Log (hostname.agent.log)}
+    To be filled in.