Skip to content

Commit

Permalink
chore: Update description of execution_timeout in OpenLineage provi…
Browse files Browse the repository at this point in the history
…der.yaml (#47448)

* chore: Update description of `execution_timeout` in OpenLineage provider.yaml

* chore: Update description of execution_timeout in OpenLineage provider.yaml
  • Loading branch information
kacpermuda authored Mar 7, 2025
1 parent aa07160 commit afcfb86
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
17 changes: 12 additions & 5 deletions providers/openlineage/provider.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,9 @@ config:
openlineage:
description: |
This section applies settings for OpenLineage integration.
More about configuration and it's precedence can be found at
https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html#transport-setup
More about configuration and it's precedence can be found in the `user's guide
<https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html#transport-setup>`_.
options:
disabled:
description: |
Expand Down Expand Up @@ -125,16 +126,18 @@ config:
default: ""
transport:
description: |
Pass OpenLineage Client transport configuration as JSON string. It should contain type of the
transport and additional options (different for each transport type). For more details see:
https://openlineage.io/docs/client/python/#built-in-transport-types
Pass OpenLineage Client transport configuration as a JSON string, including the transport type
and any additional options specific to that type, as described in `OpenLineage docs
<https://openlineage.io/docs/client/python/#built-in-transport-types>`_.
Currently supported types are:
* HTTP
* Kafka
* Console
* File
* Composite
* Custom
type: string
example: '{"type": "http", "url": "http://localhost:5000", "endpoint": "api/v1/lineage"}'
default: ""
Expand All @@ -159,6 +162,10 @@ config:
execution_timeout:
description: |
Maximum amount of time (in seconds) that OpenLineage can spend executing metadata extraction.
Note that other configurations, sometimes with higher priority, such as
`[core] task_success_overtime
<https://airflow.apache.org/docs/apache-airflow/stable/configurations-ref.html#task-success-overtime>`_,
may also affect how much time OpenLineage has for execution.
default: "10"
example: ~
type: integer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def get_provider_info():
],
"config": {
"openlineage": {
"description": "This section applies settings for OpenLineage integration.\nMore about configuration and it's precedence can be found at\nhttps://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html#transport-setup\n",
"description": "This section applies settings for OpenLineage integration.\nMore about configuration and it's precedence can be found in the `user's guide\n<https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html#transport-setup>`_.\n",
"options": {
"disabled": {
"description": "Disable sending events without uninstalling the OpenLineage Provider by setting this to true.\n",
Expand Down Expand Up @@ -124,7 +124,7 @@ def get_provider_info():
"default": "",
},
"transport": {
"description": "Pass OpenLineage Client transport configuration as JSON string. It should contain type of the\ntransport and additional options (different for each transport type). For more details see:\nhttps://openlineage.io/docs/client/python/#built-in-transport-types\n\nCurrently supported types are:\n\n * HTTP\n * Kafka\n * Console\n * File\n",
"description": "Pass OpenLineage Client transport configuration as a JSON string, including the transport type\nand any additional options specific to that type, as described in `OpenLineage docs\n<https://openlineage.io/docs/client/python/#built-in-transport-types>`_.\n\nCurrently supported types are:\n\n * HTTP\n * Kafka\n * Console\n * File\n * Composite\n * Custom\n",
"type": "string",
"example": '{"type": "http", "url": "http://localhost:5000", "endpoint": "api/v1/lineage"}',
"default": "",
Expand All @@ -145,7 +145,7 @@ def get_provider_info():
"version_added": "1.8.0",
},
"execution_timeout": {
"description": "Maximum amount of time (in seconds) that OpenLineage can spend executing metadata extraction.\n",
"description": "Maximum amount of time (in seconds) that OpenLineage can spend executing metadata extraction.\nNote that other configurations, sometimes with higher priority, such as\n`[core] task_success_overtime\n<https://airflow.apache.org/docs/apache-airflow/stable/configurations-ref.html#task-success-overtime>`_,\nmay also affect how much time OpenLineage has for execution.\n",
"default": "10",
"example": None,
"type": "integer",
Expand Down

0 comments on commit afcfb86

Please sign in to comment.