app.Profiler.Profiler Class Reference

Class which provides functionality for use profiling. More...

Inheritance diagram for app.Profiler.Profiler:

Collaboration diagram for app.Profiler.Profiler:

Public Member Functions
def	__init__ (self)
	constructor More...
def	readConfig (self, configName)
	load log config file of prifiler More...
def	start (self)
	start profiling More...
def	stop (self)
	stop profiling More...

Public Attributes
	parser
	logger
	isStarted
	status
	sortby
	limit
	traceback
	tracebackLoggerMode
	errorMsg
	pr

Static Public Attributes
string	MSG_ERROR_PARSE_CMD_PARAMS = "Error parse command line parameters."
	Constants error messages used in class. More...
string	MSG_ERROR_EMPTY_CONFIG_FILE_NAME = "Config file name is empty."
string	MSG_ERROR_WRONG_CONFIG_FILE_NAME = "Config file name is wrong"
string	MSG_ERROR_LOAD_APP_CONFIG = "Error loading application config file."
string	MSG_ERROR_READ_LOG_CONFIG = "Error read log config file."
string	MSG_ERROR_WRONG_CONFIG_OPTION = "Wrong format option"
string	MSG_ERROR_WRONG__OPTION_SORTBY = "Read wrong value of 'sortby' from config"
string	PROFILER_OPTION_LOG = "log"
	Constans profiler options read from config. More...
string	PROFILER_OPTION_STATUS = "profile"
string	PROFILER_OPTION_SORTBY = "sortby"
string	PROFILER_OPTION_LIMIT = "limit"
string	PROFILER_OPTION_TRACEBACK = "traceback"
string	PROFILER_OPTION_TRACEBACK_LOGGER_MODE = "tracebackLoggerMode"
int	PROFILER_OPTION_STATUS_DEFAULT = 0
	Constans default values of profiler options. More...
string	PROFILER_OPTION_SORTBY_DEFAULT = "cumulative"
float	PROFILER_OPTION_LIMIT_DEFAULT = 1.0
int	PROFILER_OPTION_TRACEBACK_DEFAULT = 0
int	PROFILER_OPTION_TRACEBACK_LOGGER_MODE_DEFAULT = 1
list	PROFILER_OPTION_SORTBY_ALLOWED_LIST = ['stdname', 'calls', 'time', 'cumulative']
	Constans allowed values of 'sortby'. More...
string	MESSAGES_ITEMS_DELIMITER = ","
	Constans for global message list of strings in the final message for profiler records. More...
