Skip to content

[AIRFLOW-5645] Precise webserver status monitoring possibilities in quickstart#6316

Closed
tpilewicz wants to merge 1 commit intoapache:masterfrom
tpilewicz:master
Closed

[AIRFLOW-5645] Precise webserver status monitoring possibilities in quickstart#6316
tpilewicz wants to merge 1 commit intoapache:masterfrom
tpilewicz:master

Conversation

@tpilewicz
Copy link
Contributor

@tpilewicz tpilewicz commented Oct 12, 2019

Make sure you have checked all steps below.

Jira

  • My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"
    • https://issues.apache.org/jira/browse/AIRFLOW-5645
    • 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.
    • In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal (AIP).
    • In case you are adding a dependency, check if the license complies with the ASF 3rd Party License Policy.

Description

  • Here are some details about my PR, including screenshots of any UI changes:

My PR adds details in the quickstart of Airflow, precising that the web UI can be used to monitor the evolution of state of Task Instances and DAG runs. I suggest adding this because it is a central feature of Airflow.

Tests

  • My PR adds the following unit tests OR does not need testing for this extremely good reason:

Only adding precisions in the documentation.

Commits

  • 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":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain docstrings that explain what it does
    • If you implement backwards incompatible changes, please leave a note in the Updating.md so we can assign it to a appropriate release

The quickstart suggests to run two airflow commands from the CLI to trigger some DAG runs and task instances : airflow tasks run, and airflow dags backfill. It states that the status of the jobs will be displayed to the user but doesn't mention that the webserver can be used to monitor them.

I suggest developing this statement to tell the user that he will have feedback from the CLI, but can also see the status of his tasks in the web UI, which is a significant feature of Airflow.
@codecov-io
Copy link

Codecov Report

Merging #6316 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6316      +/-   ##
==========================================
+ Coverage   80.34%   80.35%   +<.01%     
==========================================
  Files         616      616              
  Lines       35733    35733              
==========================================
+ Hits        28711    28713       +2     
+ Misses       7022     7020       -2
Impacted Files Coverage Δ
airflow/utils/dag_processing.py 56.72% <0%> (-0.18%) ⬇️
airflow/models/taskinstance.py 93.77% <0%> (+0.5%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c0d98a7...a378ac9. Read the comment docs.

@stale
Copy link

stale bot commented Nov 27, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Nov 27, 2019
@stale stale bot closed this Dec 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stale Stale PRs per the .github/workflows/stale.yml policy file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments