Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TMonaLisaWriter Class Reference

Definition at line 80 of file TMonaLisaWriter.h.

Public Member Functions

 TMonaLisaWriter (const char *monserver, const char *montag, const char *monid=0, const char *monsubid=0, const char *option="")
 Create MonaLisa write object.
 
virtual ~TMonaLisaWriter ()
 Cleanup.
 
ApMon * GetApMon () const
 
void Print (Option_t *option="") const
 Print info about MonaLisa object.
 
virtual Bool_t SendFileCloseEvent (TFile *file)
 
virtual Bool_t SendFileOpenProgress (TFile *file, TList *openphases, const char *openphasename, Bool_t forcesend=kFALSE)
 Send the fileopen progress to MonaLisa.
 
virtual Bool_t SendFileReadProgress (TFile *file)
 
virtual Bool_t SendFileWriteProgress (TFile *file)
 
virtual Bool_t SendInfoDescription (const char *jobtag)
 Sends the description <jobtag> following the processing scheme: <site> --> <jobid> --> 'jobname' = <jobtag>
 
virtual Bool_t SendInfoStatus (const char *status)
 Sends a <status> text to MonaLisa following the process scheme: <site> --> <jobid> --> 'status' = <status> Used to set a global status for a groupjob, e.g.
 
virtual Bool_t SendInfoTime ()
 Sends the current time to MonaLisa following the processing scheme <site> --> <jobid> --> 'time' = >unixtimestamp<.
 
virtual Bool_t SendInfoUser (const char *user=0)
 Sends the <user> text to MonaLisa following the process scheme: <site> --> <jobid> --> 'user' = <user>
 
virtual Bool_t SendParameters (TList *valuelist, const char *identifier=0)
 Send the parameters to MonaLisa.
 
virtual Bool_t SendProcessingProgress (Double_t nevent, Double_t nbytes, Bool_t force=kFALSE)
 Send the procesing progress to MonaLisa.
 
virtual Bool_t SendProcessingStatus (const char *status, Bool_t restarttimer=kFALSE)
 Send the procesing status 'status' to MonaLisa following the processing scheme: <site> --> <jobid> --> 'status' = <status> Used, to set the processing status of individual subtaks e.g.
 
virtual void SetLogLevel (const char *loglevel="WARNING")
 Set MonaLisa log level.
 
virtual void Verbose (Bool_t onoff)
 
- Public Member Functions inherited from TVirtualMonitoringWriter
 TVirtualMonitoringWriter ()
 
 TVirtualMonitoringWriter (const char *name, Double_t value)
 
virtual ~TVirtualMonitoringWriter ()
 destructor
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings ("").
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects.
 
virtual void Copy (TObject &named) const
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification.
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Private Member Functions

 TMonaLisaWriter (const TMonaLisaWriter &)
 
void Init (const char *monserver, const char *montag, const char *monid, const char *monsubid, const char *option)
 Creates a TMonaLisaWriter object to send monitoring information to a MonaLisa server using the MonaLisa ApMon package (libapmoncpp.so/UDP packets).
 
TMonaLisaWriteroperator= (const TMonaLisaWriter &)
 
Bool_t SendFileCheckpoint (TFile *file)
 

Private Attributes

ApMon * fApmon
 
TStopwatch fFileStopwatch
 
TString fHostname
 sub job id
 
Bool_t fInitialized
 process id
 
TString fJobId
 connection to MonaLisa
 
Double_t fLastFCloseSendTime
 
time_t fLastProgressTime
 
Double_t fLastRWSendTime
 
std::map< UInt_t, MonitoredTFileInfo * > * fMonInfoRepo
 
Int_t fPid
 hostname of MonaLisa server
 
Int_t fReportInterval
 repo to gather per-file-instance mon info;
 
TStopwatch fStopwatch
 
TString fSubJobId
 job id
 
Bool_t fVerbose
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 
- Protected Attributes inherited from TVirtualMonitoringWriter
TListfTmpOpenPhases
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TMonaLisaWriter.h>

Inheritance diagram for TMonaLisaWriter:
[legend]

Constructor & Destructor Documentation

