From 500ab907e549d3e62606aa10c7327e5048bcd505 Mon Sep 17 00:00:00 2001 From: Rohan Anand <96521078+rohan472000@users.noreply.github.com> Date: Sat, 1 Apr 2023 01:22:40 +0530 Subject: [PATCH 1/7] Create audit_logs.rst --- .../security/audit_logs.rst | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/apache-airflow/administration-and-deployment/security/audit_logs.rst diff --git a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst new file mode 100644 index 0000000000000..74da50802bb33 --- /dev/null +++ b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst @@ -0,0 +1,42 @@ +# Audit Logs in Airflow + +## Overview +Audit logs are a critical component of any system that needs to maintain a high level of security and compliance. +They provide a way to track user actions and system events, which can be used to troubleshoot issues, detect security breaches, and ensure regulatory compliance. + +In Airflow, audit logs are used to track user actions and system events that occur during the execution of DAGs and tasks. +They are stored in a database and can be accessed through the Airflow UI. + +## Level of Audit Logs + +Audit logs exist at the task level and the user level. + +- Task Level: At the task level, audit logs capture information related to the execution of a task, such as the start time, end time, and status of the task. + +- User Level: At the user level, audit logs capture information related to user actions, such as creating, modifying, or deleting a DAG or task. + +## Location of Audit Logs + +Audit logs can be accessed through the Airflow UI. They are located under the "Admin" tab, and can be viewed by selecting "Audit Logs" from the dropdown menu. + +## Types of Events + +Airflow provides a set of predefined events that can be tracked in audit logs. These events include: + +- `action_trigger_dag`: Triggering a DAG +- `action_create`: Creating a DAG or task +- `action_edit`: Modifying a DAG or task +- `action_delete`: Deleting a DAG or task +- `action_failed`: Setting a task as failed +- `action_success`: Setting a task as successful +- `action_retry`: Retrying a failed task +- `action_clear`: Clearing a task's state + +In addition to these predefined events, Airflow allows you to define custom events that can be tracked in audit logs. +This can be done by calling the `log` method of the `TaskInstance` object. + +## Conclusion +Audit logs are a critical component of any system that needs to maintain a high level of security and compliance. +In Airflow, audit logs can be used to track user actions and system events, which can be used to troubleshoot issues, +detect security breaches, and ensure regulatory compliance. By understanding how audit logs work in Airflow, +you can ensure that your system is secure and compliant with industry standards. From 6d6056800351bcd08757db2815ec9f5c2bddfec1 Mon Sep 17 00:00:00 2001 From: Rohan Anand <96521078+rohan472000@users.noreply.github.com> Date: Tue, 4 Apr 2023 11:56:26 +0530 Subject: [PATCH 2/7] Update audit_logs.rst --- .../security/audit_logs.rst | 22 ++++++++----------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst index 74da50802bb33..4d787aadaf8a2 100644 --- a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst +++ b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst @@ -23,20 +23,16 @@ Audit logs can be accessed through the Airflow UI. They are located under the "A Airflow provides a set of predefined events that can be tracked in audit logs. These events include: -- `action_trigger_dag`: Triggering a DAG -- `action_create`: Creating a DAG or task -- `action_edit`: Modifying a DAG or task -- `action_delete`: Deleting a DAG or task -- `action_failed`: Setting a task as failed -- `action_success`: Setting a task as successful -- `action_retry`: Retrying a failed task -- `action_clear`: Clearing a task's state +- ``action_trigger_dag``: Triggering a DAG +- ``action_create``: Creating a DAG or task +- ``action_edit``: Modifying a DAG or task +- ``action_delete``: Deleting a DAG or task +- ``action_failed``: Setting a task as failed +- ``action_success``: Setting a task as successful +- ``action_retry``: Retrying a failed task +- ``action_clear``: Clearing a task's state In addition to these predefined events, Airflow allows you to define custom events that can be tracked in audit logs. This can be done by calling the `log` method of the `TaskInstance` object. -## Conclusion -Audit logs are a critical component of any system that needs to maintain a high level of security and compliance. -In Airflow, audit logs can be used to track user actions and system events, which can be used to troubleshoot issues, -detect security breaches, and ensure regulatory compliance. By understanding how audit logs work in Airflow, -you can ensure that your system is secure and compliant with industry standards. + From 5dca0c5a6dd6bfe336ca460eee5b67ca33310e3f Mon Sep 17 00:00:00 2001 From: Rohan Anand <96521078+rohan472000@users.noreply.github.com> Date: Tue, 4 Apr 2023 18:15:11 +0530 Subject: [PATCH 3/7] Update docs/apache-airflow/administration-and-deployment/security/audit_logs.rst Co-authored-by: Josh Fell <48934154+josh-fell@users.noreply.github.com> --- .../administration-and-deployment/security/audit_logs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst index 4d787aadaf8a2..d5be9abb92ff7 100644 --- a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst +++ b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst @@ -33,6 +33,6 @@ Airflow provides a set of predefined events that can be tracked in audit logs. T - ``action_clear``: Clearing a task's state In addition to these predefined events, Airflow allows you to define custom events that can be tracked in audit logs. -This can be done by calling the `log` method of the `TaskInstance` object. +This can be done by calling the ``log`` method of the ``TaskInstance`` object. From 32aca4ed8df78a6f75ca45be72f645afb18634c3 Mon Sep 17 00:00:00 2001 From: Rohan Anand <96521078+rohan472000@users.noreply.github.com> Date: Wed, 5 Apr 2023 17:37:14 +0530 Subject: [PATCH 4/7] Update audit_logs.rst --- .../security/audit_logs.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst index d5be9abb92ff7..a052f8d96ae6f 100644 --- a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst +++ b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst @@ -1,13 +1,18 @@ -# Audit Logs in Airflow +Audit Logs in Airflow +======================== + +Overview +--------- -## Overview Audit logs are a critical component of any system that needs to maintain a high level of security and compliance. They provide a way to track user actions and system events, which can be used to troubleshoot issues, detect security breaches, and ensure regulatory compliance. In Airflow, audit logs are used to track user actions and system events that occur during the execution of DAGs and tasks. They are stored in a database and can be accessed through the Airflow UI. -## Level of Audit Logs + +Level of Audit Logs +-------------------- Audit logs exist at the task level and the user level. @@ -15,11 +20,15 @@ Audit logs exist at the task level and the user level. - User Level: At the user level, audit logs capture information related to user actions, such as creating, modifying, or deleting a DAG or task. -## Location of Audit Logs + +Location of Audit Logs +---------------------- Audit logs can be accessed through the Airflow UI. They are located under the "Admin" tab, and can be viewed by selecting "Audit Logs" from the dropdown menu. -## Types of Events + +Types of Events +--------------- Airflow provides a set of predefined events that can be tracked in audit logs. These events include: From 84ae7fd529ad82fb4172b6492d9a359c6e46ad1a Mon Sep 17 00:00:00 2001 From: Rohan Anand <96521078+rohan472000@users.noreply.github.com> Date: Thu, 13 Apr 2023 23:00:45 +0530 Subject: [PATCH 5/7] Update audit_logs.rst --- .../administration-and-deployment/security/audit_logs.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst index a052f8d96ae6f..77de8bf3374eb 100644 --- a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst +++ b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst @@ -4,9 +4,11 @@ Audit Logs in Airflow Overview --------- + Audit logs are a critical component of any system that needs to maintain a high level of security and compliance. They provide a way to track user actions and system events, which can be used to troubleshoot issues, detect security breaches, and ensure regulatory compliance. + In Airflow, audit logs are used to track user actions and system events that occur during the execution of DAGs and tasks. They are stored in a database and can be accessed through the Airflow UI. @@ -41,6 +43,7 @@ Airflow provides a set of predefined events that can be tracked in audit logs. T - ``action_retry``: Retrying a failed task - ``action_clear``: Clearing a task's state + In addition to these predefined events, Airflow allows you to define custom events that can be tracked in audit logs. This can be done by calling the ``log`` method of the ``TaskInstance`` object. From ef4ad1efe30627041d81df025d97e0a263200588 Mon Sep 17 00:00:00 2001 From: rohan472000 Date: Fri, 14 Apr 2023 20:00:45 +0530 Subject: [PATCH 6/7] added license to audit_logs.rst --- .../security/audit_logs.rst | 26 +++++++++++++++---- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst index 77de8bf3374eb..b6ce6964c1cd2 100644 --- a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst +++ b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst @@ -1,15 +1,31 @@ + .. 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. + Audit Logs in Airflow ======================== + Overview --------- - -Audit logs are a critical component of any system that needs to maintain a high level of security and compliance. +Audit logs are a critical component of any system that needs to maintain a high level of security and compliance. They provide a way to track user actions and system events, which can be used to troubleshoot issues, detect security breaches, and ensure regulatory compliance. - -In Airflow, audit logs are used to track user actions and system events that occur during the execution of DAGs and tasks. +In Airflow, audit logs are used to track user actions and system events that occur during the execution of DAGs and tasks. They are stored in a database and can be accessed through the Airflow UI. @@ -44,7 +60,7 @@ Airflow provides a set of predefined events that can be tracked in audit logs. T - ``action_clear``: Clearing a task's state -In addition to these predefined events, Airflow allows you to define custom events that can be tracked in audit logs. +In addition to these predefined events, Airflow allows you to define custom events that can be tracked in audit logs. This can be done by calling the ``log`` method of the ``TaskInstance`` object. From b0969905a811427503dd775cddc18bf443408a58 Mon Sep 17 00:00:00 2001 From: rohan472000 Date: Fri, 14 Apr 2023 22:13:23 +0530 Subject: [PATCH 7/7] updated audit_logs.rst --- .../administration-and-deployment/security/audit_logs.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst index b6ce6964c1cd2..33cec373c3f8b 100644 --- a/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst +++ b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst @@ -62,5 +62,3 @@ Airflow provides a set of predefined events that can be tracked in audit logs. T In addition to these predefined events, Airflow allows you to define custom events that can be tracked in audit logs. This can be done by calling the ``log`` method of the ``TaskInstance`` object. - -