This is an automated email from the ASF dual-hosted git repository.
taragolis pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 87faf3144f docs(openlineage): fix quotation around openlineage
transport value (#38378)
87faf3144f is described below
commit 87faf3144f3d6058b30db347ae24212fa05c1163
Author: Timon Viola <[email protected]>
AuthorDate: Fri Mar 22 09:59:19 2024 +0100
docs(openlineage): fix quotation around openlineage transport value (#38378)
The docs suggests that the transport option should be quoted using
`'` in airflow.cfg. Using the described configuration results in
`{{utils.py:408}} WARNING - Unable to parse [openlineage] 'transport' as
valid json`
message. Removing the quotation marks around the transport config
entry fixes this.
---
.../guides/developer.rst | 2 +-
.../guides/user.rst | 18 +++++++++---------
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/docs/apache-airflow-providers-openlineage/guides/developer.rst
b/docs/apache-airflow-providers-openlineage/guides/developer.rst
index 3c7518d6cb..2ce4ef7493 100644
--- a/docs/apache-airflow-providers-openlineage/guides/developer.rst
+++ b/docs/apache-airflow-providers-openlineage/guides/developer.rst
@@ -235,7 +235,7 @@ It can be done by using ``extractors`` option in Airflow
configuration.
.. code-block:: ini
[openlineage]
- transport = '{"type": "http", "url": "http://example.com:5000"}'
+ transport = {"type": "http", "url": "http://example.com:5000"}
extractors = full.path.to.ExtractorClass;full.path.to.AnotherExtractorClass
``AIRFLOW__OPENLINEAGE__EXTRACTORS`` environment variable is an equivalent.
diff --git a/docs/apache-airflow-providers-openlineage/guides/user.rst
b/docs/apache-airflow-providers-openlineage/guides/user.rst
index 2e642abc76..acceafd619 100644
--- a/docs/apache-airflow-providers-openlineage/guides/user.rst
+++ b/docs/apache-airflow-providers-openlineage/guides/user.rst
@@ -49,7 +49,7 @@ This example is a basic demonstration of OpenLineage setup.
.. code-block:: ini
[openlineage]
- transport = '{"type": "http", "url": "http://example.com:5000";,
"endpoint": "api/v1/lineage"}'
+ transport = {"type": "http", "url": "http://example.com:5000";,
"endpoint": "api/v1/lineage"}
or with ``AIRFLOW__OPENLINEAGE__TRANSPORT`` environment variable
@@ -87,7 +87,7 @@ The ``transport`` option in Airflow configuration is used for
that purpose.
.. code-block:: ini
[openlineage]
- transport = '{"type": "http", "url": "http://example.com:5000";,
"endpoint": "api/v1/lineage"}'
+ transport = {"type": "http", "url": "http://example.com:5000";, "endpoint":
"api/v1/lineage"}
``AIRFLOW__OPENLINEAGE__TRANSPORT`` environment variable is an equivalent.
@@ -101,7 +101,7 @@ If you want to look at OpenLineage events without sending
them anywhere, you can
.. code-block:: ini
[openlineage]
- transport = '{"type": "console"}'
+ transport = {"type": "console"}
.. note::
For full list of built-in transport types, specific transport's options or
instructions on how to implement your custom transport, refer to
@@ -180,8 +180,8 @@ If not set, it's using ``default`` namespace. Provide the
name of the namespace
.. code-block:: ini
[openlineage]
- transport = '{"type": "http", "url": "http://example.com:5000";,
"endpoint": "api/v1/lineage"}'
- namespace = 'my-team-airflow-instance`
+ transport = {"type": "http", "url": "http://example.com:5000";, "endpoint":
"api/v1/lineage"}
+ namespace = 'my-team-airflow-instance'
``AIRFLOW__OPENLINEAGE__NAMESPACE`` environment variable is an equivalent.
@@ -198,7 +198,7 @@ You can disable sending OpenLineage events without
uninstalling OpenLineage prov
.. code-block:: ini
[openlineage]
- transport = '{"type": "http", "url": "http://example.com:5000";,
"endpoint": "api/v1/lineage"}'
+ transport = {"type": "http", "url": "http://example.com:5000";, "endpoint":
"api/v1/lineage"}
disabled = true
``AIRFLOW__OPENLINEAGE__DISABLED`` environment variable is an equivalent.
@@ -217,7 +217,7 @@ To prevent that, set ``disable_source_code`` option to
``true`` in Airflow confi
.. code-block:: ini
[openlineage]
- transport = '{"type": "http", "url": "http://example.com:5000";,
"endpoint": "api/v1/lineage"}'
+ transport = {"type": "http", "url": "http://example.com:5000";, "endpoint":
"api/v1/lineage"}
disable_source_code = true
``AIRFLOW__OPENLINEAGE__DISABLE_SOURCE_CODE`` environment variable is an
equivalent.
@@ -236,7 +236,7 @@ full import paths of Airflow Operators to disable as
``disabled_for_operators``
.. code-block:: ini
[openlineage]
- transport = '{"type": "http", "url": "http://example.com:5000";,
"endpoint": "api/v1/lineage"}'
+ transport = {"type": "http", "url": "http://example.com:5000";, "endpoint":
"api/v1/lineage"}
disabled_for_operators =
'airflow.operators.bash.BashOperator;airflow.operators.python.PythonOperator'
``AIRFLOW__OPENLINEAGE__DISABLED_FOR_OPERATORS`` environment variable is an
equivalent.
@@ -254,7 +254,7 @@ a string of semicolon separated Airflow Operators full
import paths to ``extract
.. code-block:: ini
[openlineage]
- transport = '{"type": "http", "url": "http://example.com:5000";,
"endpoint": "api/v1/lineage"}'
+ transport = {"type": "http", "url": "http://example.com:5000";, "endpoint":
"api/v1/lineage"}
extractors = full.path.to.ExtractorClass;full.path.to.AnotherExtractorClass
``AIRFLOW__OPENLINEAGE__EXTRACTORS`` environment variable is an equivalent.
