diff --git a/docs/Logs.md b/docs/Logs.md index da2bc0f..97554b4 100644 --- a/docs/Logs.md +++ b/docs/Logs.md @@ -11,4 +11,18 @@ _Elektron_ logs can be categorized into the following. * _**Scheduling Policy Switching Logs**_ - When scheduling policy switching is enabled (`-switchSchedPol` is used when launching _Elektron_), the following information is logged. * [**Scheduling Policy Switch trace (SPS)**](data/withSpsEnabled/SchedulingPolicySwitchTrace.md) - Every time _Elektron_ switches to a different scheduling policy, the _name_ of the scheduling policy and the corresponding _time stamp_ is logged.
* [**SCHED_WINDOW**](data/withSpsEnabled/SchedulingWindow.md) - For every switch, the size of the scheduling window and the name of the scheduling policy is logged. - * [**CLSFN_TASKDIST_OVERHEAD**](data/withSpsEnabled/TaskClassificationOverhead.md) - If the switching criteria is task distribution based, then the time taken to classify the tasks into low power consuming and high power consuming, and then to determine the task distribution is logged. + * [**CLSFN_TASKDISTR_OVERHEAD**](data/withSpsEnabled/TaskClassificationOverhead.md) - If the switching criteria is task distribution based, then the time taken to classify the tasks into low power consuming and high power consuming, and then to determine the task distribution is logged. + +_Elektron_ logs can be configured through [Log config file](../logConfig.yaml). The following is the format for configuration. +``` +: + enabled: + filenameExtension: + minLogLevel: + allowOnConsole: +``` +The file has default configurations set. One can also configure the above fields for every log type. +* `enabled` - Enable or disable a specific log type. +* `filenameExtension` - Provide the file extension for specific log type. +* `minLogLevel` - Provide a minimum log level above which all logs should be logged. This is available only for Console log type. The default value is debug). +* `allowOnConsole` - Allow or Disallow a specific log type on the console. diff --git a/docs/data/PCP.md b/docs/data/PCP.md index 790102f..9e5a432 100644 --- a/docs/data/PCP.md +++ b/docs/data/PCP.md @@ -25,12 +25,12 @@ myhost:kernel.all.cpu.sys When we run the `pmdumptext` command mentioned above for 5 seconds, the PCP log from _Elektron_ would be as shown below. ``` - myhost:kernel.all.cpu.user,myhost:kernel.all.cpu.sys - , - , - , - , - , +[]: myhost:kernel.all.cpu.user,myhost:kernel.all.cpu.sys +[]: , +[]: , +[]: , +[]: , +[]: , ``` ## Power Measurements diff --git a/docs/data/ScheduledTrace.md b/docs/data/ScheduledTrace.md index 4d62bc0..380d072 100644 --- a/docs/data/ScheduledTrace.md +++ b/docs/data/ScheduledTrace.md @@ -9,6 +9,6 @@ The scheduled trace logs are written to a file named _\\_\ : +[]: = ``` diff --git a/docs/data/withSpsEnabled/SchedulingPolicySwitchTrace.md b/docs/data/withSpsEnabled/SchedulingPolicySwitchTrace.md index 4cf2984..b0c1cb8 100644 --- a/docs/data/withSpsEnabled/SchedulingPolicySwitchTrace.md +++ b/docs/data/withSpsEnabled/SchedulingPolicySwitchTrace.md @@ -8,7 +8,7 @@ The logs are written to a file named _\\_\\_schedPol The format of the data logged is as shown below. ``` - +[]: Name= ``` _Note: The names of the scheduling policies can be found [here](https://gitlab.com/spdf/elektron/blob/master/schedulers/store.go#L14)_ diff --git a/docs/data/withSpsEnabled/SchedulingWindow.md b/docs/data/withSpsEnabled/SchedulingWindow.md index 0b47bf2..284b09c 100644 --- a/docs/data/withSpsEnabled/SchedulingWindow.md +++ b/docs/data/withSpsEnabled/SchedulingWindow.md @@ -8,5 +8,5 @@ The logs are written to a file named _\\_\\_schedWin The format of the data logged is as shown below. ``` - -``` \ No newline at end of file +[]: Window size=, Name= +``` diff --git a/docs/data/withSpsEnabled/TaskClassificationOverhead.md b/docs/data/withSpsEnabled/TaskClassificationOverhead.md index 98a52af..a15eb47 100644 --- a/docs/data/withSpsEnabled/TaskClassificationOverhead.md +++ b/docs/data/withSpsEnabled/TaskClassificationOverhead.md @@ -8,7 +8,7 @@ The logs are written to a file named _\\_\\_classifi The format of the data logged is as shown below. ``` - +[]: Overhead in microseconds= ``` _Note: The classification overhead is logged in **microseconds**._