◆ TMonaLisaWriter() [1/2]

TMonaLisaWriter::TMonaLisaWriter ( const TMonaLisaWriter )
private

◆ TMonaLisaWriter() [2/2]

TMonaLisaWriter::TMonaLisaWriter ( const char *  monserver,
const char *  montag,
const char *  monid = 0,
const char *  monsubid = 0,
const char *  option = "" 
)

Create MonaLisa write object.

Definition at line 168 of file TMonaLisaWriter.cxx.

◆ ~TMonaLisaWriter()

TMonaLisaWriter::~TMonaLisaWriter ( )
virtual

Cleanup.

Definition at line 382 of file TMonaLisaWriter.cxx.

Member Function Documentation

◆ GetApMon()

ApMon * TMonaLisaWriter::GetApMon ( ) const
inline

Definition at line 116 of file TMonaLisaWriter.h.

◆ Init()

void TMonaLisaWriter::Init ( const char *  monserver,
const char *  montag,
const char *  monid,
const char *  monsubid,
const char *  option 
)
private

Creates a TMonaLisaWriter object to send monitoring information to a MonaLisa server using the MonaLisa ApMon package (libapmoncpp.so/UDP packets).

The MonaLisa ApMon library for C++ can be downloaded at http://monalisa.cacr.caltech.edu/monalisa__Download__ApMon.html, current version: http://monalisa.cacr.caltech.edu/download/apmon/ApMon_cpp-2.0.6.tar.gz

The ROOT implementation is primary optimized for process/job monitoring, although all other generic MonaLisa ApMon functionality can be exploited through the ApMon class directly (gMonitoringWriter->GetApMon()).

Monitoring information in MonaLisa is structured in the following tree structure: <farmname> | —> <nodename1> | —> <key1> - <value1> —> <key2> - <value2> —> <nodename2> | —> <key3> - <value3> —> <key4> - <value4>

The parameter monid is equivalent to the MonaLisa node name, for the case of process monitoring it can be just an identifier to classify the type of jobs e.g. "PROOF_PROCESSING". If monid is not specified, TMonaLisaWriter tries to set it in this order from environment variables:

  • PROOF_JOB_ID
  • GRID_JOB_ID
  • LCG_JOB_ID
  • ALIEN_MASTERJOB_ID
  • ALIEN_PROC_ID

The parameter montag is equivalent to the MonaLisa farm name, for the case of process monitoring it can be a process identifier e.g. a PROOF session ID.

The parameter monserver specifies the server to whom to send the monitoring UDP packets. If not specified, the hostname (the port is a default one) is specified in the environment variable APMON_CONFIG.

To use TMonaLisaWriter, libMonaLisa.so has to be loaded.

