Repository navigation
Expand file tree
/
Copy pathconfig.yml
More file actions
3695 lines (3529 loc) · 154 KB
/
Copy pathconfig.yml
File metadata and controls
3695 lines (3529 loc) · 154 KB
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
---
core:
description: ~
options:
dags_folder:
description: |
The folder where your airflow pipelines live, most likely a
subfolder in a code repository. This path must be absolute.
version_added: ~
type: string
example: ~
default: "{AIRFLOW_HOME}/dags"
hostname_callable:
description: |
Hostname by providing a path to a callable, which will resolve the hostname.
The format is "package.function".
For example, default value ``airflow.utils.net.getfqdn`` means that result from patched
version of `socket.getfqdn() <https://docs.python.org/3/library/socket.html#socket.getfqdn>`__,
see related `CPython Issue <https://github.com/python/cpython/issues/49254>`__.
No argument should be required in the function specified.
If using IP address as hostname is preferred, use value ``airflow.utils.net.get_host_ip_address``
version_added: ~
type: string
example: ~
default: "airflow.utils.net.getfqdn"
might_contain_dag_callable:
description: |
A callable to check if a python file has airflow dags defined or not and should
return ``True`` if it has dags otherwise ``False``.
If this is not provided, Airflow uses its own heuristic rules.
The function should have the following signature
.. code-block:: python
def func_name(file_path: str, zip_file: zipfile.ZipFile | None = None) -> bool: ...
version_added: 2.6.0
type: string
example: ~
default: "airflow.utils.file.might_contain_dag_via_default_heuristic"
default_timezone:
description: |
Default timezone in case supplied date times are naive
can be `UTC` (default), `system`, or any `IANA <https://www.iana.org/time-zones>`
timezone string (e.g. Europe/Amsterdam)
version_added: ~
type: string
example: ~
default: "utc"
executor:
description: |
The executor class that airflow should use. Choices include
``LocalExecutor``, ``CeleryExecutor``,
``KubernetesExecutor`` or the full import path to the class when using a custom executor.
version_added: ~
type: string
example: ~
default: "LocalExecutor"
mp_start_method:
description: |
The ``multiprocessing`` start method used by long-lived components that spawn worker
processes (the scheduler's ``LocalExecutor`` and the triggerer). Must be
one of the values returned by `multiprocessing.get_all_start_methods()
<https://docs.python.org/3/library/multiprocessing.html#multiprocessing.get_all_start_methods>`__
on your platform (typically ``fork``, ``forkserver`` or ``spawn``). When unset (the
default) the platform default is used.
Python 3.14 changed the Unix default from ``fork`` to ``forkserver``. ``forkserver`` and
``spawn`` children re-import Airflow instead of sharing it copy-on-write, which can sharply
increase the resident memory of the scheduler and triggerer. Set this to ``fork`` to restore
the pre-3.14 behaviour (note: forking a multi-threaded process is not always safe), or keep
``forkserver`` and set ``[core] mp_forkserver_preload`` to recover most of the sharing.
This can be overridden per component by setting ``mp_start_method`` in the ``[scheduler]``,
``[triggerer]`` or ``[dag_processor]`` section.
version_added: 3.3.0
type: string
example: "fork"
default: ~
mp_forkserver_preload:
description: |
Comma-separated list of modules the ``forkserver`` process should import up front, so that
forked workers inherit them copy-on-write instead of re-importing them. Only used when the
effective ``mp_start_method`` is ``forkserver``. See `multiprocessing.set_forkserver_preload
<https://docs.python.org/3/library/multiprocessing.html#multiprocessing.set_forkserver_preload>`__.
version_added: 3.3.0
type: string
example: "airflow,airflow.executors.local_executor"
default: ~
auth_manager:
description: |
The auth manager class that airflow should use. Full import path to the auth manager class.
version_added: 2.7.0
type: string
example: ~
default: "airflow.api_fastapi.auth.managers.simple.simple_auth_manager.SimpleAuthManager"
simple_auth_manager_users:
description: |
The list of users and their associated role in simple auth manager. If the simple auth manager is
used in your environment, this list controls who can access the environment.
List of user-role delimited with a comma. Each user-role is a colon delimited couple of username and
role. Roles are predefined in simple auth managers: viewer, user, op, admin.
You can also associate users to teams by appending the list of teams (separated by "|") as third item
in the user-role definition. Example: ``bob:admin:marketing|hr``.
This can only be used if ``[core] multi_team`` is set to True.
version_added: 3.0.0
type: string
example: "bob:admin,peter:viewer"
default: "admin:admin"
simple_auth_manager_all_admins:
description: |
Whether to disable authentication and allow everyone as admin in the environment.
version_added: 3.0.0
type: string
example: ~
default: "False"
simple_auth_manager_passwords_file:
description: |
The json file where the simple auth manager stores passwords for the configured users.
By default this is ``AIRFLOW_HOME/simple_auth_manager_passwords.json.generated``.
version_added: 3.0.0
type: string
example: "/path/to/passwords.json"
default: ~
parallelism:
description: |
This defines the maximum number of task instances that can run concurrently per scheduler in
Airflow, regardless of the worker count. Generally this value, multiplied by the number of
schedulers in your cluster, is the maximum number of task instances with the running
state in the metadata database. The value must be larger or equal 1.
version_added: ~
type: integer
example: ~
default: "32"
max_active_tasks_per_dag:
description: |
The maximum number of task instances allowed to run concurrently in each dag run.
This is also configurable per-dag with ``max_active_tasks``,
which is defaulted as ``[core] max_active_tasks_per_dag``.
An example scenario when this would be useful is when you want to stop a new dag run with an early
start date from stealing all the executor slots in a cluster.
version_added: 2.2.0
type: integer
example: ~
default: "16"
dags_are_paused_at_creation:
description: |
Are DAGs paused by default at creation
version_added: ~
type: string
example: ~
default: "True"
max_active_runs_per_dag:
description: |
The maximum number of active DAG runs per DAG. The scheduler will not create more DAG runs
if it reaches the limit. This is configurable at the DAG level with ``max_active_runs``,
which is defaulted as ``[core] max_active_runs_per_dag``.
version_added: ~
type: integer
example: ~
default: "16"
max_consecutive_failed_dag_runs_per_dag:
description: |
(experimental) The maximum number of consecutive DAG failures before DAG is automatically paused.
This is also configurable per DAG level with ``max_consecutive_failed_dag_runs``,
which is defaulted as ``[core] max_consecutive_failed_dag_runs_per_dag``.
If not specified, then the value is considered as 0,
meaning that the dags are never paused out by default.
version_added: 2.9.0
type: integer
example: ~
default: "0"
load_examples:
description: |
Whether to load the Dag examples that ship with Airflow. It's good to
get started, but you probably want to set this to ``False`` in a production
environment
.. note::
If you are using the Official Airflow Docker Image, this value is set to ``False`` by default
via the environment variable ``AIRFLOW__CORE__LOAD_EXAMPLES``. To enable example Dags when
using the official image, you must explicitly set ``AIRFLOW__CORE__LOAD_EXAMPLES=True`` in your
environment.
version_added: ~
type: string
example: ~
default: "True"
plugins_folder:
description: |
Path to the folder containing Airflow plugins
version_added: ~
type: string
example: ~
default: "{AIRFLOW_HOME}/plugins"
execute_tasks_new_python_interpreter:
description: |
Should tasks be executed via forking of the parent process
* ``False``: Execute via forking of the parent process
* ``True``: Spawning a new python process, slower than fork, but means plugin changes picked
up by tasks straight away
On Airflow 3 this applies to the task process only. When ``True`` the supervisor starts
the task in a fresh interpreter with ``exec`` right after forking it, so the task cannot
inherit a lock a supervisor thread held at fork time (which can otherwise hang it at its
first TLS call). The Dag processor, the triggerer and task callbacks are not affected and
keep bare fork. Each task pays an interpreter start plus re-import. The task process reads
the global value; Edge workers, which resolve it per team, already start a fresh interpreter
for the supervisor when it is ``True`` and start a second one for the task.
default: "False"
example: ~
version_added: 2.0.0
see_also: ":ref:`plugins:loading`"
type: boolean
fernet_key:
description: |
Secret key to save connection passwords in the db
version_added: ~
type: string
sensitive: true
example: ~
default: "{FERNET_KEY}"
dagbag_import_timeout:
description: |
How long before timing out a python file import
version_added: ~
type: float
example: ~
default: "30.0"
dagbag_import_error_tracebacks:
description: |
Should a traceback be shown in the UI for dagbag import errors,
instead of just the exception message
version_added: 2.0.0
type: boolean
example: ~
default: "True"
dagbag_import_error_traceback_depth:
description: |
If tracebacks are shown, how many entries from the traceback should be shown
version_added: 2.0.0
type: integer
example: ~
default: "2"
default_impersonation:
description: |
If set, tasks without a ``run_as_user`` argument will be run with this user
Can be used to de-elevate a sudo user running Airflow when executing tasks
version_added: ~
type: string
example: ~
default: ""
security:
description: |
What security module to use (for example kerberos)
version_added: ~
type: string
example: ~
default: ""
unit_test_mode:
description: |
Turn unit test mode on (overwrites many configuration options with test
values at runtime)
version_added: ~
type: string
example: ~
default: "False"
allowed_deserialization_classes:
description: |
Space-separated list of classes that may be imported during deserialization. Items can be glob
expressions. Python built-in classes (like dict) are always allowed.
version_added: 2.5.0
type: string
default: 'airflow.*'
example: 'airflow.* my_mod.my_other_mod.TheseClasses*'
allowed_deserialization_classes_regexp:
description: |
Space-separated list of classes that may be imported during deserialization. Items are processed
as regex expressions and matched against the full classname (``re.fullmatch`` semantics), so a
pattern such as ``airflow\.models\.Variable`` does not also admit ``airflow.models.VariableXYZ``.
Use ``.*`` (e.g. ``airflow\.models\..*``) to allow a prefix and any suffix. Python built-in
classes (like dict) are always allowed.
This is a secondary option to ``[core] allowed_deserialization_classes``.
version_added: 2.8.2
type: string
default: ''
example: ~
killed_task_cleanup_time:
description: |
When a task is killed forcefully, this is the amount of time in seconds that
it has to cleanup after it is sent a SIGTERM, before it is SIGKILLED.
The task supervisor also waits this long after ``execution_timeout`` elapses before
it sends SIGTERM to a task process that has not stopped on its own.
version_added: ~
type: integer
example: ~
default: "60"
dag_run_conf_overrides_params:
description: |
Whether to override params with dag_run.conf. If you pass some key-value pairs
through ``airflow dags backfill -c`` or
``airflow dags trigger -c``, the key-value pairs will override the existing ones in params.
version_added: ~
type: string
example: ~
default: "True"
dag_discovery_safe_mode:
description: |
If enabled, Airflow only scans files containing both ``DAG`` and ``airflow`` (case-insensitive)
when looking for Dags. Set this to ``False`` to scan every Python file instead -- required when
your Dags are defined through a wrapper or abstraction whose source does not contain those strings.
This setting is read by the Dag file processor, so it must be configured for that component. In a
separate-process deployment (for example the Helm chart) set it on the ``dag-processor`` as well as
on anything that runs ``airflow dags reserialize``, and restart the component for a change to take
effect. If only some components see ``False``, Dags can appear after a manual reserialize and then
be deactivated again on the next processor scan.
As an alternative to scanning every file, set ``[core] might_contain_dag_callable`` to a custom
heuristic that recognizes your wrapper.
version_added: 1.10.3
type: string
example: ~
default: "True"
dag_ignore_file_syntax:
description: |
The pattern syntax used in the
`.airflowignore
<https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/dags.html#airflowignore>`__
files in the DAG directories. Valid values are ``regexp`` or ``glob``.
version_added: 2.3.0
type: string
example: ~
default: "glob"
default_task_retries:
description: |
The number of retries each task is going to have by default. Can be overridden at dag or task level.
version_added: 1.10.6
type: integer
example: ~
default: "0"
default_task_retry_delay:
description: |
The number of seconds each task is going to wait by default between retries. Can be overridden at
dag or task level.
version_added: 2.4.0
type: integer
example: ~
default: "300"
max_task_retry_delay:
description: |
The maximum delay (in seconds) each task is going to wait by default between retries.
This is a global setting and cannot be overridden at task or DAG level.
version_added: 2.6.0
type: integer
default: "86400"
example: ~
default_task_weight_rule:
description: |
The weighting method used for the effective total priority weight of the task
version_added: 2.2.0
type: string
example: ~
default: "downstream"
task_success_overtime:
description: |
Maximum possible time (in seconds) that task will have for execution of auxiliary processes
(like listeners, mini scheduler...) after task is marked as success..
version_added: 2.10.0
type: integer
example: ~
default: "20"
default_task_execution_timeout:
description: |
The default task execution_timeout value for the operators. Expected an integer value to
be passed into timedelta as seconds. If not specified, then the value is considered as None,
meaning that the operators are never timed out by default.
version_added: 2.3.0
type: integer
example: ~
default: ""
min_serialized_dag_update_interval:
description: |
Updating serialized DAG can not be faster than a minimum interval to reduce database write rate.
version_added: 1.10.7
type: integer
example: ~
default: "30"
compress_serialized_dags:
description: |
If ``True``, serialized DAGs are compressed before writing to DB.
.. note::
This will disable the DAG dependencies view
version_added: 2.3.0
type: boolean
example: ~
default: "False"
num_dag_runs_to_retain_rendered_fields:
description: |
Number of recent dag runs for which Rendered Task Instance Fields are retained.
Records from older runs are deleted during task execution.
Keeping this number small may cause an error when you try to view ``Rendered`` tab in
TaskInstance view for older tasks.
version_added: 3.2.0
type: integer
example: ~
default: "30"
xcom_backend:
description: |
Path to custom XCom class that will be used to store and resolve operators results
version_added: 1.10.12
type: string
example: "path.to.CustomXCom"
default: "airflow.sdk.execution_time.xcom.BaseXCom"
lazy_load_plugins:
description: |
By default Airflow plugins are lazily-loaded (only loaded when required). Set it to ``False``,
if you want to load plugins whenever 'airflow' is invoked via cli or loaded from module.
version_added: 2.0.0
type: boolean
example: ~
default: "True"
lazy_discover_providers:
description: |
By default Airflow providers are lazily-discovered (discovery and imports happen only when required).
Set it to ``False``, if you want to discover providers whenever 'airflow' is invoked via cli or
loaded from module.
version_added: 2.0.0
type: boolean
example: ~
default: "True"
hide_sensitive_var_conn_fields:
description: |
Hide sensitive **Variables** or **Connection extra json keys** from UI
and task logs when set to ``True``
.. note::
Connection passwords are always hidden in logs
version_added: 2.1.0
type: boolean
example: ~
default: "True"
sensitive_var_conn_names:
description: |
A comma-separated list of extra sensitive keywords to look for in variables names or connection's
extra JSON.
version_added: 2.1.0
type: string
example: ~
default: ""
default_pool_task_slot_count:
description: |
Task Slot counts for ``default_pool``. This setting would not have any effect in an existing
deployment where the ``default_pool`` is already created. For existing deployments, users can
change the number of slots using Webserver, API or the CLI
version_added: 2.2.0
type: integer
example: ~
default: "128"
max_map_length:
description: |
The maximum list/dict length an XCom can push to trigger task mapping. If the pushed list/dict has a
length exceeding this value, the task pushing the XCom will be failed automatically to prevent the
mapped tasks from clogging the scheduler.
version_added: 2.3.0
type: integer
example: ~
default: "1024"
allow_double_dot_in_ids:
description: |
Allow ``..`` (consecutive dots) in DAG IDs and run IDs. By default, ``..`` is blocked to prevent
path traversal attacks. Set to ``True`` only if you have existing DAGs or runs whose IDs contain
``..`` and cannot be renamed.
version_added: 3.3.0
type: boolean
example: ~
default: "False"
daemon_umask:
description: |
The default umask to use for process when run in daemon mode (scheduler, worker, etc.)
This controls the file-creation mode mask which determines the initial value of file permission bits
for newly created files.
This value is treated as an octal-integer.
version_added: 2.3.4
type: string
default: "0o077"
example: ~
asset_manager_class:
description: Class to use as asset manager.
version_added: 3.0.0
type: string
default: ~
example: 'airflow.assets.manager.AssetManager'
asset_manager_kwargs:
description: Kwargs to supply to asset manager.
version_added: 3.0.0
type: string
sensitive: true
default: ~
example: '{"some_param": "some_value"}'
test_connection:
description: |
The ability to allow testing connections across Airflow UI, API and CLI.
Supported options: ``Disabled``, ``Enabled``, ``Hidden``. Default: Disabled
Disabled - Disables the test connection functionality and disables the Test Connection button in UI.
Enabled - Enables the test connection functionality and shows the Test Connection button in UI.
Hidden - Disables the test connection functionality and hides the Test Connection button in UI.
Before setting this to Enabled, make sure that you review the users who are able to add/edit
connections and ensure they are trusted. Connection testing can be done maliciously leading to
undesired and insecure outcomes.
See `Airflow Security Model: Capabilities of authenticated UI users
<https://airflow.apache.org/docs/apache-airflow/stable/security/security_model.html#capabilities-of-authenticated-ui-users>`__
for more details.
version_added: 2.7.0
type: string
example: ~
default: "Disabled"
max_templated_field_length:
description: |
The maximum length of the rendered template field. If the value to be stored in the
rendered template field exceeds this size, it's redacted.
version_added: 2.9.0
type: integer
example: ~
default: "4096"
execution_api_server_url:
description: |
The url of the execution api server. Default is ``{BASE_URL}/execution/``
where ``{BASE_URL}`` is the base url of the API Server. If ``{BASE_URL}`` is not set
or is a relative path such as ``/airflow``, it is prefixed with ``http://localhost:{PORT}``,
where ``{PORT}`` is ``[api] port``.
version_added: 3.0.0
type: string
example: ~
default: ~
multi_team:
description: |
Whether to run the Airflow environment in multi-team mode.
In this mode, different teams can have scoped access to their own resources while still sharing the
same underlying deployment.
version_added: 3.2.0
type: boolean
example: ~
default: "False"
team_name_cache_ttl:
description: |
Number of seconds a Dag's owning team (resolved from its bundle) is cached in memory before it
is looked up again. The team is read on every Dag authorization check, including the grid
endpoints which re-poll continuously, so caching it avoids repeated Team-table joins. A team
reassignment takes up to this many seconds to take effect, and different API server workers may
briefly disagree during that window. Set to ``0`` to disable caching.
version_added: 3.3.0
type: integer
example: ~
default: "30"
rerun_with_latest_version:
description: |
Default value for whether cleared, rerun, or backfilled tasks should use
the latest bundle version. When set to True, reruns and backfills pick up
the latest code. When set to False, they use the original bundle version.
When unset, the fallback depends on the call site: False for clearing or
rerunning tasks, True for creating backfills (preserving the historical
defaults for each). Individual DAGs can override this with the
``rerun_with_latest_version`` parameter.
type: boolean
example: ~
default: ~
version_added: 3.2.0
database:
description: ~
options:
alembic_ini_file_path:
description: |
Path to the ``alembic.ini`` file. You can either provide the file path relative
to the Airflow home directory or the absolute path if it is located elsewhere.
version_added: 2.7.0
type: string
example: ~
default: "alembic.ini"
sql_alchemy_conn:
description: |
The SQLAlchemy connection string to the metadata database.
SQLAlchemy supports many different database engines.
See: `Set up a Database Backend: Database URI
<https://airflow.apache.org/docs/apache-airflow/stable/howto/set-up-database.html#database-uri>`__
for more details.
version_added: 2.3.0
type: string
sensitive: true
example: ~
default: "sqlite:///{AIRFLOW_HOME}/airflow.db"
sql_alchemy_conn_async:
description: |
The SQLAlchemy connection string to the metadata database used for async connections.
If this is not set, Airflow automatically derives a string by converting ``sql_alchemy_conn``.
Unfortunately, this conversion logic does not always work due to various incompatibilities
between sync and async db driver implementations. This sets the connection string directly
without any conversion instead.
version_added: 3.1.0
type: string
sensitive: true
example: "postgresql+asyncpg://postgres:airflow@postgres/airflow"
default: ~
sql_alchemy_engine_args:
description: |
Extra engine specific keyword args passed to SQLAlchemy's create_engine, as a JSON-encoded value
version_added: 2.3.0
type: string
sensitive: true
example: '{"arg1": true}'
default: ~
sql_engine_encoding:
description: |
The encoding for the databases
version_added: 2.3.0
type: string
example: ~
default: "utf-8"
sql_engine_collation_for_ids:
description: |
Collation for ``dag_id``, ``task_id``, ``key``, ``external_executor_id`` columns
in case they have different encoding.
By default this collation is the same as the database collation, however for ``mysql`` and ``mariadb``
the default is ``utf8mb3_bin`` so that the index sizes of our index keys will not exceed
the maximum size of allowed index when collation is set to ``utf8mb4`` variant, see
`GitHub Issue Comment <https://github.com/apache/airflow/pull/17603#issuecomment-901121618>`__
for more details.
version_added: 2.3.0
type: string
example: ~
default: ~
sql_alchemy_pool_enabled:
description: |
If SQLAlchemy should pool database connections.
version_added: 2.3.0
type: string
example: ~
default: "True"
sql_alchemy_pool_size:
description: |
The SQLAlchemy pool size is the maximum number of database connections
in the pool. 0 indicates no limit.
version_added: 2.3.0
type: integer
example: ~
default: "5"
sql_alchemy_max_overflow:
description: |
The maximum overflow size of the pool.
When the number of checked-out connections reaches the size set in pool_size,
additional connections will be returned up to this limit.
When those additional connections are returned to the pool, they are disconnected and discarded.
It follows then that the total number of simultaneous connections the pool will allow
is **pool_size** + **max_overflow**,
and the total number of "sleeping" connections the pool will allow is pool_size.
max_overflow can be set to ``-1`` to indicate no overflow limit;
no limit will be placed on the total number of concurrent connections. Defaults to ``10``.
version_added: 2.3.0
type: integer
example: ~
default: "10"
sql_alchemy_pool_recycle:
description: |
The SQLAlchemy pool recycle is the number of seconds a connection
can be idle in the pool before it is invalidated. This config does
not apply to sqlite. If the number of DB connections is ever exceeded,
a lower config value will allow the system to recover faster.
version_added: 2.3.0
type: integer
example: ~
default: "1800"
sql_alchemy_pool_pre_ping:
description: |
Check connection at the start of each connection pool checkout.
Typically, this is a simple statement like "SELECT 1".
See `SQLAlchemy Pooling: Disconnect Handling - Pessimistic
<https://docs.sqlalchemy.org/en/20/core/pooling.html#disconnect-handling-pessimistic>`__
for more details.
version_added: 2.3.0
type: boolean
example: ~
default: "True"
sql_alchemy_schema:
description: |
The schema to use for the metadata database.
SQLAlchemy supports databases with the concept of multiple schemas.
version_added: 2.3.0
type: string
example: ~
default: ""
sql_alchemy_connect_args:
description: |
Import path for connect args in SQLAlchemy. Defaults to an empty dict, except for
psycopg3 URLs, where Airflow defaults ``prepare_threshold`` to ``None`` so that
server-side statement preparation does not break under a transaction-pooling
connection pooler. Keys set here are merged over that default and win.
This is useful when you want to configure db engine args that SQLAlchemy won't parse
in connection string. This can be set by passing a dictionary containing the create engine parameters.
For more details about passing create engine parameters (keepalives variables, timeout etc)
in Postgres DB Backend see `Setting up a PostgreSQL Database
<https://airflow.apache.org/docs/apache-airflow/stable/howto/set-up-database.html#setting-up-a-postgresql-database>`__
e.g ``connect_args={"timeout":30}`` can be defined in ``airflow_local_settings.py`` and
can be imported as shown below
*Changed in 3.1.0*: This configuration is only applied to synchronous engines, such as psycopg2.
See ``sql_alchemy_connect_args_async``.
version_added: 2.3.0
type: string
example: 'airflow_local_settings.connect_args'
default: ~
sql_alchemy_connect_args_async:
description: |
Import path for connect args in SQLAlchemy. Defaults to an empty dict, except for
psycopg3 URLs -- see ``sql_alchemy_connect_args``.
This is similar to ``sql_alchemy_connect_args``, but only for async connections and must be a dict.
This is applied to the async engine only. If you opt in to the ``asyncpg`` driver behind
transaction-mode pgbouncer, set
``statement_cache_size`` and ``prepared_statement_cache_size`` to ``0`` here to avoid "prepared
statement does not exist" errors. See the async driver section of the Postgres setup guide.
version_added: 3.1.0
type: string
example: 'airflow_local_settings.connect_args_async'
default: ~
sql_alchemy_session_maker:
description: |
Important Warning: Use of sql_alchemy_session_maker Highly Discouraged
Import path for function which returns 'sqlalchemy.orm.sessionmaker'.
Improper configuration of sql_alchemy_session_maker can lead to serious issues,
including data corruption, unrecoverable application crashes. Please review the SQLAlchemy
documentation for detailed guidance on proper configuration and best practices.
version_added: 2.10.0
type: string
example: 'airflow_local_settings._sessionmaker'
default: ~
max_db_retries:
description: |
Maximum number of attempts, including the first one, for operations retried on DB
operational errors. The default of 3 means one initial attempt plus up to 2 retries.
Not all transactions are retried, since retrying some of them can leave undesired state.
version_added: 2.3.0
type: integer
example: ~
default: "3"
check_migrations:
description: |
Whether to run alembic migrations during Airflow start up. Sometimes this operation can be expensive,
and the users can assert the correct version through other means (e.g. through a Helm chart).
Accepts ``True`` or ``False``.
version_added: 2.6.0
type: string
example: ~
default: "True"
external_db_managers:
description: |
Additional DB managers to include when migrating external tables in the Airflow
database, beyond those automatically discovered from installed providers.
The managers must inherit from BaseDBManager.
version_added: 3.0.0
type: string
example: "airflow.providers.fab.auth_manager.models.db.FABDBManager"
default: ~
migration_batch_size:
description: |
The number of rows to process in each batch when performing a migration.
This is useful for large tables to avoid locking and failure due to query timeouts.
version_added: 3.0.0
type: integer
example: ~
default: "10000"
logging:
description: ~
options:
base_log_folder:
description: |
The folder where airflow should store its log files.
This path must be absolute.
There are a few existing configurations that assume this is set to the default.
If you choose to override this you may need to update the
``[logging] dag_processor_manager_log_location`` and
``[logging] dag_processor_child_process_log_directory settings`` as well.
version_added: 2.0.0
type: string
example: ~
default: "{AIRFLOW_HOME}/logs"
remote_logging:
description: |
Airflow can store logs remotely in AWS S3, Google Cloud Storage or Elastic Search.
Set this to ``True`` if you want to enable remote logging.
version_added: 2.0.0
type: string
example: ~
default: "False"
remote_log_conn_id:
description: |
Users must supply an Airflow connection id that provides access to the storage
location. Depending on your remote logging service, this may only be used for
reading logs, not writing them.
version_added: 2.0.0
type: string
example: ~
default: ""
delete_local_logs:
description: |
Whether the local log files for GCS, S3, WASB, HDFS and OSS remote logging should be deleted after
they are uploaded to the remote location.
version_added: 2.6.0
type: string
example: ~
default: "False"
google_key_path:
description: |
Path to Google Credential JSON file. If omitted, authorization based on `the Application Default
Credentials
<https://cloud.google.com/docs/authentication/application-default-credentials>`__ will
be used.
version_added: 2.0.0
type: string
example: ~
default: ""
remote_base_log_folder:
description: |
Storage bucket URL for remote logging
S3 buckets should start with **s3://**
Cloudwatch log groups should start with **cloudwatch://**
GCS buckets should start with **gs://**
WASB buckets should start with **wasb** just to help Airflow select correct handler
Stackdriver logs should start with **stackdriver://**
version_added: 2.0.0
type: string
example: ~
default: ""
remote_task_handler_kwargs:
description: |
The remote_task_handler_kwargs param is loaded into a dictionary and passed to the ``__init__``
of remote task handler and it overrides the values provided by Airflow config. For example if you set
``delete_local_logs=False`` and you provide ``{"delete_local_copy": true}``, then the local
log files will be deleted after they are uploaded to remote location.
version_added: 2.6.0
type: string
sensitive: true
example: '{"delete_local_copy": true}'
default: ""
encrypt_s3_logs:
description: |
Use server-side encryption for logs stored in S3
version_added: 2.0.0
type: string
example: ~
default: "False"
logging_level:
description: |
Logging level.
Individual loggers can be set at a different level with the :ref:`config:logging__namespace_levels`
option.
Supported values: ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO``, ``DEBUG``.
version_added: 2.0.0
type: string
example: ~
default: "INFO"
namespace_levels:
description: |
Set the log level for individual named loggers.
A very common convention in Python is to use the module name as the name of the logger from which log
messages originate. This config option gives us the ability to set log levels for those loggers
easily.
The format of this variable is a series of ``<logger>=<level>`` pairs, separated by whitespace or
commas.
Each level is one of the possible values to ``logging_level``.
The logger names are viewable in task logs (as the "source" attribute), or in server components by
including ``%(name)s`` in your format string, or in the between ``[]`` after the message in the
default format.
version_added: 3.2.0
type: string
example: "sqlalchemy=INFO sqlalchemy.engine=DEBUG, botocor"
default: ~
celery_logging_level:
description: |
Logging level for celery. If not set, it uses the value of logging_level
Supported values: ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO``, ``DEBUG``.
version_added: 2.3.0
type: string
example: ~
default: ""
fab_logging_level:
description: |
Logging level for Flask-appbuilder UI.
Supported values: ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO``, ``DEBUG``.
version_added: 2.0.0
type: string
example: ~
default: "WARNING"
json_logs:
description: |
Enable JSON-structured logging for all output. When ``True``, every log line emitted by
the process is a single-line JSON object (including HTTP access logs from the API server).
Recommended for production / cloud-native deployments where logs are collected by a log
aggregator.
version_added: "3.2.0"
type: boolean
example: "True"
default: "False"
task_logs_to_stdout:
description: |
Also forward task subprocess stdout/stderr to the worker's own stdout, so task logs reach
a container-level log collector (e.g. Kubernetes/Loki) in addition to the task-log handler
and the UI. This is not a global switch: it is only consulted when a caller leaves
``subprocess_logs_to_stdout`` out of ``BaseExecutor.run_workload``. Executors that already pass
``True`` explicitly (the LocalExecutor and the per-task entrypoint used by the Kubernetes, ECS,
Batch and Lambda executors) always forward task logs to stdout and ignore this setting. Currently
it is read by the Celery worker (which resolves ``[celery] task_logs_to_stdout`` first, then this
setting) and by the Edge3 worker's fork path on Airflow 3.4+.
version_added: 3.4.0
type: boolean
example: "True"
default: "False"
uvicorn_logging_level:
description: |
Logging level for uvicorn (API server and serve-logs).
Supported values: ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO``, ``DEBUG``.
version_added: 3.2.0
type: string
example: ~
default: "INFO"
logging_config_class:
description: |
Dotted import path to a ``logging.config.dictConfig`` dict. The
``_class`` suffix is historical — the target is a dict, not a class.
Airflow also reads two optional module-level attributes from the
enclosing module: ``REMOTE_TASK_LOG`` and ``DEFAULT_REMOTE_CONN_ID``,
used to drive remote task-log read-back. See :ref:`write-logs-advanced`.
version_added: 2.0.0
type: string
example: "my.path.default_local_settings.LOGGING_CONFIG"
default: ""
colored_console_log:
description: |
Flag to enable/disable Colored logs in Console
Colour the logs when the controlling terminal is a TTY.
version_added: 2.0.0
type: string
example: ~
default: "True"
log_format:
description: |
Format of Log line
*Changed in 3.1.0*: This can now contain color escape sequences ``%(blue)s`` etc which will only
result in colours if :ref:`config:logging__colored_console_log` is true.
version_added: 2.0.0
type: string
example: "[%%(asctime)s] {{%%(filename)s:%%(lineno)d}} %%(levelname)s - %%(message)s"
default: ""
callsite_parameters:
description: |
A comma separated list of information about the callsite (such as line number of filename etc) of
logger calls to include in each message.