oshi.properties

# This properties file is automatically loaded at startup of the GlobalConfig
# class. The defaults below may be overwritten by either replacing this file
# with your own equivalent file on the class path, or programmatically using
# GlobalConfig.set(<property name>, <value>);
#
# The property names are included as constants in the GlobalConfig class for
# convenience.

# Some containers enable alternate locations for the Linux /proc filesystem
# or other common paths to provide container-level output in preference to
# system-level output.
# The /proc filesystem location
oshi.util.proc.path=/proc
# The /sys filesystem location
oshi.util.sys.path=/sys
# The /dev filesystem location
oshi.util.dev.path=/dev

# The WMI query timeout in milliseconds
# Default is -1, no timeout
oshi.util.wmi.timeout=-1

# Whether to perform WMI queries for command lines in a batch for all running
# processes. Individual WMI queries for the command line take about 50ms while
# querying the entire process list takes about 200ms. If you regularly expect
# to query command lines for more than a few processes this should be enabled
# for better performance. If you only rarely query command lines, leaving this
# disabled will be faster and conserve some resources. Defaults to false.
oshi.os.windows.commandline.batch=false

# Whether to update the OSProcess state on Windows to SUSPENDED if all its
# threads are suspended. This requires querying thread states and can impact
# performance as Process list queries can take much longer. Users may still
# determine this value themselves by querying process thread details and
# checking if all are suspended, but may use this switch if they desire this
# check done for many processes at once.
oshi.os.windows.procstate.suspended=false

# Whether to use "Processor Utility" for System and per-processor CPU Load ticks
# (on Windows 8 and higher) to match CPU usage with the Windows Task Manager.
#
# Windows Task Manager displays a measure of Processor Utility, which is an
# amount of work completed by the processor compared to the processor running
# full time at nominal frequency. Because of features which change CPU frequency
# such as Intel Speed Step, Intel Turbo Boost, AMD Precision Boost, and others,
# it is possible for this value to exceed 100% (although Task Manager caps it
# at 100%).
#
# By default, OSHI uses "Processor Time" which measures active and idle times
# for each processor. CPU load is active time divided by total time. This matches
# the interpretation of Unix-based systems, the Task Manager for Windows 7 and
# earlier, The Task Manager "Details" tab for Process CPU usage (and OSHI's
# per-process CPU usage), and Windows Sysinternals Process Explorer.
#
# Setting this value to true will allow OSHI's CPU Load values to match the
# Windows Task manager output (except that OSHI's numbers will not be capped
# at 100%) and will measure "work completed" rather than "processor time not idle".
# In the case load exceeds 100%, it is possible for "idle" ticks to decrease,
# i.e., the change between ticks would result in "negative idle time".
#
# For this calculation to produce meaningful data, the ticks used to calculate
# usage must have come from the same instance of CentralProcessor. Also, the first
# polling interval must be less than 7 minutes to properly initialize values.
oshi.os.windows.cpu.utility=false

# Whether to attempt to fetch Windows performance counter data for processes
# and threads from HKEY_PERFORMANCE_DATA in the registry. Windows docs say
# to use the PDH API in preference to this, but the multiple native calls
# with JNA result in slower performance than a one-time grab of the data
# from the registry. Unfortunately, registry calls are more subject to
# problems with registry corruption, counter deletion when changing language
# settings, and other factors. Although the code will recover from failure
# to read these counters from the registry, it may be preferable to disable
# this attempt if failure is known/expected. Setting this property to false
# will skip the registry check and use the API-recommended (but slower)
# performance counter API (or WMI as a backup).
oshi.os.windows.hkeyperfdata=true

# Whether to start a daemon thread to provide Load Averages for Windows.
# Load Average is a metric on Linux, macOS, and Unix operating systems that
# provides the average number of processes running or waiting for CPU (on
# Linux, the metric includes processes waiting for other resources such as
# disks.) While Windows does not provide this metric, the Processor Queue
# Length performance counter added to the average recent processor usage
# provides a similar metric.
#
# If this property is set true, a daemon thread will be started which will
# calculate an equivalent metric to Unix load average.
oshi.os.windows.loadaverage=false

