This is an automated email from the ASF dual-hosted git repository. ephraimanierobi pushed a commit to branch v2-6-test in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 885a61b80ca40af5fe76fee422d2d7a90da8d6ab Author: Rohan Anand <[email protected]> AuthorDate: Fri Apr 14 23:34:46 2023 +0530 Create audit_logs.rst (#30405) --------- Co-authored-by: Josh Fell <[email protected]> (cherry picked from commit 959039837c903bab4909d9bc061438b1961a79f8) --- .../security/audit_logs.rst | 64 ++++++++++++++++++++++ 1 file changed, 64 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 new file mode 100644 index 0000000000..33cec373c3 --- /dev/null +++ b/docs/apache-airflow/administration-and-deployment/security/audit_logs.rst @@ -0,0 +1,64 @@ + .. 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. +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.