dictionary	tracebackOptions
	Constans traceback config options (key - options name, value - default. More...

Private Member Functions
def	__initTrackbackOptions (self, config, section)
	initialize traceback options from config file More...
def	__loadAppConfig (self, configName)
	load application config file More...
def	__parseParams (self)
	parsing paramers More...

Detailed Description

Class which provides functionality for use profiling.

Definition at line 32 of file Profiler.py.

Constructor & Destructor Documentation

__init__()

def app.Profiler.Profiler.__init__

(

self

)

constructor

Constructor

Definition at line 94 of file Profiler.py.

  def __init__(self):
    '''
    Constructor
    '''
    self.parser = None
    self.logger = None
    self.isStarted = False
    self.status = self.PROFILER_OPTION_STATUS_DEFAULT
    self.sortby = self.PROFILER_OPTION_SORTBY_DEFAULT
    self.limit = self.PROFILER_OPTION_LIMIT_DEFAULT
    self.traceback = self.PROFILER_OPTION_TRACEBACK_DEFAULT
    self.tracebackLoggerMode = self.PROFILER_OPTION_TRACEBACK_LOGGER_MODE_DEFAULT
    self.errorMsg = ""
    #create instance of profiler
    self.pr = cProfile.Profile()
    try:
      #load configuration files and initialization
      self.__loadAppConfig(self.__parseParams())
    except Exception, err:
      self.errorMsg = str(err)
      self.status = self.PROFILER_OPTION_STATUS_DEFAULT

    if self.traceback > 0:
      #used self.tracebackLoggerMode already reinit from config
      if self.tracebackLoggerMode > 0 and Utils.tracebackLogger is None:
        Utils.tracebackLogger = Utils.MPLogger().getLogger(APP_CONSTS.LOGGER_NAME_TRACEBACK)

      sys.settrace(tracefunc)

Member Function Documentation

__initTrackbackOptions()

def app.Profiler.Profiler.__initTrackbackOptions (   self,   config,   section  )

private

initialize traceback options from config file

Parameters

config	- config parser
section	- section name

Returns

- None

Definition at line 129 of file Profiler.py.

  def __initTrackbackOptions(self, config, section):

    for key, value in self.tracebackOptions.items():
      opt = Utils.getConfigParameter(config, section, key, value)

      if opt and opt != value:
        try:
          exec('Utils.' + str(key) + '=' + str(opt))  # pylint: disable=W0122
        except Exception:
          raise Exception(self.MSG_ERROR_WRONG_CONFIG_OPTION + ': ' + str(key))

Here is the caller graph for this function:

__loadAppConfig()

def app.Profiler.Profiler.__loadAppConfig (   self,   configName  )

private

load application config file

Parameters

configName

- name of application config file

Returns

- profiler config file name

Definition at line 145 of file Profiler.py.

  def __loadAppConfig(self, configName):
    #variable for result
    confLogFileName = ""

    try:
      config = ConfigParser.ConfigParser()
      config.optionxform = str

      readOk = config.read(configName)

      if len(readOk) == 0:
        raise Exception(self.MSG_ERROR_WRONG_CONFIG_FILE_NAME + ": " + configName)

      if config.has_section(APP_CONSTS.CONFIG_APPLICATION_SECTION_NAME):
        confLogFileName = str(config.get(APP_CONSTS.CONFIG_APPLICATION_SECTION_NAME, self.PROFILER_OPTION_LOG))

      if config.has_section(APP_CONSTS.CONFIG_PROFILER_SECTION_NAME):
        self.status = int(config.get(APP_CONSTS.CONFIG_PROFILER_SECTION_NAME, self.PROFILER_OPTION_STATUS))
        self.sortby = str(config.get(APP_CONSTS.CONFIG_PROFILER_SECTION_NAME, self.PROFILER_OPTION_SORTBY))
        self.limit = float(config.get(APP_CONSTS.CONFIG_PROFILER_SECTION_NAME, self.PROFILER_OPTION_LIMIT))
        self.traceback = int(config.get(APP_CONSTS.CONFIG_PROFILER_SECTION_NAME, self.PROFILER_OPTION_TRACEBACK))
        if self.traceback > 0:
          self.__initTrackbackOptions(config, APP_CONSTS.CONFIG_PROFILER_SECTION_NAME)
          if config.has_option(APP_CONSTS.CONFIG_PROFILER_SECTION_NAME, self.PROFILER_OPTION_TRACEBACK_LOGGER_MODE):
            self.tracebackLoggerMode = int(Utils.getConfigParameter(config, APP_CONSTS.CONFIG_PROFILER_SECTION_NAME,
                                                                    self.PROFILER_OPTION_TRACEBACK_LOGGER_MODE,
                                                                    self.PROFILER_OPTION_TRACEBACK_LOGGER_MODE_DEFAULT))
          else:
            pass
        else:
          pass

    except Exception, err:
      raise Exception(self.MSG_ERROR_LOAD_APP_CONFIG + ' ' + str(err))

    if self.sortby not in self.PROFILER_OPTION_SORTBY_ALLOWED_LIST:
      raise Exception(self.MSG_ERROR_WRONG__OPTION_SORTBY)

    return confLogFileName

Here is the call graph for this function:

Here is the caller graph for this function:

__parseParams()

def app.Profiler.Profiler.__parseParams (   self )

private

parsing paramers

Returns

- configName read from command line argument

Definition at line 206 of file Profiler.py.

  def __parseParams(self):
    configName = ""
    try:
      self.parser = argparse.ArgumentParser(description='Process command line arguments.', add_help=False)
      self.parser.add_argument('-c', '--config', action='store', metavar='config_file', help='config ini-file')

      args = self.parser.parse_known_args()

      if args is None or args[0] is None or args[0].config is None:
        raise Exception(self.MSG_ERROR_EMPTY_CONFIG_FILE_NAME)

      configName = str(args[0].config)

    except Exception, err:
      raise Exception(self.MSG_ERROR_PARSE_CMD_PARAMS + ' ' + str(err))

    return configName

readConfig()

def app.Profiler.Profiler.readConfig	(		self,
			configName
	)

load log config file of prifiler

Parameters

configName

- name of log profiler config file

Returns

- None

Definition at line 190 of file Profiler.py.

  def readConfig(self, configName):
    try:
      if isinstance(configName, str) and len(configName) == 0:
        raise Exception(self.MSG_ERROR_EMPTY_CONFIG_FILE_NAME)

      logging.config.fileConfig(configName)
      #call rotation log files and initialization logger
      self.logger = Utils.MPLogger().getLogger()

    except Exception, err:
      raise Exception(self.MSG_ERROR_READ_LOG_CONFIG + ' ' + str(err))

Here is the call graph for this function:

start()

def app.Profiler.Profiler.start

(

self

)

start profiling

Returns

- None

Definition at line 228 of file Profiler.py.

  def start(self):
    if self.isStarted is False:
      self.pr.enable()
      self.isStarted = True

stop()

def app.Profiler.Profiler.stop

(

self

)

stop profiling

Returns

- None

Definition at line 237 of file Profiler.py.

  def stop(self):
    msgStr = self.MESSAGES_ITEMS_DELIMITER.join(messagesList)

    if self.isStarted is True and self.status > 0:
      self.isStarted = False
      self.pr.disable()
      s = StringIO.StringIO()
      ps = pstats.Stats(self.pr, stream=s).sort_stats(self.sortby)
      ps.print_stats(self.limit)

      #call rotation log files
      self.logger = Utils.MPLogger().getLogger(APP_CONSTS.LOGGER_NAME_PROFILER)
      #dump profile information to log
      if self.logger:
        self.logger.debug("%s\n%s", msgStr, str(s.getvalue()))
        self.logger.debug("%s", APP_CONSTS.LOGGER_DELIMITER_LINE)

    if self.traceback > 0:
      if Utils.tracebackLogger is None:
        #call rotation log files
        self.logger = Utils.MPLogger().getLogger(APP_CONSTS.LOGGER_NAME_TRACEBACK)
        #dump traceback information to log
        if self.logger:
          self.logger.debug("%s\n%s", msgStr, "\n".join(Utils.tracebackList))
          self.logger.debug("%s", APP_CONSTS.LOGGER_DELIMITER_LINE)

Member Data Documentation

errorMsg

app.Profiler.Profiler.errorMsg

Definition at line 106 of file Profiler.py.

isStarted

app.Profiler.Profiler.isStarted

Definition at line 100 of file Profiler.py.

limit

app.Profiler.Profiler.limit

Definition at line 103 of file Profiler.py.

logger

app.Profiler.Profiler.logger

Definition at line 99 of file Profiler.py.

MESSAGES_ITEMS_DELIMITER

string app.Profiler.Profiler.MESSAGES_ITEMS_DELIMITER = ","

static

Constans for global message list of strings in the final message for profiler records.

Definition at line 62 of file Profiler.py.

MSG_ERROR_EMPTY_CONFIG_FILE_NAME

string app.Profiler.Profiler.MSG_ERROR_EMPTY_CONFIG_FILE_NAME = "Config file name is empty."

static

Definition at line 36 of file Profiler.py.

MSG_ERROR_LOAD_APP_CONFIG

string app.Profiler.Profiler.MSG_ERROR_LOAD_APP_CONFIG = "Error loading application config file."

static

Definition at line 38 of file Profiler.py.

MSG_ERROR_PARSE_CMD_PARAMS

string app.Profiler.Profiler.MSG_ERROR_PARSE_CMD_PARAMS = "Error parse command line parameters."

static

Constants error messages used in class.

Definition at line 35 of file Profiler.py.

MSG_ERROR_READ_LOG_CONFIG

string app.Profiler.Profiler.MSG_ERROR_READ_LOG_CONFIG = "Error read log config file."

static

Definition at line 39 of file Profiler.py.

MSG_ERROR_WRONG__OPTION_SORTBY

string app.Profiler.Profiler.MSG_ERROR_WRONG__OPTION_SORTBY = "Read wrong value of 'sortby' from config"

static

Definition at line 41 of file Profiler.py.

MSG_ERROR_WRONG_CONFIG_FILE_NAME

string app.Profiler.Profiler.MSG_ERROR_WRONG_CONFIG_FILE_NAME = "Config file name is wrong"

static

Definition at line 37 of file Profiler.py.

MSG_ERROR_WRONG_CONFIG_OPTION

string app.Profiler.Profiler.MSG_ERROR_WRONG_CONFIG_OPTION = "Wrong format option"

static

Definition at line 40 of file Profiler.py.

parser

app.Profiler.Profiler.parser

Definition at line 98 of file Profiler.py.

pr

app.Profiler.Profiler.pr

Definition at line 108 of file Profiler.py.

PROFILER_OPTION_LIMIT

string app.Profiler.Profiler.PROFILER_OPTION_LIMIT = "limit"

static

Definition at line 47 of file Profiler.py.

PROFILER_OPTION_LIMIT_DEFAULT

float app.Profiler.Profiler.PROFILER_OPTION_LIMIT_DEFAULT = 1.0

static

Definition at line 54 of file Profiler.py.

PROFILER_OPTION_LOG

string app.Profiler.Profiler.PROFILER_OPTION_LOG = "log"

static

Constans profiler options read from config.

Definition at line 44 of file Profiler.py.

PROFILER_OPTION_SORTBY

string app.Profiler.Profiler.PROFILER_OPTION_SORTBY = "sortby"

static

Definition at line 46 of file Profiler.py.

PROFILER_OPTION_SORTBY_ALLOWED_LIST

list app.Profiler.Profiler.PROFILER_OPTION_SORTBY_ALLOWED_LIST = ['stdname', 'calls', 'time', 'cumulative']

static

Constans allowed values of 'sortby'.

Definition at line 59 of file Profiler.py.

PROFILER_OPTION_SORTBY_DEFAULT

string app.Profiler.Profiler.PROFILER_OPTION_SORTBY_DEFAULT = "cumulative"

static

Definition at line 53 of file Profiler.py.

PROFILER_OPTION_STATUS

string app.Profiler.Profiler.PROFILER_OPTION_STATUS = "profile"

static

Definition at line 45 of file Profiler.py.

PROFILER_OPTION_STATUS_DEFAULT

int app.Profiler.Profiler.PROFILER_OPTION_STATUS_DEFAULT = 0

static

Constans default values of profiler options.

Definition at line 52 of file Profiler.py.

PROFILER_OPTION_TRACEBACK

string app.Profiler.Profiler.PROFILER_OPTION_TRACEBACK = "traceback"

static

Definition at line 48 of file Profiler.py.

PROFILER_OPTION_TRACEBACK_DEFAULT

int app.Profiler.Profiler.PROFILER_OPTION_TRACEBACK_DEFAULT = 0

static

Definition at line 55 of file Profiler.py.

PROFILER_OPTION_TRACEBACK_LOGGER_MODE

string app.Profiler.Profiler.PROFILER_OPTION_TRACEBACK_LOGGER_MODE = "tracebackLoggerMode"

static

Definition at line 49 of file Profiler.py.

PROFILER_OPTION_TRACEBACK_LOGGER_MODE_DEFAULT

int app.Profiler.Profiler.PROFILER_OPTION_TRACEBACK_LOGGER_MODE_DEFAULT = 1

static

Definition at line 56 of file Profiler.py.

sortby

app.Profiler.Profiler.sortby

Definition at line 102 of file Profiler.py.

status

app.Profiler.Profiler.status

Definition at line 101 of file Profiler.py.

traceback

app.Profiler.Profiler.traceback

Definition at line 104 of file Profiler.py.

tracebackLoggerMode

app.Profiler.Profiler.tracebackLoggerMode

Definition at line 105 of file Profiler.py.

tracebackOptions

dictionary app.Profiler.Profiler.tracebackOptions

static

Initial value:

=  {'tracebackIdent':Utils.tracebackIdent,
                      'tracebackIdentFiller':Utils.tracebackIdentFiller,
                      'tracebackMessageCall':Utils.tracebackMessageCall,
                      'tracebackMessageExit':Utils.tracebackMessageExit,
                      'tracebackmessageDelimiter':Utils.tracebackmessageDelimiter,
                      'tracebackTimeMark':Utils.tracebackTimeMark,
                      'tracebackTimeMarkFormat':Utils.tracebackTimeMarkFormat,
                      'tracebackTimeMarkDelimiter':Utils.tracebackTimeMarkDelimiter,
                      'tracebackIncludeInternalCalls':Utils.tracebackIncludeInternalCalls,
                      'tracebackIncludeLineNumber':Utils.tracebackIncludeLineNumber,
                      'tracebackIncludeLineNumberDelimiter':Utils.tracebackIncludeLineNumberDelimiter,
                      'tracebackIncludeFileNumber':Utils.tracebackIncludeFileNumber,
                      'tracebackIncludeFileNumberDelimiter':Utils.tracebackIncludeFileNumberDelimiter,
                      'tracebackFunctionNameDelimiter':Utils.tracebackFunctionNameDelimiter,
                      'tracebackExcludeModulePath':Utils.tracebackExcludeModulePath,
                      'tracebackExcludeFunctionName':Utils.tracebackExcludeFunctionName,
                      'tracebackExcludeFunctionNameStarts':Utils.tracebackExcludeFunctionNameStarts,
                      'tracebackIncludeExitCalls':Utils.tracebackIncludeExitCalls,
                      'tracebackRecursionlimit':Utils.tracebackRecursionlimit,
                      'tracebackRecursionlimitErrorMsg':Utils.tracebackRecursionlimitErrorMsg,
                      'tracebackIncludeLocals':Utils.tracebackIncludeLocals,
                      'tracebackIncludeArg':Utils.tracebackIncludeArg,
                      'tracebackIncludeLocalsPrefix':Utils.tracebackIncludeLocalsPrefix,
                      'tracebackIncludeArgPrefix':Utils.tracebackIncludeArgPrefix,
                      'tracebackElapsedTimeDelimiter':Utils.tracebackElapsedTimeDelimiter,
                      'tracebackElapsedTimeFormat':Utils.tracebackElapsedTimeFormat,
                      'tracebackUnknownExceptionMsg':Utils.tracebackUnknownExceptionMsg}

Constans traceback config options (key - options name, value - default.

Definition at line 65 of file Profiler.py.

---

The documentation for this class was generated from the following file:

• sources/hce/app/Profiler.py