Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-4302

Add JavaDocs to MetricConfig

        Details

        • Type: Improvement
        • Status: Closed
        • Priority: Major
        • Resolution: Fixed
        • Affects Version/s: 1.1.0
        • Fix Version/s: 1.2.0, 1.1.2
        • Component/s: Metrics
        • Labels:
          None

          Description

          MetricConfig has no comments at all. If you want to implement a custom reporter and you want to implement its open method, a MetricConfig is its argument. It will be helpful to add one class-level JavaDoc stating where the config values are coming from etc.

          Chesnay Schepler what do you think?

            Issue Links

            is duplicated by

            Improvement - An improvement or enhancement to an existing feature or task. FLINK-4365 [metrics] MetricConfig has no documentation

            • Trivial - Cosmetic problem like misspelt words or misaligned text.
            • Closed

              Activity

              Ascending order - Click to sort in descending order
              Hide
              Permalink
              Zentol Chesnay Schepler added a comment -

              that's a good idea.

              We could also think about renaming the class to MetricProperties; should make it clearer to people what kind of object they are dealing with.

              Show
              Zentol Chesnay Schepler added a comment - that's a good idea. We could also think about renaming the class to MetricProperties; should make it clearer to people what kind of object they are dealing with.
              Hide
              Permalink
              Zentol Chesnay Schepler added a comment -

              PR can be found here: https://github.com/apache/flink/pull/2349

              Show
              Zentol Chesnay Schepler added a comment - PR can be found here: https://github.com/apache/flink/pull/2349
              Hide
              Permalink
              Zentol Chesnay Schepler added a comment -

              Fixed in c5a9a3eb0061014fe59086505130596e924db7f9 and cbce10d100a19247476035ed53ea8196d19051f5

              Show
              Zentol Chesnay Schepler added a comment - Fixed in c5a9a3eb0061014fe59086505130596e924db7f9 and cbce10d100a19247476035ed53ea8196d19051f5

                People

                • Assignee:
                  Zentol Chesnay Schepler
                  Reporter:
                  uce Ufuk Celebi
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  1 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Development