[jira] [Commented] (AIRFLOW-3111) Confusing comments and instructions for log templates in UPDATING.md and default_airflow.cfg

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AIRFLOW-3111?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16626578#comment-16626578 ] 

ASF GitHub Bot commented on AIRFLOW-3111:
-----------------------------------------

chang opened a new pull request #3944: [AIRFLOW-3111] Fix instructions in UPDATING.md and remove comment artifacts
URL: https://github.com/apache/incubator-airflow/pull/3944
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-XXX
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   - fixed incorrect instructions in `UPDATING.md` about adding the options `core.log_filename_template` and `elasticsearch.elasticsearch_log_id_template`
   - removed comments referencing "additional curly braces" from
   `default_airflow.cfg` since they're irrelevant to the rendered `airflow.cfg`
   
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason: 
   
   Just updating documentation and removing comments.
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] In case of new functionality, my PR adds documentation that describes how to use it.
     - When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.
   
   ### Code Quality
   
   - [x] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Confusing comments and instructions for log templates in UPDATING.md and default_airflow.cfg
> --------------------------------------------------------------------------------------------
>
>                 Key: AIRFLOW-3111
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-3111
>             Project: Apache Airflow
>          Issue Type: Bug
>            Reporter: Eric Chang
>            Assignee: Eric Chang
>            Priority: Minor
>
> The new 1.10 release includes instructions on updating the *airflow.cfg* options core.log_filename_template and elasticsearch.elasticsearch_log_id_template that are technically incorrect:
>  
> {code:java}
> // UPDATING.md
> ...the following defaults need to be added.
> [core]
> log_filename_template = {{{{ ti.dag_id }}}}/{{{{ ti.task_id }}}}/{{{{ ts }}}}/{{{{ try_number }}}}.log
> [elasticsearch]
> elasticsearch_log_id_template = {{dag_id}}-{{task_id}}-{{execution_date}}-{{try_number}}{code}
>  
> Inserting the above options into an existing *airflow.cfg* will result in a jinja parse failure because `{{{{` is not a valid template string. The reason the extra braces are necessary is because the default *airflow.cfg* copied to AIRFLOW_HOME is a rendered version of *default_airflow.cfg* (rendered by *airflow.configuration.parameterized_config*).
> The confusion is compounded by several comments copied over to *airflow.cfg* stating that
>  
> {code:java}
> # we need to escape the curly braces by adding an additional curly brace
> {code}
> But that's is only true for *default_airflow.cfg* and doesn't apply to the actual *airflow.cfg*.
> I'll submit a PR that corrects this.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)