com.konakartadmin.bl

Class AdminLogFileBatchMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBatchBaseMgr

com.konakartadmin.bl.AdminLogFileBatchMgr

public class AdminLogFileBatchMgr
extends AdminBatchBaseMgr

The AdminLogFileBatchMgr

Nested Class Summary

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

AdminBatchBaseMgr.CustTagCounter

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

log

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminLogFileBatchMgr(KKAdminIf eng)

Method Summary

Modifier and Type	Method and Description
java.lang.String	apiAnalysis(java.lang.String logName, java.lang.String appendLogStr, java.lang.String apiLog, java.lang.String resultsFile, java.lang.String todayOnlyStr, java.lang.String fullWondLogStr, java.lang.String topNStr) This batch job is used as to analyse the performance of APIs from entries in the log files.

Methods inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

ensureCustomerTagIsPresent, getAdEngConf, getAdminJsonEngine, getBatchLogName, getBoolean, getCustomerTagsHash, getInt, getIntArray, getIntArray, getLiteCustomerCriteria, getLiteCustomers, getLogName, getOrders, getSkuForProduct, insertOrUpdateCustomerTag, trimMultiTag, validateTemplate

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, refreshConfigs, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, updateStaticVariablesNow

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdminLogFileBatchMgr

public AdminLogFileBatchMgr(KKAdminIf eng)
                     throws java.lang.Exception

Parameters:

eng - the eng the KKAdmin engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

apiAnalysis

public java.lang.String apiAnalysis(java.lang.String logName,
                                    java.lang.String appendLogStr,
                                    java.lang.String apiLog,
                                    java.lang.String resultsFile,
                                    java.lang.String todayOnlyStr,
                                    java.lang.String fullWondLogStr,
                                    java.lang.String topNStr)
                             throws java.lang.Exception

This batch job is used as to analyse the performance of APIs from entries in the log files. This requires certain log settings in the konakart-logging.xml file. See details in the README file under utils/apiAnalysis.

Parameters:

logName - The name of the log for this batch job which shouldn't include the path. e.g. myLog.log

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

apiLog - the name of the log file containing the API entries to be analysed. Enter just the name of the file (eg "KonaKartPerf.log"). It is assumed to be placed in the logs directory under the KonaKart home directory.

resultsFile - the name of the file where the results will be written. Enter just the name of the file without the extension (eg "api"). It will be written to webapps/konakartadmin/ under the KonaKart home directory and have ".html" added as the extension.

todayOnlyStr - If true only log lines created today will be included in the analysis

fullWondLogStr - If true a section containing the full WOND log analysis is included in the results. (Beware that this can be very large if the log being analysed is very large).

topNStr - Reports on the top N calls in each category. A typical value for this would be 10.

Returns:

Returns a String with a brief summary of what happened in the job.

Throws:

java.lang.Exception - an unexpected exception