Skip to content

docs(openlineage): fix quotation around openlineage transport value#38378

Merged
Taragolis merged 1 commit intoapache:mainfrom
timonviola:fix/ol_docs
Mar 22, 2024
Merged

docs(openlineage): fix quotation around openlineage transport value#38378
Taragolis merged 1 commit intoapache:mainfrom
timonviola:fix/ol_docs

Conversation

@timonviola
Copy link
Contributor

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.

The generated airflow.cfg shows the correct version of the config:

# 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                           
#                                                                                               
# Currently supported types are:                                                                
#                                                                                               
#   * HTTP                                                                                      
#   * Kafka                                                                                     
#   * Console                                                                                   
#   * File                                                                                      
#                                                                                               
# Example: transport = {"type": "http", "url": "http://localhost:5000", "endpoint": "api/v1/lineage"}

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

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.
@Taragolis Taragolis merged commit 87faf31 into apache:main Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants