Skip to content

Commit

Permalink
foo
Browse files Browse the repository at this point in the history
  • Loading branch information
gkennedy12 committed Nov 22, 2024
1 parent c0b5d9b commit 91faecf
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions adaptived/doc/internal/list-of-built-in-effects.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Parameters that accept long long or float also support some human-readable forma
| [logger](../../src/effects/logger.c) | Given an array of files, write their contents to "logfile" | <ul><li>"logfile" (string) - Output file to store the log data</li><li>"max_file_size" (int - optional) - Maximum amount of data that will be copied from each source file. Defaults to 32kB if not specified</li><li>"files" (array)<ul><li>"file" (string) - file to copy</li></ul></li><li>"separator_prefix" (string - optional) - If specified, this string will be written each time this effect triggers</li><li>"date_format" (string - optional) - If specified, the date will be written in the specified format each time the effect triggers</li><li>"utc" (boolean - optional) - If specified, the date will be recorded in UTC time. Otherwise, the machine's localtime() will be used</li><li>"separator_postfix" (string - optional) - If specified, this string will be written each time this effect triggers</li><li>"file_separator" (string - optional) -If specified, this string will be written between each file being logged</li></ul> | [ftest 043](../../tests/ftests/043-effect-logger-no-separators.json)<br />[ftest 044](../../tests/ftests/044-effect-logger-date-format.json) | |
| [print](../../src/effects/print.c) | Print a message to a file | <ul><li>"message" (string - optional) - message to output</li><li>"file" (string) - file to write to. Currently only supports "stdout" or "stderr"</li></ul> | [Jimmy Buffett Example](../examples/jimmy-buffett-config.json) | |
| [print_schedstat](../../src/effects/print_schedstat.c) | Print schedstat to a file | <ul><li>"file" (string) - file to write to. Currently only supports "stdout" or "stderr"</li></ul> | [ftest 054](../../tests/ftests/054-effect-print_schedstat.json) | |
| [sd_bus_setting](../../src/effects/sd_bus_setting.c) | Operate on sd_bus properties | <ul><li>"target" (string) - cgroup slice or scope name</li><ul><li>"setting" (string) - sd_bus property name (e.g. MemoryMax)</li><li>"value" (string, long long, or double) - value to write to the property. If the operator is set to add or subtract, this value will be added/subtracted from the current value of property</li><li>"operator" (string) - add, subtract, or set</li><li>"limit" (string, long long, or double - optional) - if provided, this effect will use the value as an upper or lower limit when the operator is set to add or subtract, respectfully</li><li>"validate" (boolean - optional) - if true, the setting effect will read from the property to ensure the value was properly set</li></ul> | [ftest 1000](../../tests/ftests/1000-sudo-effect-sd_bus_setting_set_int.json)<br />[ftest 1001](../../tests/ftests/1001-sudo-effect-sd_bus_setting_add_int.json)<br />[ftest 1002](../../tests/ftests/1002-sudo-effect-sd_bus_setting_sub_int.json)<br />[ftest 1003](../../tests/ftests/1003-sudo-effect-sd_bus_setting-CPUQuota.json)<br />[ftest 1004](../../tests/ftests/1004-sudo-effect-sd_bus_setting_add_int_infinity.json)<br />[ftest 1005](../../tests/ftests/1005-sudo-effect-sd_bus_setting_sub_infinity.json)<br />[ftest 1006](../../tests/ftests/1006-sudo-effect-sd_bus_setting_set_int_scope.json)<br />[ftest 1007](../../tests/ftests/1007-sudo-effect-sd_bus_setting_set_str.json) | Shares a code base with the cgroup effect code |
| [setting](../../src/effects/cgroup_setting.c) | Write to a setting file | <ul><li>"setting" (string) - full path to the setting</li><li>"value" (string, long long, or double) - value to write to the setting file. If the operator is set to add or subtract, this value will be added/subtracted from the current value of setting</li><li>"operator" (string) - add, subtract, or set</li><li>"limit" (string, long long, or double - optional) - if provided, this effect will use the value as an upper or lower limit when the operator is set to add or subtract, respectfully</li><li>"validate" (boolean - optional) - if true, the setting effect will read from the setting file to ensure the value was properly set</li></ul> | [ftest 055](../../tests/ftests/055-effect-setting_set_int.json)<br />[ftest 056](../../tests/ftests/056-effect-setting_add_int.json)<br />[ftest 057](../../tests/ftests/057-effect-setting_sub_int.json) | Shares a code base with the cgroup effect code |
| [signal](../../src/effects/kill_processes.c) | Send a signal to the process(es) that match the user-specified process name(s) | <ul><li>"proc_names" (array)<ul><li>"name" (string) - process name (as found in /proc/{pid}/stat)</li></ul></li><li>"signal" (int - optional) - signal to send to the processes being killed. Curently only supports integers. Default - 10 (i.e. SIGUSR1)</li></ul> | [ftest_069](../../tests/ftests/069-effect-signal.json) | |
| [snooze](../../src/effects/snooze.c) | Once the cause(s) in a rule have triggered, snooze (i.e. ignore any more triggers) for a specified duration | <ul><li>"duration" (int) - how long to ignore triggers, in interval milliseconds</li></ul> | [ftest 010](../../tests/ftests/010-snooze_effect.json) | |
Expand Down

0 comments on commit 91faecf

Please sign in to comment.