hadoop-yarn-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Varun Saxena (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (YARN-7140) CollectorInfo should have Public visibility
Date Thu, 31 Aug 2017 11:57:00 GMT

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

Varun Saxena edited comment on YARN-7140 at 8/31/17 11:56 AM:
--------------------------------------------------------------

[~rohithsharma], I referred to https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/InterfaceClassification.html#Unstable
{panel}
Incompatible changes to Unstable APIs are allowed at any time. *This usually makes sense for
only private interfaces.*

*However one may call this out for a supposedly public interface to highlight that it should
not be used as an interface; for public interfaces, labeling it as Not-an-interface is probably
more appropriate than “Unstable”.*

Examples of publicly visible interfaces that are unstable (i.e. not-an-interface): GUI, CLIs
whose output format will change.

..............
* Aren’t all public interfaces stable?

One may mark a public interface as evolving in its early days. Here one is promising to make
an effort to make compatible changes but may need to break it at minor releases.
{panel}

As you can see the guideline is to make an interface Unstable typically for Private interfaces
only unless its something like a CLI. So I made it evolving based on my understanding of above.

Will we making any changes to CollectorInfo in future? Most probably not. But as it is new
feature I thought better to mark it evolving instead of stable. Not sure if it is unstable
going by definition above. Thoughts? 
Frankly CollectorInfo APIs' are not even required to be called by AM. It is just passed onto
TimelineV2ClientImpl.


was (Author: varun_saxena):
[~rohithsharma], I referred to https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/InterfaceClassification.html#Unstable
{panel}
Incompatible changes to Unstable APIs are allowed at any time. *This usually makes sense for
only private interfaces.*

*However one may call this out for a supposedly public interface to highlight that it should
not be used as an interface; for public interfaces, labeling it as Not-an-interface is probably
more appropriate than “Unstable”.*

Examples of publicly visible interfaces that are unstable (i.e. not-an-interface): GUI, CLIs
whose output format will change.
{panel}

As you can see the guideline is to make an interface Unstable typically for Private interfaces
only unless its something like a CLI.

Will we making any changes to CollectorInfo in future?
Frankly CollectorInfo APIs' are not even required to be called by AM. It is just passed onto
TimelineV2ClientImpl.

> CollectorInfo should have Public visibility
> -------------------------------------------
>
>                 Key: YARN-7140
>                 URL: https://issues.apache.org/jira/browse/YARN-7140
>             Project: Hadoop YARN
>          Issue Type: Bug
>            Reporter: Varun Saxena
>            Assignee: Varun Saxena
>            Priority: Minor
>         Attachments: YARN-7140.01.patch
>
>
> As TimelineV2Client#setCollectorInfo, which needs to be called by AM, it requires CollectorInfo
to have public visibility



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: yarn-issues-help@hadoop.apache.org


Mime
View raw message