# Whether a class of performance counters is disabled. It is possible to
# disable performance counters by changing registry values, which can improve
# overall OS performance (such as for gaming) if the counters aren't desired.
#
# When attempting to query counters, OSHI provides a (one time) log warning
# for the performance counter itself and a (each time) COM exception if the
# WMI table backing up the counter fails. The associated log messages can be
# confusing to users or developers of applications which depend on OSHI.
#
# If counters are either intentionally disabled, or the application depending
# on OSHI does not require any of the relevant performance counters, setting
# these values to true will skip querying these counters and return 0 values
# for the associated metrics. No log messages will be generated.
#
# If these values are not set at all, OSHI will query the registry to determine
# whether they are disabled and warn users if this is the case (this is the default).
# The associated Windows registry keys are at:
# HKLM\SYSTEM\CurrentControlSet\Services\PerfOS\Performance\Disable Performance Counters
# HKLM\SYSTEM\CurrentControlSet\Services\PerfProc\Performance\Disable Performance Counters
# HKLM\SYSTEM\CurrentControlSet\Services\PerfDisk\Performance\Disable Performance Counters
# where a value of 0 is not disabled and any other value disables counters.
#
# PerfOS counters used for CPU ticks, swap file usage, page swaps, context switches, interrupts
oshi.os.windows.perfos.disabled=
#
# PerfProc counters used for process and thread priority, time, IO, memory usage
# (also see config for oshi.os.windows.hkeyperfdata)
oshi.os.windows.perfproc.disabled=
#
# PerfDisk counters used for HWDiskStore reads/writes/queue length/xfer time
oshi.os.windows.perfdisk.disabled=

# Assume any performance counter failure means all counters will fail and revert to WMI backup
oshi.os.windows.perf.disable.all.on.failure=false

# Whether to use the Legacy Processor performance counters for System CPU ticks instead of
# Processor Information (since Windows 7). These counters are not processor-group aware
# and may give incorrect results on systems with more than 64 logical processors. Normally on
# Windows the system ticks are obtained by summing up per-processor counters, but on
# some systems, service accounts can not read those values without specific permission.
oshi.os.windows.legacy.system.counters=false

# On Linux, use of udev is normally preferred for loading hardware information such as
# USB devices, power sources, disk information etc. Some details can be loaded
# via sysfs as a backup, but others require udev. To disable use of udev
# and directly use the fallbacks (or omit details that otherwise require udev)
# set this to false. Defaults to true.
oshi.os.linux.allowudev=true

# On Linux, most process metrics are read from the proc pseudo-filesystem.
# On macOS, process environment is read via sysctl
# When operating without elevated permissions, this results in frequent error
# messages for failures to read the process environment files. Set this to true
# to receive these warnings.
oshi.os.linux.procfs.logwarning=false
oshi.os.mac.sysctl.logwarning=false

# On macOS, Linux, and Unix systems, the default getSessions() method on the
# OperatingSystem interface uses native code (see {@code man getutxent}) that
# is not thread safe. OSHI's use of this code is synchronized and may be used
# in a multi-threaded environment without introducing any additional conflicts.
# Users should note, however, that other operating system code may access the
# same native code.
#
# The oshi.driver.unix.Who#queryWho() method produces similar output parsing
# the output of the Posix-standard "who" command, and may internally employ
# reentrant code on some platforms. Setting this configuration to true will
# use the command-line variant.  Defaults to false.
oshi.os.unix.whoCommand=false

# Solaris 11.4 deprecated the previous kstat API and introduced kstat2, with
# additional features. OSHI uses the new API if it is available. However,
# there may be a file descriptor leak when parallel GC is in use. Setting
# this configuration to false will always use the original kstat API even if
# Kstat2 is available.
oshi.os.solaris.allowKstat2=true

# The name of the System event log containing bootup event IDs 12 and 6005.
#
# This is used for a one-time calculation of system boot time that should be
# consistent across process runs regardless of sleep/hibernate cycles, at
# the small cost of ~250ms latency reading upon WindowsOperatingSystem
# initialization.
#
# If the specified log is the empty string, or doesn't contain a bootup event,
# boot time will be calculated by subtracting up time from current time. This
# may vary by up to a millisecond between program executions and does not
# properly account for sleep/hibernate cycles, but when using the empty string
# is fast and may be preferred if only approximate boot time is desired.
#
# If a non-empty invalid log name is specified, the name "Application" will
# be used. The default is System
oshi.os.windows.eventlog=System

# Memoizer default expiration in milliseconds (return values will be cached this long)
# Must be positive (negative value will never refresh)
# Should be less than 1 second
# Default is 300 milliseconds
oshi.util.memoizer.expiration=300

# FileSystem types which are network-based and should be excluded from local-only lists
oshi.network.filesystem.types=afs,cifs,smbfs,sshfs,ncpfs,ncp,nfs,nfs4,gfs,gds2,glusterfs

