Repository navigation
Expand file tree
/
Copy pathjoularcodejava.properties.example
More file actions
74 lines (64 loc) · 3.58 KB
/
Copy pathjoularcodejava.properties.example
File metadata and controls
74 lines (64 loc) · 3.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# Copyright (c) 2026, Adel Noureddine.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the
# GNU Lesser General Public License v3.0 (LGPL-3.0-only)
# which accompanies this distribution, and is available at
# https://www.gnu.org/licenses/lgpl-3.0.en.html
#
# Author : Adel Noureddine
# Joular Code for Java: Configuration
#
# A \ starts an escape in this file: on Windows, write paths with / or \\, e.g. C:/Users/me/results
#
# CPU power source
# Options:
# auto (the virtual machine file when vm-power-file is set, else RAPL where there is one and it is readable, else the PowerJoular ring buffer)
# rapl (read Linux RAPL directly, from /sys/class/powercap)
# ringbuffer (read the shared memory ring buffer PowerJoular writes with -r)
# vm (inside a virtual machine, read the file the host writes the power of this virtual machine to, see vm-power-file)
# Default if left empty: auto
power-source-type=
# Path to the ring buffer (used by ringbuffer, and by auto on a machine without a readable RAPL)
# Default if left empty (OS-dependent):
# Linux: /dev/shm/powerjoular
# macOS: /tmp/powerjoular
# FreeBSD: /tmp/powerjoular
# Windows: %PROGRAMDATA%\powerjoular
powerjoular-ringbuffer-path=
# The path to the file where the host writes the power consumption of the guest virtual machine (used by vm, and by auto when set), as seen from the virtual machine
# On the host, powerjoular -p <pid of the virtual machine's process> -o vm-power.csv writes it to vm-power-<pid>.csv
# Example: /mnt/shared/vm-power-4242.csv
vm-power-file=
# The format of the virtual machine file (if power-source-type is vm)
# Options:
# powerjoular (the row PowerJoular rewrites every second with -o for a process: timestamp,cpu_usage,cpu_power)
# watts (the power alone, in watts, used as it is; when it cannot be read, the last value covers up to two more cycles)
# Default if left empty: powerjoular
vm-power-format=
# The sample rate (milliseconds) for the agent to monitor methods usage by calling the JVM stack
# Higher count means less accurate energy data
# Lower count means higher overhead of the agent
# From 1 to 1000
# Default if left empty: 10 (good balance between accuracy and efficiency)
stack-monitoring-sample-rate=
# How many frames of each thread's stack are kept, from the newest one
# A deeper stack loses its oldest frames, so its branch starts lower; a smaller value makes sampling cheaper
# Default if left empty: 64
max-stack-depth=
# Output folder for results. Each run writes into its own sub-folder, <pid>-<yyyyMMdd-HHmmss>
# Default if left empty: joular-code-java-results
results-path=
# Only frames whose package.class.method starts with one of these prefixes are filtered and calculated and written to methods-power-app.csv
# methods-power-all.csv always has every branch (including those of the JDK)
# Several prefixes are separated by a comma, e.g. com.example,org.myapp; any match counts
# Default if left empty: no filter (all branches go to both files)
methods-filtering-prefix=
# Provide measurements by line of code, as the JVM stack trace writes them. Files written are lines-power-all.csv, lines-power-app.csv (ex. com.example.Service.process(Service.java:120)) and lines-power-app-self.csv (the total of each line of the application itself)
# The methods files stay the same
# Options: true, false
# Default if left empty: false
lines-monitoring=
# Write one row per branch when the JVM stops, with its energy and average power over the whole run, instead of a row per monitoring cycle
# Options: true, false
# Default if left empty: false
aggregate=