Changeset 3992

Timestamp:

Nov 22, 2007, 2:19:37 PM (15 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #728: jobagent.sh should accept command status

Also made the jobagent log into it's own file (jobagent.log) instead of stdout

Location:

trunk

Files:

• config/dist/log4j.properties (modified) (2 diffs)
• doc/src/docbook/admindoc/installation_upgrade.xml (modified) (2 diffs)
• doc/src/docbook/appendix/jobagent.sh.xml (modified) (2 diffs)
• src/clients/jobagent/net/sf/basedb/clients/jobagent/Agent.java (modified) (4 diffs)
• src/clients/jobagent/net/sf/basedb/clients/jobagent/AgentController.java (modified) (10 diffs)
• src/clients/jobagent/net/sf/basedb/clients/jobagent/JobQueueChecker.java (modified) (1 diff)
• src/core/net/sf/basedb/util/jobagent/JobAgentServerConnection.java (modified) (1 diff)

trunk/config/dist/log4j.properties

@@ -16 +16 @@
 log4j.appender.migfile.layout=org.apache.log4j.PatternLayout
 log4j.appender.migfile.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
+
+### Job agent log is written to jobagent.log in working directory ###
+log4j.appender.jobagent=org.apache.log4j.FileAppender
+log4j.appender.jobagent.File=jobagent.log
+log4j.appender.jobagent.layout=org.apache.log4j.PatternLayout
+log4j.appender.jobagent.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
 
 ### set log levels - for more verbose logging change 'info' to 'debug' ###
@@ -57 +63 @@
 # Job agent loggers
 # -----------------
-log4j.logger.net.sf.basedb.clients.jobagent=warn
+log4j.logger.net.sf.basedb.clients.jobagent=warn, jobagent
 
 # -----------------

trunk/doc/src/docbook/admindoc/installation_upgrade.xml

@@ -378 +378 @@
                 agents to log on to BASE. The account is disabled by
                 default and must be enabled. Enable the account and
-                set a password. This password is set in the
+                set a password using the BASE web interface. 
+                The same password must also be set in the
                 <filename>jobagent.properties</filename> file, see
                 item
@@ -475 +476 @@
                   <listitem>
                     <para>
-                      <command>userfile</command>: The path to the
+                      <command>userfiles</command>: The path to the
                       directory where user files are located. This
                       directory must be accessible from all job

trunk/doc/src/docbook/appendix/jobagent.sh.xml

@@ -65 +65 @@
           
           The default value is <filename>jobagent.properties</filename>.
+          The classpath is not searched which means that it doesn't find
+          the configuration file in <filename>&lt;base-dir&gt;/www/WEB-INF/classes/</filename>
+          unless you specify the path to it.
           See <xref linkend="appendix.jobagent.properties" /> 
           for more information about job agent configuration files.
@@ -150 +153 @@
       </listitem>
     </varlistentry>
+    
+    <varlistentry>
+      <term><command>status</command></term>
+      <listitem>
+        <para>
+          Similar to the <command>info</command> command but with less output.
+          The output is either <computeroutput>Running, Pauses or Stopped</computeroutput>.
+          In case of an unexpected error, an error message may be displayed instead.
+        </para>
+      </listitem>
+    </varlistentry>
 
     <varlistentry>

trunk/src/clients/jobagent/net/sf/basedb/clients/jobagent/Agent.java

@@ -210 +210 @@
   public static final int DEFAULT_CHECK_INTERVAL = 30;
   
+  static
+  {
+    org.apache.log4j.LogManager.getLogger("net.sf.basedb.clients.jobagent").setAdditivity(false);
+  }
+  
   /**
     Log job agent events.
@@ -548 +553 @@
     if (!isRunning)
     {
-      isRunning = true;
+      // Start BASE application and login
+      SessionControl sc = getSessionControl();;
+      // Create executor and job queue checker
       jobExecutor = createJobExecutor();
       jobQueueChecker = createJobQueueChecker();
-      
-      // Start the BASE application in a new thread so we can return quickly
-      Thread t = new Thread(
-        new Runnable()
-        {
-          public void run()
-          {
-            SessionControl sc = null;
-            try
-            {
-              sc = getSessionControl();
-            }
-            catch (Throwable t)
-            {}
-            if (sc == null || !sc.isLoggedIn()) 
-            {
-              stop();
-            }
-          }
-        }
-      );
-      t.start();
+      isRunning = true;
     }
   }
@@ -703 +689 @@
   public SessionControl getSessionControl()
   {
-    try
-    {
-      if (sc == null)
-      {
-        log.info("Starting BASE application");
-        Application.start(false);
-        sc = Application.newSessionControl("net.sf.basedb.clients.jobagent", 
-          SocketUtil.getLocalHost().toString(), null);
-      }
-      if (!sc.isLoggedIn())
-      {
-        log.info("Logging in as user: " + login);
-        sc.login(login, password, "Job agent running on host " + getServerName(), false);
-      }
-    }
-    catch (Throwable t)
-    {
-      log.error(t.getMessage(), t);
+    if (sc == null)
+    {
+      log.info("Starting BASE application");
+      Application.start(false);
+      sc = Application.newSessionControl("net.sf.basedb.clients.jobagent", 
+        SocketUtil.getLocalHost().toString(), null);
+    }
+    if (!sc.isLoggedIn())
+    {
+      log.info("Logging in as user: " + login);
+      sc.login(login, password, "Job agent running on host " + getServerName(), false);
     }
     return sc;
@@ -905 +884 @@
       executor.init(this);
     }
-    catch (Throwable t)
+    catch (RuntimeException t)
     {
       log.error("Could not create job executor instance: " + executorClass.getName(), t);
       executor = null;
+      throw t;
+    }
+    catch (Exception e)
+    {
+      log.error("Could not create job executor instance: " + executorClass.getName(), e);
+      executor = null;
+      throw new RuntimeException(e);
     }
     return executor;

trunk/src/clients/jobagent/net/sf/basedb/clients/jobagent/AgentController.java

@@ -51 +51 @@
 public class AgentController
 {
-
+  static
+  {
+    org.apache.log4j.LogManager.getLogger("net.sf.basedb.clients.jobagent").setAdditivity(false);
+  }
+  
   /**
     Log job agent events.
@@ -60 +64 @@
   public static void main(String[] args)
   {
+    int exitCode = 0;
     CmdLine cmdLine = new CmdLine(args);
     String cmd = cmdLine.getCmd();
@@ -82 +87 @@
         printUsage();
         log.debug(message, t);
-        return;
+        System.exit(1);
       }
     
@@ -92 +97 @@
           System.out.println("Starting job agent...");
           ac.startAgent();
+          exitCode = -1; // Do not exit
           System.out.println("Job agent is up and running.");
         }
@@ -106 +112 @@
           System.out.println(info.toString());
         }
+        else if ("status".equals(cmd))
+        {
+          String msg = "";
+          try
+          {
+            JobAgentInfo info = ac.getStatus();
+            msg += info.isPaused() ? "Paused" : "Running";
+          }
+          catch (ConnectException ex)
+          {
+            // ConnectException is expected if the agent is not running
+            msg += "Stopped";
+            log.debug(ex.getMessage(), ex);
+          }
+          catch (Throwable t)
+          {
+            msg += "Error (" + t.getMessage() + ")";
+            log.error(msg, t);
+            exitCode = 1;
+          }
+          System.out.println(msg);
+        }
         else if ("register".equals(cmd))
         {
@@ -133 +161 @@
       catch (Throwable t)
       {
+        exitCode = 1;
         String message = "Exception when executing command " + cmd;
         System.out.println(message + ": " + t.getMessage());
@@ -138 +167 @@
       }
     }
+    if (exitCode >= 0) System.exit(exitCode);
   }
 
@@ -144 +174 @@
     System.out.println("Usage    : jobagent.sh [options] cmd");
     System.out.println(" options : -c <configuration file>");
-    System.out.println(" cmd     : start | stop | pause | info | register | unregister | help");
+    System.out.println(" cmd     : start | stop | pause | info | status | register | unregister | help");
   }
 
@@ -155 +185 @@
     System.out.println("pause     : Pauses the job agent");
     System.out.println("info      : Get info about the job agent");
+    System.out.println("status    : Get status information about the job agent");
     System.out.println("register  : Registers this job agent with the BASE server");
     System.out.println("unregister: Unregisters this job agent from the BASE server");
@@ -318 +349 @@
   }
   
+  /**
+    Get status info about running job agent by sending an info request to the agents r
+    emote control service. The agent may be running in this or in another virtual machine.
+    @throws IOException If there is an error
+    @return A <code>JobAgentInfo</code> object
+    @see JobAgentConnection#getInfo(boolean)
+    @since 2.5
+  */
+  public JobAgentInfo getStatus()
+    throws IOException
+  {
+    log.info("Getting status from agent on port " + port);
+    JobAgentConnection conn = new JobAgentConnection(port, timeout);
+    JobAgentInfo info = null;
+    try
+    {
+      log.info("Sending status command to job agent on port " + port);
+      info = conn.getInfo(true);
+    }
+    finally
+    {
+      conn.close();
+    }
+    return info;
+  }
+
   public void registerAgent()
   {

trunk/src/clients/jobagent/net/sf/basedb/clients/jobagent/JobQueueChecker.java

@@ -73 +73 @@
   {
     this.agent = agent;
+    
+    // Verify that jobagent is registered
+    DbControl dc = null;
+    try
+    {
+      SessionControl sc = agent.getSessionControl();
+      dc = sc.newDbControl();
+      JobAgent jobAgent = agent.getJobAgent(dc);
+    }
+    finally
+    {
+      if (dc != null) dc.close();
+    }
   }
   

trunk/src/core/net/sf/basedb/util/jobagent/JobAgentServerConnection.java

@@ -206 +206 @@
         catch (Throwable t)
         {
-          answer = "FAILED " + t.getClass().getName() + ": " + t.getMessage();
+          answer = t.getMessage() + " [" + t.getClass().getName() + "]";
           if (logger != null) logger.error("Eception in request handler "+ requestHandler + 
             ": " + t.getMessage(), t);