omkar-foss commented on code in PR #65423: URL: https://github.com/apache/airflow/pull/65423#discussion_r3213693675
########## airflow-core/docs/error_mapping.yml: ########## @@ -0,0 +1,149 @@ +# 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. +--- + +error_guide: + description: Quick debug guide for common errors while using Airflow. + error_codes: + # Specify error codes below for exception classes as required. + # Exception class can have multiple error codes representing its respective error states. + # e.g. AirflowNotFoundException can have AERR001, AERR002, etc representing different not found cases. + - error_code: AERR001 + exception_type: AirflowNotFoundException + user_facing_error_message: TaskSDK connection not found for requested connection ID + description: This error occurs when Airflow is unable to locate a connection + with given connection id in any configured secrets backend or metadata + store. It attempted to retrieve the connection via the Task SDK, but no + matching entry was found. + first_steps: Verify that the connection ID is correctly configured in Airflow. + Check your secrets backend, environment variables, or Airflow UI to + ensure the connection exists and is accessible to the current task. + Confirm there are no typos in the conn_id. If using a secrets backend, + ensure it is properly configured and reachable. + documentation: > + https://airflow.apache.org/docs/apache-airflow/stable/howto/connection.html#using-connections + + - error_code: AERR002 + exception_type: AirflowNotFoundException + user_facing_error_message: Requested connection ID is not defined + description: This error occurs when Airflow attempts to resolve a connection + using its standard secrets resolution flow (SecretCache and configured + secrets backends) and is unable to find any matching connection for + given conn_id. It also indicates that all configured backends were + checked sequentially but none returned a valid connection. + first_steps: > + Confirm that the connection is defined in at least one configured + secrets backend or in the Airflow metadata database. Check whether Review Comment: I've updated PR to keep error_code embedded, so when the mixin is added to an exception class, now all instances of that exception class should mandatorily pass an error_code. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
