[HDDS-2346] Replication manager config has wrong description

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 0.5.0
• Component/s: SCM
• Labels: pull-request-available
• Target Version/s: 0.5.0
• Assignee: Attila Doroszlai
• Reporter: Attila Doroszlai
• Created: 22/Oct/19 08:24
• Updated: 24/Feb/20 20:50
• Resolved: 22/Oct/19 16:25

Description

Replication manager's configuration for its own interval:

https://github.com/apache/hadoop-ozone/blob/eb1d77e3206fab1a4ac0573507c9deb2b56b9ea1/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/ReplicationManager.java#L808-L822

    @Config(key = "thread.interval",
        type = ConfigType.TIME,
        defaultValue = "300s",
        tags = {SCM, OZONE},
        description = "When a heartbeat from the data node arrives on SCM, "
            + "It is queued for processing with the time stamp of when the "
            + "heartbeat arrived. There is a heartbeat processing thread "
            + "inside "
            + "SCM that runs at a specified interval. This value controls how "
            + "frequently this thread is run.\n\n"
            + "There are some assumptions build into SCM such as this "
            + "value should allow the heartbeat processing thread to run at "
            + "least three times more frequently than heartbeats and at least "
            + "five times more than stale node detection time. "
            + "If you specify a wrong value, SCM will gracefully refuse to "
            + "run. "
            + "For more info look at the node manager tests in SCM.\n"
            + "\n"
            + "In short, you don't need to change this."
    )

duplicates SCM heartbeat interval doc:

https://github.com/apache/hadoop-ozone/blob/eb1d77e3206fab1a4ac0573507c9deb2b56b9ea1/hadoop-hdds/common/src/main/resources/ozone-default.xml#L973-L991

  <property>
    <name>ozone.scm.heartbeat.thread.interval</name>
    <value>3s</value>
    <tag>OZONE, MANAGEMENT</tag>
    <description>
      When a heartbeat from the data node arrives on SCM, It is queued for
      processing with the time stamp of when the heartbeat arrived. There is a
      heartbeat processing thread inside SCM that runs at a specified interval.
      This value controls how frequently this thread is run.

      There are some assumptions build into SCM such as this value should allow
      the heartbeat processing thread to run at least three times more
      frequently than heartbeats and at least five times more than stale node
      detection time. If you specify a wrong value, SCM will gracefully refuse
      to run. For more info look at the node manager tests in SCM.

      In short, you don't need to change this.
    </description>
  </property>

Issue Links

• links to: GitHub Pull Request #73