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

Wrong metrics parameter names in documentation

        Details

        • Type: Bug
        • Status: Resolved
        • Priority: Trivial
        • Resolution: Resolved
        • Affects Version/s: 1.1.1
        • Fix Version/s: 1.1.2
        • Component/s: Documentation
        • Labels:
          None
        • Environment:

          all

          Description

          On the page https://ci.apache.org/projects/flink/flink-docs-master/apis/metrics.html
          the following metrics parameters should be

          faulty: metrics.scope.tm.task , should be metrics.scope.task
          faulty: metrics.scope.tm.operator , should be metrics.scope.operator

          to make it work on Flink 1.1.1.

          But to fix this, the constants in ConfigConstants.java can also be changed to fit the documentation. Either way...

            Issue Links

            links to

            Web Link GitHub Pull Request #2382

              Activity

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

              the documentation should be adjusted.

              Show
              Zentol Chesnay Schepler added a comment - the documentation should be adjusted.
              Hide
              Permalink
              neelesh77 Neelesh Srinivas Salian added a comment -

              If you don't mind, shall I work on this JIRA?

              Show
              neelesh77 Neelesh Srinivas Salian added a comment - If you don't mind, shall I work on this JIRA?
              Hide
              Permalink
              rvdwenden RWenden added a comment -

              Ok with me.

              Show
              rvdwenden RWenden added a comment - Ok with me.
              Hide
              Permalink
              neelesh77 Neelesh Srinivas Salian added a comment -

              Thank you. Posting a PR soon.

              Show
              neelesh77 Neelesh Srinivas Salian added a comment - Thank you. Posting a PR soon.
              Hide
              Permalink
              githubbot ASF GitHub Bot added a comment -

              GitHub user nssalian opened a pull request:

              https://github.com/apache/flink/pull/2382

              FLINK-4402: Wrong metrics parameter names in documentation

              Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
              If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the [How To Contribute guide](http://flink.apache.org/how-to-contribute.html).
              In addition to going through the list, please provide a meaningful description of your changes.

              • [ ] Tests & Build
              • `mvn clean verify` has been executed successfully locally or a Travis build has passed

              You can merge this pull request into a Git repository by running:

              $ git pull https://github.com/nssalian/flink FLINK-4402

              Alternatively you can review and apply these changes as the patch at:

              https://github.com/apache/flink/pull/2382.patch

              To close this pull request, make a commit to your master/trunk branch
              with (at least) the following in the commit message:

              This closes #2382

              commit 3d22950493abfdb8caae72447bb71bd6fcb8f709
              Author: Neelesh Srinivas Salian <nsalian@cloudera.com>
              Date: 2016-08-17T18:30:06Z

              FLINK-4402: Changed the documentation for the metrics in the System Scope Section

              Show
              githubbot ASF GitHub Bot added a comment - GitHub user nssalian opened a pull request: https://github.com/apache/flink/pull/2382 FLINK-4402 : Wrong metrics parameter names in documentation Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration. If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the [How To Contribute guide] ( http://flink.apache.org/how-to-contribute.html ). In addition to going through the list, please provide a meaningful description of your changes. [ ] General JIRA- https://issues.apache.org/jira/browse/FLINK-4402 Title: Wrong metrics parameter names in documentation [ ] Documentation Changed the task and operator metrics in https://ci.apache.org/projects/flink/flink-docs-master/apis/metrics.html to align with ConfigConstants.java [ ] Tests & Build `mvn clean verify` has been executed successfully locally or a Travis build has passed You can merge this pull request into a Git repository by running: $ git pull https://github.com/nssalian/flink FLINK-4402 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/2382.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #2382 commit 3d22950493abfdb8caae72447bb71bd6fcb8f709 Author: Neelesh Srinivas Salian <nsalian@cloudera.com> Date: 2016-08-17T18:30:06Z FLINK-4402 : Changed the documentation for the metrics in the System Scope Section
              Hide
              Permalink
              githubbot ASF GitHub Bot added a comment -

              Github user rmetzger commented on the issue:

              https://github.com/apache/flink/pull/2382

              Thank you for your contribution.
              I think its good to merge. @zentol can you confirm?

              Show
              githubbot ASF GitHub Bot added a comment - Github user rmetzger commented on the issue: https://github.com/apache/flink/pull/2382 Thank you for your contribution. I think its good to merge. @zentol can you confirm?
              Hide
              Permalink
              githubbot ASF GitHub Bot added a comment -

              Github user zentol commented on the issue:

              https://github.com/apache/flink/pull/2382

              +1

              Show
              githubbot ASF GitHub Bot added a comment - Github user zentol commented on the issue: https://github.com/apache/flink/pull/2382 +1
              Hide
              Permalink
              githubbot ASF GitHub Bot added a comment -

              Github user rmetzger commented on the issue:

              https://github.com/apache/flink/pull/2382

              merging ...

              Show
              githubbot ASF GitHub Bot added a comment - Github user rmetzger commented on the issue: https://github.com/apache/flink/pull/2382 merging ...
              Hide
              Permalink
              rmetzger Robert Metzger added a comment -

              Resolved in http://git-wip-us.apache.org/repos/asf/flink/commit/3be9a285

              Thank you for the contribution!

              Show
              rmetzger Robert Metzger added a comment - Resolved in http://git-wip-us.apache.org/repos/asf/flink/commit/3be9a285 Thank you for the contribution!
              Hide
              Permalink
              githubbot ASF GitHub Bot added a comment -

              Github user asfgit closed the pull request at:

              https://github.com/apache/flink/pull/2382

              Show
              githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/2382
              Hide
              Permalink
              githubbot ASF GitHub Bot added a comment -

              Github user nssalian commented on the issue:

              https://github.com/apache/flink/pull/2382

              Thank you @rmetzger and @zentol

              Show
              githubbot ASF GitHub Bot added a comment - Github user nssalian commented on the issue: https://github.com/apache/flink/pull/2382 Thank you @rmetzger and @zentol

                People

                • Assignee:
                  neelesh77 Neelesh Srinivas Salian
                  Reporter:
                  rvdwenden RWenden
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  4 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Time Tracking

                    Estimated:
                    Original Estimate - 4h
                    4h
                    Remaining:
                    Remaining Estimate - 4h
                    4h
                    Logged:
                    Time Spent - Not Specified
                    Not Specified

                      Development