-
Notifications
You must be signed in to change notification settings - Fork 202
/
system.xml
196 lines (178 loc) · 12.6 KB
/
system.xml
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?xml version="1.0"?>
<config>
<sections>
<system>
<groups>
<cron translate="label comment" module="cron">
<fields>
<enable translate="label">
<label>Enable Scheduler</label>
<sort_order>1</sort_order>
<comment><![CDATA[If this is disabled no scheduled jobs will be executed]]></comment>
<show_in_default>1</show_in_default>
<frontend_type>select</frontend_type>
<source_model>adminhtml/system_config_source_yesno</source_model>
<show_in_website>0</show_in_website>
<show_in_store>0</show_in_store>
</enable>
<mark_as_error_after translate="label">
<label>Mark job as failed after</label>
<comment><![CDATA[A job will be marked es failed after it hasn't been seen for this many minutes (in cases where the process cannot be checked)]]></comment>
<frontend_type>text</frontend_type>
<sort_order>110</sort_order>
<show_in_default>1</show_in_default>
<show_in_website>0</show_in_website>
<show_in_store>0</show_in_store>
</mark_as_error_after>
<max_job_runtime translate="label">
<label>Maximum job runtime</label>
<comment><![CDATA[If set a single job can't run longer than this time (in minutes). If the job is actually still running this process will be actively killed.]]></comment>
<frontend_type>text</frontend_type>
<sort_order>111</sort_order>
<show_in_default>1</show_in_default>
<show_in_website>0</show_in_website>
<show_in_store>0</show_in_store>
</max_job_runtime>
<scheduler_cron_expr_heartbeat>
<label>Heartbeat task schedule (cron syntax)</label>
<frontend_type>text</frontend_type>
<sort_order>120</sort_order>
<show_in_default>1</show_in_default>
<show_in_website>0</show_in_website>
<show_in_store>0</show_in_store>
</scheduler_cron_expr_heartbeat>
<error_email translate="label">
<label>Error Email Recipient</label>
<frontend_type>text</frontend_type>
<sort_order>130</sort_order>
<show_in_default>1</show_in_default>
<show_in_website>0</show_in_website>
<show_in_store>0</show_in_store>
</error_email>
<error_email_identity translate="label">
<label>Error Email Sender</label>
<frontend_type>select</frontend_type>
<source_model>adminhtml/system_config_source_email_identity</source_model>
<sort_order>140</sort_order>
<show_in_default>1</show_in_default>
<show_in_website>0</show_in_website>
<show_in_store>0</show_in_store>
</error_email_identity>
<error_email_template translate="label">
<label>Error Email Template</label>
<frontend_type>select</frontend_type>
<source_model>adminhtml/system_config_source_email_template</source_model>
<sort_order>150</sort_order>
<show_in_default>1</show_in_default>
<show_in_website>0</show_in_website>
<show_in_store>0</show_in_store>
</error_email_template>
<logFile translate="label">
<label>Log file</label>
<frontend_type>text</frontend_type>
<sort_order>160</sort_order>
<comment><![CDATA[Keep empty to disable logging]]></comment>
<show_in_default>1</show_in_default>
</logFile>
<maxNoOfSuccessfulTasks translate="label">
<label>Maximum number of successful schedules to keep</label>
<frontend_type>text</frontend_type>
<sort_order>170</sort_order>
<comment><![CDATA[Only keeps this number of entries for every schedule even if it is shorter than the configured success lifetime. Set to 0 to keep them all until they hit the lifetime.]]></comment>
<show_in_default>1</show_in_default>
</maxNoOfSuccessfulTasks>
<enableRunNow translate="label">
<label>Enable "run now"</label>
<frontend_type>select</frontend_type>
<source_model>adminhtml/system_config_source_yesno</source_model>
<sort_order>180</sort_order>
<comment><![CDATA[Cron tasks are usually designed to run in CLI context and not in the context of the webserver. Also they could run longer than the configured maximum execution time. This is why you should rather use "scheduleNow" instead of "runNow" and let the scheduler pick up the task on the next run. However, if you know what you're doing and/or if you don't want to wait while testing and developing a cron task you can enable this feature here.]]></comment>
<show_in_default>1</show_in_default>
</enableRunNow>
<enableJobOutputBuffer translate="label">
<label>Enable Job Output Buffering</label>
<comment><![CDATA[If this is enabled jobs will capture normal output for storage in the schedule record messages field]]></comment>
<frontend_type>select</frontend_type>
<source_model>adminhtml/system_config_source_yesno</source_model>
<sort_order>200</sort_order>
<show_in_default>1</show_in_default>
</enableJobOutputBuffer>
<enableErrorLog translate="label">
<label>Enable Error Log</label>
<comment><![CDATA[If enabled AOE_Scheduler will bypass Magento's error handling and will capture the error log in a schedule specific file in var/log/cron/]]></comment>
<frontend_type>select</frontend_type>
<source_model>adminhtml/system_config_source_yesno</source_model>
<sort_order>210</sort_order>
<show_in_default>1</show_in_default>
</enableErrorLog>
<errorLevel translate="label">
<label>Error Level</label>
<comment><![CDATA[Error level accepted by 'error_reporting'. This needs to be the int value. Constants are not supported! Example: -1 or 32767 (E_ALL) to log everything.]]></comment>
<frontend_type>text</frontend_type>
<sort_order>220</sort_order>
<show_in_default>1</show_in_default>
<depends>
<enableErrorLog>1</enableErrorLog>
</depends>
</errorLevel>
<errorLogFilename translate="label">
<label>Error log filename</label>
<comment><![CDATA[###PID### will be replaced with the process id.<br />###ID### will be replaced with the job id.<br />###JOBCODE### will be replaced with the job code.]]></comment>
<frontend_type>text</frontend_type>
<sort_order>230</sort_order>
<show_in_default>1</show_in_default>
<depends>
<enableErrorLog>1</enableErrorLog>
</depends>
</errorLogFilename>
<listCodeFilterType translate="label">
<label>Job code filter type in list view</label>
<frontend_type>select</frontend_type>
<source_model>aoe_scheduler/adminhtml_system_config_source_list_code_filtertype</source_model>
<sort_order>240</sort_order>
<show_in_default>1</show_in_default>
</listCodeFilterType>
<cronUser translate="label">
<label>System user for cron</label>
<comment><![CDATA[Specify the system user that should be running cron jobs. If not specified, a warning message will show whenever the scheduler is run suggesting this value be set. You can disable it below.]]></comment>
<frontend_type>text</frontend_type>
<sort_order>250</sort_order>
<show_in_default>1</show_in_default>
</cronUser>
<showCronUserMessage translate="label">
<label>Show cron user message</label>
<comment><![CDATA[If enabled, a warning will be displayed if the system user running the cron does not match the user provided above.]]></comment>
<frontend_type>select</frontend_type>
<source_model>adminhtml/system_config_source_yesno</source_model>
<sort_order>260</sort_order>
<show_in_default>1</show_in_default>
</showCronUserMessage>
<killOnIncorrectUser translate="label">
<label>Kill processes by wrong user</label>
<comment><![CDATA[You can prevent processes from being run as the wrong user by enabling this setting.]]></comment>
<frontend_type>select</frontend_type>
<source_model>adminhtml/system_config_source_yesno</source_model>
<sort_order>270</sort_order>
<show_in_default>1</show_in_default>
</killOnIncorrectUser>
<runOnlyIfCachePrefixIdMatches translate="label">
<label>Run only if cache prefix id matches</label>
<comment><![CDATA[The cache prefix is configured in you app/etc/local.xml file in /config/global/cache/id_prefix.
It's a good best practice to update this with the current build number you're deploying so that every deployment
gets its own cache namespace without having to flush caches.
Now if you're deploying immutable Magento instances there will be a (short) timeframe where the server from the old
deployment is still processing cron and the server from the new server already started to process them aswell.
By adding the same prefix id you configured in the local.xml file to this field (which is stored in the database) you
can achive a clean cut where there's only one instance processing cron at a time (since the old instances local.xml file
will continue to point to the old cache prefix.
]]></comment>
<frontend_type>text</frontend_type>
<sort_order>280</sort_order>
<show_in_default>1</show_in_default>
</runOnlyIfCachePrefixIdMatches>
</fields>
</cron>
</groups>
</system>
</sections>
</config>