#  Linux defines a set of virtual file systems
#  "anon_inodefs", anonymous inodes - inodes without filenames
#  "autofs", automounter file system, used by Linux, Solaris, FreeBSD
#  "bdev", keep track of block_device vs major/minor mapping
#  "binfmt_misc", Binary format support file system
#  "bpf", Virtual filesystem for Berkeley Paket Filter
#  "cgroup", Cgroup file system
#  "cgroup2", Cgroup file system
#  "configfs", Config file system
#  "cpuset", pseudo-filesystem interface to the kernel cpuset mechanism
#  "dax", Direct Access (DAX) can be used on memory-backed block devices
#  "debugfs", Debug file system
#  "devpts", Dev pseudo terminal devices file system
#  "devtmpfs", Dev temporary file system
#  "drm", Direct Rendering Manager
#  "ecryptfs", POSIX-compliant enterprise cryptographic filesystem for Linux
#  "efivarfs", (U)EFI variable filesystem
#  "fuse", //
#  NOTE: FUSE's fuseblk is not evalued because used as file system
#  representation of a FUSE block storage
#  "fuseblk" FUSE block file system
#  "fusectl", FUSE control file system
#  "hugetlbfs", Huge pages support file system
#  "inotifyfs", support inotify
#  "mqueue", Message queue file system
#  "nfsd", NFS file system
#  "overlay", Overlay file system https://wiki.archlinux.org/index.php/Overlay_filesystem
#  "pipefs", for pipes but only visible inside kernel
#  "proc", Proc file system, used by Linux and Solaris
#  "pstore", Pstore file system
#  "ramfs", Old filesystem used for RAM disks
#  "rootfs", Minimal fs to support kernel boot
#  "rpc_pipefs", Sun RPC file system
#  "securityfs", Kernel security file system
#  "selinuxfs", SELinux file system
#  "sunrpc", Sun RPC file system
#  "sysfs", SysFS file system
#  "systemd-1", Systemd file system
#  "tmpfs", Temporary file system
#  NOTE: tmpfs is evaluated apart, because Linux, Solaris, FreeBSD use it for
#  RAMdisks
#  "tracefs", thin stackable file system for capturing file system traces
#  "usbfs", removed in linux 3.5 but still seen in some systems
#  FreeBSD / Solaris defines a set of virtual file systems
#  "procfs", Proc file system
#  "devfs", Dev temporary file system
#  "ctfs", Contract file system
#  "fdescfs", fd
#  "objfs", Object file system
#  "mntfs", Mount file system
#  "sharefs", Share file system
#  "lofs" Library file system
#  "SquashFS" read-only filesystem used by snap on eg. Ubuntu
oshi.pseudo.filesystem.types=anon_inodefs,autofs,bdev,binfmt_misc,bpf,cgroup,cgroup2,configfs,cpuset,dax,debugfs,devpts,devtmpfs,drm,ecryptfs,efivarfs,fuse,fusectl,hugetlbfs,inotifyfs,mqueue,nfsd,overlay,proc,procfs,pstore,rootfs,rpc_pipefs,securityfs,selinuxfs,sunrpc,sysfs,systemd-1,tracefs,usbfs,procfs,devfs,ctfs,fdescfs,objfs,mntfs,sharefs,lofs,squashfs

# Paths and volumes to exclude from FileSystem listings on these operating systems.
# These are excluded if they match using PathMatcher syntax.  See
# https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String)
# The "glob:" syntax is automatically added unless another syntax (regex:) is specified.
# Similar syntax may be used for "includes" which take precedence over excludes.

# Note: glob:* mathches all paths not starting with /
oshi.os.aix.filesystem.path.excludes=/run**,/sys**,/dev,/proc**,*
oshi.os.aix.filesystem.volume.excludes=/proc

oshi.os.freebsd.filesystem.path.excludes=/system**,/tmp**,/dev,/dev/fd**
oshi.os.freebsd.filesystem.volume.excludes=rpool*

oshi.os.linux.filesystem.path.excludes=/run**,/sys**,/proc**,/dev,**/shm

oshi.os.mac.filesystem.volume.excludes=devfs,map *

oshi.os.openbsd.filesystem.path.excludes=/tmp**,/dev

oshi.os.solaris.filesystem.path.excludes=/system**,/tmp**,/dev,/dev/fd**
oshi.os.solaris.filesystem.volume.excludes=rpool

# List of hwmon sensor names to detect as CPU temperature, in priority order
# The order of entries in the list does represent the priority, the first match will be used.
# Common values:
# coretemp: Intel CPU temperature
# k10temp: AMD CPU temperature (K10+ cores)
# zenpower: AMD Zen CPU temperature
# k8temp: AMD K8 CPU temperature
# via-cputemp: VIA CPU temperature
# Leave empty to not match hwmon, and instead use thermal zone
oshi.os.linux.sensors.hwmon.names=coretemp,k10temp,zenpower,k8temp,via-cputemp

# List of types inside /sys/class/thermal/thermal_zone*/type to detect as CPU temperature.
# The order of entries in the list does represent the priority, the first match will be used.
oshi.os.linux.sensors.cpuTemperature.types=cpu-thermal,x86_pkg_temp