-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.ini-example
175 lines (155 loc) · 6.62 KB
/
config.ini-example
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
; This is a sample configuration file for Besearcher
; Specify the amount of information produced in the logs. Available
; levels are: 0 (debug), 1 (infos), 2 (warnings) and 3 (errors)
log_level = 1
; Number of seconds to wait to check for tasks to run or changes in this INI file
refresh_interval = 1
; Number of seconds to wait between internal cron jobs, such as e-mails
cron_jobs_interval = 300
; Directory the app will use to store results produced by issued
; commands, as well as internal info.
data_dir = "C:\wamp\www\besearcher\data\"
; A unique string, containing only letters and numbers, no spaces nor
; punctuation marks, that will be used to identify the experiment and
; control some data files. Each one of your experiments should have its own
; hash, so you can track them individually. If nothing is specified,
; the md5 of this INI file will be used as experiment hash.
experiment_hash = "f692c011132399849af0b9127e2b8541575f9ff2"
; An optional message that describes this experiment.
experiment_description = "Edit your config.ini file to change this description."
; If set to true, a task will only be executed if it has no existing result
; files related to it (task was already executed in the past). If set to false,
; all tasks will be executed, no matter if there are indications that it has
; alreaby been executed.
skip_performed_tasks = false
; Max number of concurrent tasks to be executed
max_parallel_tasks = 5
; Command to be executed for this experiment.
; The executed command can output special sequences of characters,
; named Besearcher Log Tags, to inform besearcher about its status,
; such as progression and results. Below is a list of possible tags.
;
; [BSR] {"type": "progress", "data": 0.1}
; [BSR] {"type": "result", "name": "Accuracy", "data": 0.1}
;
; The command below can be parametrized using the values in the [task_params]
; section. Check that section for more info.
task_cmd = "php {@besearcher_cmd_dir}dummy.php {@domain} {@jumps}"
; Command to be executed once as a preparation for "task_cmd"
; to be executed. While "task_cmd" is executed for every new
; permutation, "setup_cmd" is executed only once.
; This command is useful to create datasets that are needed by the
; task command, for instance. Besearcher will check the return
; status of this command to determine if everything is good to
; continue. If the command returns a non-zero value, Besearcher
; assumes a problem occured and interrups the execution of
; the task commands until the problem is solved.
setup_cmd = ""
; Absolute path to the directory to be used as the working
; directory for issued commands.
task_cmd_working_dir = "C:\wamp\www\besearcher\"
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; This section contains the values that will be used
; to parametrize the task indicated by "task_cmd".
; Before executing the task_cmd string, besearcher will
; replace its generated permutation strings with the values
; informed in this section. Any param under this section
; can be used as {@name} in the "task_cmd" string. For instance,
; the following configuration:
;
; task_cmd = test.exe --blah={@data} {@debug} --input={@files}
;
; [task_params]
; data = hi
; debug = -d
; files[] = 1
; files[] = 2
;
; will produce the following strings to be executed:
;
; test.exe --blah=hi -d --input=1
; test.exe --blah=hi -d --input=2
;
; In that case, {@data} is replaced by the value of the param
; named "data" within the [task_cmd_params] section, as well as {@debug} is
; replaced by the value of the param "debug" (which is -d). The value
; of {@files} will be replaced by 1 and by 2, because {@files} was defined
; as an array. If more than one param is defined as an array, Besearcher
; will generate all possible permutations with the informed param values.
;
; There are special expressions that will be expanded by Besearcher, which
; makes it easy to write a lot of values with a single line. Below are
; all evailable expresions:
;
; START..END:INC
; This expresions can be used with arrays containing a single element and they
; generate a set of numbers from START to END, incremented acording to INC.
; E.g.
; values[] = 0..3:1
; will be expanded to:
; values[] = 0
; values[] = 1
; values[] = 2
; values[] = 3
;
; perm:MIN:value,value2,...,valueN
; This expresions can be used with arrays containing a single element and they
; generate all combinations of the provided values, excluding groups
; with less than MIN elements.
; E.g.
; values[] = perm:2:v0,v1,v2
; will be expanded to:
; values[] = v1,v2
; values[] = v0,v2
; values[] = v0,v1
; values[] = v0,v1,v2
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
[task_cmd_params]
domain[] = "google.com"
domain[] = "google.se"
jumps = 5
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; This section controls how Besearcher should send e-mails.
; Select, for instance, an SMTP server that will be used to
; dispatch e-mails.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
[email]
; Configuration params to customize e-mails sent by Besearcher
sender_email = besearcher@besearcher.com
sender_name = Besearcher
subject_tag = [BESEARCHER]
text_footer = ----\nThis message was automatically sent by Besearcher.
; Settings to instruct Besearcher to use a REST API to send e-mails.
; This is useful when Besearcher don't have access to a SMTP server,
; for instance.
; Recommended service: https://github.com/Dovyski/pigeon
use_email_api = false
email_api_endpoint =
; SMTP settings that will be used to send the e-mails. It is possible
; to set "use_smtp" to false to instruct Besearcher not to use SMTP.
use_smtp = false
smtp_host = smtp.gmail.com
smtp_user =
smtp_password =
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; This section controls the process of sending e-mails to
; alert about important events.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
[alerts]
; Destination e-mail that will receive all messages
email =
; If Besearcher should alert about changes of metric values in the
; analytics page.
alert_when_analytics_change = 1
; Informs Besearcher which metrics and how it should monitor them.
; Use "analytics_monitor_min" to tell Besearcher to send an
; e-mail if the min value of a metric has changed, or "analytics_monitor_max"
; to alert if the max value of a matric has changed.
; E.g.
; analytics_monitor_min[] = Accuracy
;
; will send an e-mail every time the min value of the metric "Accuracy" changes.
; It is possible to monitor several metrics at the same time, e.g.:
; analytics_monitor_min[] = Accuracy
; analytics_monitor_max[] = Accuracy
; analytics_monitor_max[] = Precision