com.screenscraper.profiling.session

Class ScrapeProfiler

java.lang.Object

com.screenscraper.profiling.session.ScrapeProfiler

All Implemented Interfaces:

LogMappable

public class ScrapeProfiler
extends java.lang.Object
implements LogMappable

Class used for profiling a scrape. This is used in conjunction with the events for a scrape to track which scripts are called the most, and where the majority of time is spent. This is useful for optimizing a slow scrape or finding a problem spot in code. It currently does not support memory use monitoring.

Version:

1.0

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	convertMap() Converts the current object into a mapping of key-value pairs that can be logged
java.lang.String	generateHtmlReport() Returns a full html document string containing the html report of profiling to this point
java.util.List<java.lang.String>	getCurrentStackDescriptions() Returns a list of the descriptions of each element on the stack, in the order they are on the stack
java.util.Set<com.screenscraper.profiling.session.ScrapeProfiler.SessionVariableStats>	getSessionVariablesCompleteStats() Returns the stat summary for session variables
static ScrapeProfiler	profileSession(ScrapingSession session, boolean trackAllThreads) Instruments the session with a profiler and returns the profiler.
void	removeBreakpointOnSessionVariableChange(java.lang.String variableName) Sets the profiler to no longer breakpoint when the session variable with the given name is changed
void	setBreakpointOnSessionVariableChange(java.lang.String variableName) Sets the profiler to breakpoint when the session variable with the given name is changed
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

profileSession

@NotNull
 @RequiredVersion(value=1)
public static ScrapeProfiler profileSession(@NotNull
                                                                                  ScrapingSession session,
                                                                                  boolean trackAllThreads)

Instruments the session with a profiler and returns the profiler. This adds a bunch of event handlers into the session so it can track certain things about the scrape as it runs. Be warned, this will make it run much slower, so this should only be used to find problems or fix slow scrapes

Parameters:

session - The scraping session to profile

trackAllThreads - True if profiling should apply to all threads of this scrape. Mainly this refers to session variable reads / writes done in other threads, such as the DataManager. Setting this to true can give false readings for the reads and writes, as counted per element (scripts, scrapeable files)

Returns:

The profiler which can then be queried to get information about the scrape either during execution of after

setBreakpointOnSessionVariableChange

public void setBreakpointOnSessionVariableChange(@NotNull
                                                 java.lang.String variableName)

Sets the profiler to breakpoint when the session variable with the given name is changed

Parameters:

variableName - The name of the variable

removeBreakpointOnSessionVariableChange

public void removeBreakpointOnSessionVariableChange(@NotNull
                                                    java.lang.String variableName)

Sets the profiler to no longer breakpoint when the session variable with the given name is changed

Parameters:

variableName - The name of the variable

convertMap

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> convertMap()

Description copied from interface: LogMappable

Converts the current object into a mapping of key-value pairs that can be logged

Specified by:

convertMap in interface LogMappable

Returns:

The mapping of key-value pairs to then log

getCurrentStackDescriptions

@NotNull
public java.util.List<java.lang.String> getCurrentStackDescriptions()

Returns a list of the descriptions of each element on the stack, in the order they are on the stack

Returns:

A list of the descriptions of each element on the stack, in the order they are on the stack

getSessionVariablesCompleteStats

@NotNull
public java.util.Set<com.screenscraper.profiling.session.ScrapeProfiler.SessionVariableStats> getSessionVariablesCompleteStats()

Returns the stat summary for session variables

Returns:

The stat summary for session variables

generateHtmlReport

@NotNull
public java.lang.String generateHtmlReport()

Returns a full html document string containing the html report of profiling to this point

Returns:

A full html document string containing the html report of profiling to this point

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object