root/fi.utu.tech.powergoblin.export

Package-level declarations

Types

class GenerationFailureException(reason: String, val log: List<String>)

class LogFilePaths(session: SessionData, val logPath: String = session.logPath, val logRoot: <Error class: unknown class> = Path.of(session.globalConfiguration().logPath).toAbsolutePath())

Immutable structure representing the various paths to session files.

LogWriter

class LogWriter(initialSession: Session)

PlotGenerator

class PlotGenerator(val config: PlotConfiguration, val executor: <Error class: unknown class>)

Generator for plots.

Functions

averaging

fun averaging(coordinates: List<Coordinate>, maxDataPoints: Int?): List<Coordinate>

averagingSafe

fun averagingSafe(coordinates: List<Coordinate>, maxDataPoints: Int?): List<Coordinate>

calculateGenericStatistics

fun MeasurementSummary.calculateGenericStatistics(plans: List<GenericStatisticsPlan> = GenericStatisticsPlan.generic(), summarizeRun0: Boolean, includedRuns: List<RunSummary> = includedRuns(summarizeRun0)): List<QuantityStatistics>

Generic stats for a measurement. These are calculated quickly from the data already in memory without the need to go through the events.

exportMeterEventScatterGraph

fun exportMeterEventScatterGraph(session: SessionData, meterFilter: String? = null, channelFilter: String? = null, measurementFilter: Int? = null, maxDataPoints: Int? = null): ScatterGraph

Generates the data sets for all the scatter graphs of meter data.

exportResourceEventScatterGraph

fun exportResourceEventScatterGraph(session: SessionData, unitFilter: String? = null, resourceFilter: String? = null, measurementFilter: Int? = null, maxDataPoints: Int? = null): ScatterGraph

Generates the data sets for all the scatter graphs of resource data.

exportStatistics

fun exportStatistics(session: SessionData, triggers: List<TriggerEvent> = session.triggerEvents(), flags: GenericFlags = session.globalConfiguration().flags): SessionStatistics

Calculates all statistics for the session.

importCollectd

fun importCollectd(inputStream: <Error class: unknown class>, session: Session, unitOverride: String?, maxSize: Long): ResourceConsumptionDumpEvent

Import data from collectd. The data is stored as a zip that contains all the generated log files stored using collectd's directory layout.

importReportTemplate

fun importReportTemplate(inputStream: <Error class: unknown class>, maxSize: Long): ReportTemplateEvent

Obtains a template file from the input stream. There is a size limiter to avoid DoS attacks and erroneous input. The received file is converted to a ReportTemplateEvent, which mainly contains the document + timestamps.

parseCollectdHttpLine

fun parseCollectdHttpLine(line: String, unitOverride: String? = null): List<ResourceConsumptionEvent>?

parseTemplate

fun parseTemplate(content: String): MarkdownDocument

processTemplate

fun processTemplate(content: String): ReportTemplate

Processes a report template. The content must consist of a front-matter section and a Markdown document.