SAMPLE.CONF

Section: Sample (5)
Updated: August 2007
Index Return to Main Contents
 

NAME

sample.conf - configuration options for sampled  

SYNOPSIS

/etc/sample.conf  

DESCRIPTION

sample.conf contains configutation settings for sampled to process at launch time.

the supported options for sample.conf expect no extra spaces between option names and option values. they are set as option=value.

the supported options are as follows:

interval=VALUE
makes sampled process ~/.sample files every VALUE number of minute(s), instead of every single minute

log_file=VALUE
specify an alternate log file to write sampled warnings/errors to

pid_file=VALUE
specify an alternate pid file to write to

user_priority=VALUE
makes the sampled user processes (processors) run with the process priority VALUE (-20 to 20)

daemon_priority=VALUE
makes the sampled daemon (core) process run with the process priority VALUE (-20 to 20)

[+-]allow_noshell
allows users that have shells outside of the /etc/shells file to have processable ~/.sample files (depending on the system, this may be a forced option)

[+-]allow_setshell
allows users to set their own shell for handling outdated files. this is set via the SHELL=/path/to/sh in the user's ~/.sample file

[+-]allow_multiple_processes
allows multiple processes (processors) for a single user. this is to say that if the previous instance of the sampled processor was running for a particular user it would allow the daemon to run another, where normally it would not. essentially, this means, by default, a user is given one main process to handle their ~/.sample files, this option turns that off and allows multiple processest (this will stop the monitoring of this level of processes due to potential overhead, which may result in less sample.log logging and minimal functionality loss)

[+-]allow_multiple_user_processes
allows multiple (sub) processes for a user's processor instance, so it does not wait for the previous (sub) process to finish. this is a bad idea to enable, and leads to a high level of processes at one time (this will stop the monitoring of this level of processes due to potential overhead, which may result in less sample.log logging and minimal functionality loss)

users_allow=USER:USER:...
allows only the specified list of users to have executable ~/.sample files. by default, all users are allowed (users_allow and user_deny cannot be used together, if multiple instances are set only the first one will be used)

users_deny=USER:USER:...
disallows the specified list of users from having executable ~/.sample files, and allows all other users. by default, all users are allowed (users_allow and user_deny cannot be used together, if multiple instances are set only the first one will be used)

limit_cpu=VALUE
limit cpu usage to VALUE seconds of actual processor usage before it is killed, RLIMIT_CPU equivalent (0 is ignored, option where available)

limit_processes=VALUE
RLIMIT_NPROC equivalent (0 is ignored, option where available)

limit_stack=VALUE
RLIMIT_STACK equivalent (0 is ignored, option where available)

limit_data=VALUE
RLIMIT_DATA equivalent (0 is ignored, option where available)

limit_files=VALUE
RLIMIT_NOFILE equivalent (0 is ignored, option where available)

limit_filesize=VALUE
RLIMIT_FSIZE equivalent (0 is ignored, option where available)

limit_rss=VALUE
RLIMIT_RSS equivalent (0 is ignored, option where available)

spool_maxfiles=VALUE
process a maximum VALUE of spooled sample (~/.sample_spool/*) files per user for a given sample processor (samples related)

spool_ttl_default=VALUE
uses VALUE as the time-to-live value for spooled sample files (~/.sample_spool/*), if no time-to-live was specified from the samples program (samples related)

spool_ttl_max=VALUE
uses VALUE as the maximum time-to-live value for spooled sample files (~/.sample_spool/*), this will override user-specified time-to-live values (samples related)

[+-]disable_tabs
disable processing of /etc/sampletab/* files.

[+-]disable_sample
disable processing of ~/.sample files.

[+-]disable_spools
disable processing of ~/.sample_spools/* files.

 

AUTHOR

Written by v9/fakehalo. [v9@fakehalo.us]  

BUGS

Report bugs to <v9@fakehalo.us>.  

COPYRIGHT

Copyright © 2007 fakehalo.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  

SEE ALSO

sample(1) samples(1) sampled(8) samputil(8)


 

Index

NAME
SYNOPSIS
DESCRIPTION
AUTHOR
BUGS
COPYRIGHT
SEE ALSO

This document was created by man2html, using the manual pages.