Skip to content

[BEAM-1345] Add internal comments to metrics#3099

Closed
aaltay wants to merge 2 commits intoapache:masterfrom
aaltay:metr
Closed

[BEAM-1345] Add internal comments to metrics#3099
aaltay wants to merge 2 commits intoapache:masterfrom
aaltay:metr

Conversation

@aaltay
Copy link
Member

@aaltay aaltay commented May 11, 2017

from apache_beam.metrics.metricbase import MetricName


__all__ = ['Metrics', 'MetricsFilter']
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MetricsFilter is Experimental in Java, should be marked as such below.

from apache_beam.metrics.cells import CounterCell, DistributionCell

__all__ = [
'MetricKey', 'MetricResult', 'MetricsEnvironment', 'MetricsContainer']
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these all be public? Likely not any of them?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe MetricResult and MetricKey only?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neither show up in init. Where are they used? I'd rather publish them later than sooner, especially as the metrics query API is still experimental.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are not used, and the file already has an internal comment, I will revert this.

@aaltay
Copy link
Member Author

aaltay commented May 11, 2017

PTAL.

@robertwb
Copy link
Contributor

LGTM

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 1960acf on aaltay:metr into ** on apache:master**.

@aaltay aaltay deleted the metr branch May 12, 2017 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants