Uploaded image for project: 'Flume'
  1. Flume
  2. FLUME-2998

Add missing configuration parameter to SequenceSource docs

    Details

    • Type: Documentation
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.7.0
    • Fix Version/s: 1.7.0
    • Component/s: Docs
    • Labels:
      None

      Description

      totalEvents can be specified

        Activity

        Hide
        bessbd Bessenyei Balázs Donát added a comment - - edited

        Attila Simon: thank you for the patch!

        • What do you mean by "practically" in the first line of the change?
        • nit: "Retry if put failed." -> "Retries when it can't send events to the channel."

        Side note: this would be the first parameter in the documentation with a Java constant ("Long.MAX_VALUE") for default. Do we want to maybe put numbers there instead?

        Show
        bessbd Bessenyei Balázs Donát added a comment - - edited Attila Simon : thank you for the patch! What do you mean by "practically" in the first line of the change? nit: "Retry if put failed." -> "Retries when it can't send events to the channel." Side note: this would be the first parameter in the documentation with a Java constant ("Long.MAX_VALUE") for default. Do we want to maybe put numbers there instead?
        Hide
        sati Attila Simon added a comment -

        Long.MAX_VALUE is 9223372036854775807. Although Long.MAX_VALUE is not a valid expression in the config file I would doubt that the exact number is useful in the docs.
        What I saw in other places is "see description". If it really needed to be changed from Long.MAX_VALUE in the "default value" column then we may use that trick and put it into the description column.

        Show
        sati Attila Simon added a comment - Long.MAX_VALUE is 9223372036854775807. Although Long.MAX_VALUE is not a valid expression in the config file I would doubt that the exact number is useful in the docs. What I saw in other places is "see description". If it really needed to be changed from Long.MAX_VALUE in the "default value" column then we may use that trick and put it into the description column.
        Hide
        bessbd Bessenyei Balázs Donát added a comment -

        +1

        Thank you for the changes, Attila Simon

        Show
        bessbd Bessenyei Balázs Donát added a comment - +1 Thank you for the changes, Attila Simon
        Hide
        denes Denes Arvay added a comment -

        I agree with Bessenyei Balázs Donát's comments.
        Regarding to the default value: I'd vote for using the Long.MAX_VALUE. Yes, it can't be set as value in this form but it's a lot cleaner than the exact number.

        Show
        denes Denes Arvay added a comment - I agree with Bessenyei Balázs Donát 's comments. Regarding to the default value: I'd vote for using the Long.MAX_VALUE. Yes, it can't be set as value in this form but it's a lot cleaner than the exact number.
        Hide
        denes Denes Arvay added a comment -

        +1, thanks Attila Simon for the patch

        Show
        denes Denes Arvay added a comment - +1, thanks Attila Simon for the patch
        Hide
        bessbd Bessenyei Balázs Donát added a comment -

        LGTM. I'm about to commit this.

        Show
        bessbd Bessenyei Balázs Donát added a comment - LGTM. I'm about to commit this.
        Hide
        jira-bot ASF subversion and git services added a comment -

        Commit fca8c5b970cf0bbae61bae08f2084dd4f3bd1143 in flume's branch refs/heads/trunk from Attila Simon
        [ https://git-wip-us.apache.org/repos/asf?p=flume.git;h=fca8c5b ]

        FLUME-2998. Add a missing configuration parameter to SequenceSource docs

        SequenceSource's totalEvents is configurable, but it is not in the documentation.

        This patch fixes that problem by adding the missing configuration parameter to the docs.

        Reviewers: Denes Arvay, Bessenyei Balázs Donát

        (Attila Simon via Bessenyei Balázs Donát)

        Show
        jira-bot ASF subversion and git services added a comment - Commit fca8c5b970cf0bbae61bae08f2084dd4f3bd1143 in flume's branch refs/heads/trunk from Attila Simon [ https://git-wip-us.apache.org/repos/asf?p=flume.git;h=fca8c5b ] FLUME-2998 . Add a missing configuration parameter to SequenceSource docs SequenceSource's totalEvents is configurable, but it is not in the documentation. This patch fixes that problem by adding the missing configuration parameter to the docs. Reviewers: Denes Arvay, Bessenyei Balázs Donát (Attila Simon via Bessenyei Balázs Donát)
        Hide
        bessbd Bessenyei Balázs Donát added a comment -

        Thank you for the patch, Attila Simon

        Show
        bessbd Bessenyei Balázs Donát added a comment - Thank you for the patch, Attila Simon
        Hide
        bessbd Bessenyei Balázs Donát added a comment -

        Thank you for the review, Denes Arvay

        Show
        bessbd Bessenyei Balázs Donát added a comment - Thank you for the review, Denes Arvay
        Hide
        hudson Hudson added a comment -

        ABORTED: Integrated in Jenkins build Flume-trunk-hbase-1 #206 (See https://builds.apache.org/job/Flume-trunk-hbase-1/206/)
        FLUME-2998. Add a missing configuration parameter to SequenceSource docs (bessbd: http://git-wip-us.apache.org/repos/asf/flume/repo?p=flume.git&a=commit&h=fca8c5b970cf0bbae61bae08f2084dd4f3bd1143)

        • (edit) flume-ng-doc/sphinx/FlumeUserGuide.rst
        Show
        hudson Hudson added a comment - ABORTED: Integrated in Jenkins build Flume-trunk-hbase-1 #206 (See https://builds.apache.org/job/Flume-trunk-hbase-1/206/ ) FLUME-2998 . Add a missing configuration parameter to SequenceSource docs (bessbd: http://git-wip-us.apache.org/repos/asf/flume/repo?p=flume.git&a=commit&h=fca8c5b970cf0bbae61bae08f2084dd4f3bd1143 ) (edit) flume-ng-doc/sphinx/FlumeUserGuide.rst

          People

          • Assignee:
            sati Attila Simon
            Reporter:
            sati Attila Simon
          • Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development