According to the fact, that the deepness of the MonaLisa naming scheme is only 3 (<farm><node>

), a special naming scheme is used for process monitoring. There is a high-level method to send progress information of Tree analysis (# of events, datasize). To distinguish individual nodes running the processing, part of the information is kept in the

parameter of ML.

is named as: <site-name>:<host-name>:<pid>:<valuetag> <site-name> is taken from an environment variable in the following order:

  • PROOF_SITE
  • GRID_SITE
  • ALIEN_SITE
  • default 'none' <host-name> is taken from gSystem->Hostname() <pid> is the process ID of the ROOT process

Example of use for Process Monitoring: new TMonaLisaWriter("BATCH_ANALYSIS","AnalysisLoop-00001","lxplus050.cern.ch"); Once when you create an analysis task, execute gMonitoringWriter->SendInfoUser("myname"); gMonitoringWriter->SendInfoDescription("My first Higgs analysis"); gMonitoringWriter->SendInfoTime(); gMonitoringWriter->SendInfoStatus("Submitted");

On each node executing a subtask, you can set the status of this subtask: gMonitoringWriter->SendProcessingStatus("Started"); During the processing of your analysis you can send progress updates: gMonitoringWriter->SendProcessProgress(100,1000000); <= 100 events, 1MB processed .... gMonitoringWriter-SendProcessingStatus("Finished"); delete gMonitoringWriter; gMonitoringWriter=0;

Example of use for any Generic Monitoring information: TList valuelist = new TList(); valuelist->SetOwner(kTRUE); // append a text object TMonaLisaText *valtext = new TMonaLisaText("decaychannel","K->eeg"); valuelist->Add(valtext); // append a double value TMonaLisaValue valdouble = new TMonaLisaValue("n-gamma",5); valuelist->Add(valdouble); Bool_t success = SendParameters(valuelist); delete valuelist;

option: "global": gMonitoringWriter is initialized with this instance

Definition at line 270 of file TMonaLisaWriter.cxx.

◆ operator=()

TMonaLisaWriter & TMonaLisaWriter::operator= ( const TMonaLisaWriter )
private

◆ Print()

void TMonaLisaWriter::Print ( Option_t option = "") const
virtual

Print info about MonaLisa object.

Reimplemented from TNamed.

Definition at line 1169 of file TMonaLisaWriter.cxx.

◆ SendFileCheckpoint()

Bool_t TMonaLisaWriter::SendFileCheckpoint ( TFile file)
private

Definition at line 866 of file TMonaLisaWriter.cxx.

◆ SendFileCloseEvent()

Bool_t TMonaLisaWriter::SendFileCloseEvent ( TFile file)
virtual

Reimplemented from TVirtualMonitoringWriter.

Definition at line 765 of file TMonaLisaWriter.cxx.

◆ SendFileOpenProgress()

Bool_t TMonaLisaWriter::SendFileOpenProgress ( TFile file,
TList openphases,
const char *  openphasename,
Bool_t  forcesend = kFALSE 
)
virtual

Send the fileopen progress to MonaLisa.

If openphases=0 it means that the information is to be stored in a temp space, since there is not yet an object where to attach it to. This is typical in the static Open calls. The temp openphases are put into a list as soon as one is specified.

If thisopenphasename=0 it means that the stored phases (temp and object) have to be cleared.

Reimplemented from TVirtualMonitoringWriter.

Definition at line 667 of file TMonaLisaWriter.cxx.

◆ SendFileReadProgress()

Bool_t TMonaLisaWriter::SendFileReadProgress ( TFile file)
virtual

Reimplemented from TVirtualMonitoringWriter.

Definition at line 856 of file TMonaLisaWriter.cxx.

◆ SendFileWriteProgress()

Bool_t TMonaLisaWriter::SendFileWriteProgress ( TFile file)
virtual

Reimplemented from TVirtualMonitoringWriter.

Definition at line 861 of file TMonaLisaWriter.cxx.

◆ SendInfoDescription()

Bool_t TMonaLisaWriter::SendInfoDescription ( const char *  jobtag)
virtual

Sends the description <jobtag> following the processing scheme: <site> --> <jobid> --> 'jobname' = <jobtag>

Reimplemented from TVirtualMonitoringWriter.

Definition at line 473 of file TMonaLisaWriter.cxx.

◆ SendInfoStatus()

Bool_t TMonaLisaWriter::SendInfoStatus ( const char *  status)
virtual

Sends a <status> text to MonaLisa following the process scheme: <site> --> <jobid> --> 'status' = <status> Used to set a global status for a groupjob, e.g.

a master-job or the general status of PROOF processing.

Reimplemented from TVirtualMonitoringWriter.

Definition at line 407 of file TMonaLisaWriter.cxx.

◆ SendInfoTime()

Bool_t TMonaLisaWriter::SendInfoTime ( )
virtual

Sends the current time to MonaLisa following the processing scheme <site> --> <jobid> --> 'time' = >unixtimestamp<.

Reimplemented from TVirtualMonitoringWriter.

Definition at line 501 of file TMonaLisaWriter.cxx.

◆ SendInfoUser()

Bool_t TMonaLisaWriter::SendInfoUser ( const char *  user = 0)
virtual

Sends the <user> text to MonaLisa following the process scheme: <site> --> <jobid> --> 'user' = <user>

Reimplemented from TVirtualMonitoringWriter.

Definition at line 434 of file TMonaLisaWriter.cxx.

◆ SendParameters()

Bool_t TMonaLisaWriter::SendParameters ( TList valuelist,
const char *  identifier = 0 
)
virtual

Send the parameters to MonaLisa.

Reimplemented from TVirtualMonitoringWriter.

Definition at line 1000 of file TMonaLisaWriter.cxx.

◆ SendProcessingProgress()

Bool_t TMonaLisaWriter::SendProcessingProgress ( Double_t  nevent,
Double_t  nbytes,
Bool_t  force = kFALSE 
)
virtual

Send the procesing progress to MonaLisa.

Reimplemented from TVirtualMonitoringWriter.

Definition at line 571 of file TMonaLisaWriter.cxx.

◆ SendProcessingStatus()

Bool_t TMonaLisaWriter::SendProcessingStatus ( const char *  status,
Bool_t  restarttimer = kFALSE 
)
virtual

Send the procesing status 'status' to MonaLisa following the processing scheme: <site> --> <jobid> --> 'status' = <status> Used, to set the processing status of individual subtaks e.g.

the status of a batch (sub-)job or the status of a PROOF slave participating in query <jobid>

Reimplemented from TVirtualMonitoringWriter.

Definition at line 534 of file TMonaLisaWriter.cxx.

◆ SetLogLevel()

void TMonaLisaWriter::SetLogLevel ( const char *  loglevel = "WARNING")
virtual

Set MonaLisa log level.

Reimplemented from TVirtualMonitoringWriter.

Definition at line 1161 of file TMonaLisaWriter.cxx.

◆ Verbose()

virtual void TMonaLisaWriter::Verbose ( Bool_t  onoff)
inlinevirtual

Reimplemented from TVirtualMonitoringWriter.

Definition at line 138 of file TMonaLisaWriter.h.

Member Data Documentation

◆ fApmon

ApMon* TMonaLisaWriter::fApmon
private

Definition at line 83 of file TMonaLisaWriter.h.

◆ fFileStopwatch

TStopwatch TMonaLisaWriter::fFileStopwatch
private

Definition at line 101 of file TMonaLisaWriter.h.

◆ fHostname

TString TMonaLisaWriter::fHostname
private

sub job id

Definition at line 86 of file TMonaLisaWriter.h.

◆ fInitialized

Bool_t TMonaLisaWriter::fInitialized
private

process id

Definition at line 88 of file TMonaLisaWriter.h.

◆ fJobId

TString TMonaLisaWriter::fJobId
private

connection to MonaLisa

Definition at line 84 of file TMonaLisaWriter.h.

◆ fLastFCloseSendTime

Double_t TMonaLisaWriter::fLastFCloseSendTime
private

Definition at line 91 of file TMonaLisaWriter.h.

◆ fLastProgressTime

time_t TMonaLisaWriter::fLastProgressTime
private

Definition at line 92 of file TMonaLisaWriter.h.

◆ fLastRWSendTime

Double_t TMonaLisaWriter::fLastRWSendTime
private

Definition at line 90 of file TMonaLisaWriter.h.

◆ fMonInfoRepo

std::map<UInt_t, MonitoredTFileInfo *>* TMonaLisaWriter::fMonInfoRepo
private

Definition at line 95 of file TMonaLisaWriter.h.

◆ fPid

Int_t TMonaLisaWriter::fPid
private

hostname of MonaLisa server

Definition at line 87 of file TMonaLisaWriter.h.

◆ fReportInterval

Int_t TMonaLisaWriter::fReportInterval
private

repo to gather per-file-instance mon info;

Definition at line 98 of file TMonaLisaWriter.h.

◆ fStopwatch

TStopwatch TMonaLisaWriter::fStopwatch
private

Definition at line 100 of file TMonaLisaWriter.h.

◆ fSubJobId

TString TMonaLisaWriter::fSubJobId
private

job id

Definition at line 85 of file TMonaLisaWriter.h.

◆ fVerbose

Bool_t TMonaLisaWriter::fVerbose
private

Definition at line 89 of file TMonaLisaWriter.h.

  • net/monalisa/inc/TMonaLisaWriter.h
  • net/monalisa/src/TMonaLisaWriter.cxx