BoilerPlate-LightweightLogging Service OMG Formal/03-11-03

Running the Logging Service and Producers

General

This page describes the command line switches for the Logging Service and for any LogProducer clients

LwLogging Service

• -BPlog_id=logid : [Mandatory] The Log Id. This needs to be a legal file name. The Service will append ".log" to the id. The LWL Service will also expect this name as part of the NameService context tree. It must be added to the base of your NameService context. The Producer and Consumer Admin will bind under the log id context. Pass this value to the Service using the command line switch -BPlog_id=MyLogId on the command line.
• -BPnsbindcontext=mycompany/community/services : [Mandatory] The Naming Context to bind under. The LWL Service needs to know where to bind the LogProducer into the NameService. Use the -BPnsbindcontext=mycompany/community/services/logid. The LWL Service will bind a Producer reference under the logid/producer. The context tree up to the point of the log binding must exist prior to running the service.

• -BPlog_dir=out_directory : [Optional] The directory to create the log in. If this switch is not present, the log will be writen to current directory

• -BPmax_size=integer : [Optional] The maximum size in bytes for the log file. The default is 1mb.

• -BPconsumer_q_size=integer: [Mandatory] The maximum size of the LogConsumer queue. This is a least-recently-used queue of Log Conumer servants. When the number of LogConsumer servants becomes greater than consumer_q_size the least recently used servant is deactivated. The next time the deactivated reference is used, it will be reactivated by the ServantActivator mechanism.

• Use your ORB configuration parameters to tell LWL Service where to find your NameService. BP-LWL uses resolve_initial_reference to find the NameService. This is usually done using the CORBA compliant -ORBInitRef switch but check your implementation documentation if you are not sure.

LogProducer Clients

• -BPlogproducertree=the_base/logid/Producer [Mandatory] The analog of the nsbindcontext including log_id. Tells the LogProducer client where to find the LogProducer binding in the NameService.

• -BPlogproducerid=id_string The String to use as the Log Producer Id. This value is unique for each LogProducer client application. [Optional] This value is passed to the LogProducer Servant on each invocation and appears in the log. It identifies individual applications using the LWLogging Service. It is optional only if you pass the Producer Id into the BPLWLoggingPostORBInitCommand ctor. If you use the default void ctor, you MUST define this value using the switch on the command line.

Setup Steps

• Create the NameService context tree that you want the LogProducer and the Consumer Admin to bind under. You can run multiple Logging Services in the same NameService domain by giving each instance a unique Log Id. For example if want to have two Logging Service instances with Log Ids Log_A and Log_B and you want them to bind under the base tree

   mydotcom/infrastructure 
  

  . You must create two contexts under

   infrastructure 
  

  : Log_A and Log_B. So that you have

   mydotcom/infrastructure/Log_A 
  

  and

   mydotcom/infrastructure/Log_B 
  

  .

• Start the log service. The Logging Service will bind three object references under Log Id context: Producer, ConsumerAdmin, LogAdministrator. Drawing from the example above the complete tree would be:

   mydotcom/infrastructure/Log_A/Producer
  

   mydotcom/infrastructure/Log_A/ConsumerAdmin
  

   mydotcom/infrastructure/Log_A/LogAdministrator
  

• The Logging Service command line for this example would be

   bp_lwlogging -BPlog_id=Log_A -BPnsbindcontext=mydotcom/infrastructure
  

  -BPmax_size and -BPconsumer_q_size are not shown for brevity.

• Next prepare the Log Producer client by including the LWLoggingPostORBInitCommand in the BoilerPlate main line.

   LWLoggingPostORBInitCommand* logger = new LWLoggingPostORBInitCommand;
   orb_init.addPostORBInitCommand(logger);
  

Start you client with the Producer command line parameters

 my_server -BPlogproducertree=mydotcom/infrastructure/Log_A/Producer -BPproducername=ThisIsMe

---