Return-Path: 
 <yarn-issues-return-13682-apmail-hadoop-yarn-issues-archive=hadoop.apache.org@hadoop.apache.org>
X-Original-To: apmail-hadoop-yarn-issues-archive@minotaur.apache.org
Delivered-To: apmail-hadoop-yarn-issues-archive@minotaur.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 925DC1063C
	for <apmail-hadoop-yarn-issues-archive@minotaur.apache.org>;
 Wed, 28 Aug 2013 18:45:11 +0000 (UTC)
Received: (qmail 69043 invoked by uid 500); 28 Aug 2013 18:45:11 -0000
Delivered-To: apmail-hadoop-yarn-issues-archive@hadoop.apache.org
Received: (qmail 68689 invoked by uid 500); 28 Aug 2013 18:45:10 -0000
Mailing-List: contact yarn-issues-help@hadoop.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:yarn-issues-help@hadoop.apache.org>
List-Unsubscribe: <mailto:yarn-issues-unsubscribe@hadoop.apache.org>
List-Post: <mailto:yarn-issues@hadoop.apache.org>
List-Id: <yarn-issues.hadoop.apache.org>
Reply-To: yarn-issues@hadoop.apache.org
Delivered-To: mailing list yarn-issues@hadoop.apache.org
Received: (qmail 68622 invoked by uid 99); 28 Aug 2013 18:45:10 -0000
Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 28 Aug 2013 18:45:10 +0000
Date: Wed, 28 Aug 2013 18:45:10 +0000 (UTC)
From: "Xuan Gong (JIRA)" <jira@apache.org>
To: yarn-issues@hadoop.apache.org
Message-ID: <JIRA.12664405.1376933515936.48449.1377715510625@arcas>
In-Reply-To: <JIRA.12664405.1376933515936@arcas>
References: <JIRA.12664405.1376933515936@arcas>
Subject: [jira] [Updated] (YARN-1080) Improve help message for $ yarn logs
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394


     [ https://issues.apache.org/jira/browse/YARN-1080?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Xuan Gong updated YARN-1080:
----------------------------

    Attachment: YARN-1080.1.patch
    
> Improve help message for $ yarn logs
> ------------------------------------
>
>                 Key: YARN-1080
>                 URL: https://issues.apache.org/jira/browse/YARN-1080
>             Project: Hadoop YARN
>          Issue Type: Improvement
>          Components: client
>            Reporter: Tassapol Athiapinya
>            Assignee: Xuan Gong
>             Fix For: 2.3.0
>
>         Attachments: YARN-1080.1.patch
>
>
> There are 2 parts I am proposing in this jira. They can be fixed together in one patch.
> 1. Standardize help message for required parameter of $ yarn logs
> YARN CLI has a command "logs" ($ yarn logs). The command always requires a parameter of "-applicationId <arg>". However, help message of the command does not make it clear. It lists -applicationId as optional parameter. If I don't set it, YARN CLI will complain this is missing. It is better to use standard required notation used in other Linux command for help message. Any user familiar to the command can understand that this parameter is needed more easily.
> {code:title=current help message}
> -bash-4.1$ yarn logs
> usage: general options are:
>  -applicationId <arg>   ApplicationId (required)
>  -appOwner <arg>        AppOwner (assumed to be current user if not
>                         specified)
>  -containerId <arg>     ContainerId (must be specified if node address is
>                         specified)
>  -nodeAddress <arg>     NodeAddress in the format nodename:port (must be
>                         specified if container id is specified)
> {code}
> {code:title=proposed help message}
> -bash-4.1$ yarn logs
> usage: yarn logs -applicationId <application ID> [OPTIONS]
> general options are:
>  -appOwner <arg>        AppOwner (assumed to be current user if not
>                         specified)
>  -containerId <arg>     ContainerId (must be specified if node address is
>                         specified)
>  -nodeAddress <arg>     NodeAddress in the format nodename:port (must be
>                         specified if container id is specified)
> {code}
> 2. Add description for help command. As far as I know, a user cannot get logs for running job. Since I spent some time trying to get logs of running applications, it should be nice to say this in command description.
> {code:title=proposed help}
> Retrieve logs for completed/killed YARN application
> usage: general options are...
> {code}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira