{"action":"created","comment":{"url":"https://api.github.com/repos/apache/spark/pulls/comments/35960160","id":35960160,"diff_hunk":"@@ -0,0 +1,124 @@\n+/*\n+ * Licensed to the Apache Software Foundation (ASF) under one or more\n+ * contributor license agreements.  See the NOTICE file distributed with\n+ * this work for additional information regarding copyright ownership.\n+ * The ASF licenses this file to You under the Apache License, Version 2.0\n+ * (the \"License\"); you may not use this file except in compliance with\n+ * the License.  You may obtain a copy of the License at\n+ *\n+ *    http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.apache.spark.streaming.scheduler.rate\n+\n+/**\n+ * Implements a proportional-integral-derivative (PID) controller which acts on\n+ * the speed of ingestion of elements into Spark Streaming. A PID controller works\n+ * by calculating an '''error''' between a measured output and a desired value. In the\n+ * case of Spark Streaming the error is the difference between the measured processing\n+ * rate (number of elements/processing delay) and the previous rate.\n+ *\n+ * @see https://en.wikipedia.org/wiki/PID_controller\n+ *\n+ * @param batchDurationMillis the batch duration, in milliseconds\n+ * @param proportional how much the correction should depend on the current\n+ *        error. This term usually provides the bulk of correction and should be positive or zero.\n+ *        A value too large would make the controller overshoot the setpoint, while a small value\n+ *        would make the controller too insensitive. The default value is 1.\n+ * @param integral how much the correction should depend on the accumulation\n+ *        of past errors. This value should be positive or 0. This term accelerates the movement\n+ *        towards the desired value, but a large value may lead to overshooting. The default value\n+ *        is 0.2.\n+ * @param derivative how much the correction should depend on a prediction\n+ *        of future errors, based on current rate of change. This value should be positive or 0.\n+ *        This term is not used very often, as it impacts stability of the system. The default\n+ *        value is 0.\n+ */\n+private[streaming] class PIDRateEstimator(\n+    batchIntervalMillis: Long,\n+    proportional: Double = 1D,\n+    integral: Double = .2D,\n+    derivative: Double = 0D)\n+  extends RateEstimator {\n+\n+  private var firstRun: Boolean = true\n+  private var latestTime: Long = -1L\n+  private var latestRate: Double = -1D\n+  private var latestError: Double = -1L\n+\n+  require(\n+    batchIntervalMillis > 0,\n+    s\"Specified batch interval $batchIntervalMillis in PIDRateEstimator is invalid.\")\n+  require(\n+    proportional >= 0,\n+    s\"Proportional term $proportional in PIDRateEstimator should be >= 0.\")","path":"streaming/src/main/scala/org/apache/spark/streaming/scheduler/rate/PIDRateEstimator.scala","position":60,"original_position":60,"commit_id":"aa5b097e3d58f07feb830f0ff5456088064b7fff","original_commit_id":"aa5b097e3d58f07feb830f0ff5456088064b7fff","user":{"login":"tdas","id":663212,"avatar_url":"https://avatars.githubusercontent.com/u/663212?v=3","gravatar_id":"","url":"https://api.github.com/users/tdas","html_url":"https://github.com/tdas","followers_url":"https://api.github.com/users/tdas/followers","following_url":"https://api.github.com/users/tdas/following{/other_user}","gists_url":"https://api.github.com/users/tdas/gists{/gist_id}","starred_url":"https://api.github.com/users/tdas/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tdas/subscriptions","organizations_url":"https://api.github.com/users/tdas/orgs","repos_url":"https://api.github.com/users/tdas/repos","events_url":"https://api.github.com/users/tdas/events{/privacy}","received_events_url":"https://api.github.com/users/tdas/received_events","type":"User","site_admin":false},"body":"Did you see my earlier comment about > 1 not being practically feasible.","created_at":"2015-07-31T09:48:21Z","updated_at":"2015-07-31T09:48:21Z","html_url":"https://github.com/apache/spark/pull/7648#discussion_r35960160","pull_request_url":"https://api.github.com/repos/apache/spark/pulls/7648","_links":{"self":{"href":"https://api.github.com/repos/apache/spark/pulls/comments/35960160"},"html":{"href":"https://github.com/apache/spark/pull/7648#discussion_r35960160"},"pull_request":{"href":"https://api.github.com/repos/apache/spark/pulls/7648"}}},"pull_request":{"url":"https://api.github.com/repos/apache/spark/pulls/7648","id":40796280,"html_url":"https://github.com/apache/spark/pull/7648","diff_url":"https://github.com/apache/spark/pull/7648.diff","patch_url":"https://github.com/apache/spark/pull/7648.patch","issue_url":"https://api.github.com/repos/apache/spark/issues/7648","number":7648,"state":"open","locked":false,"title":"[SPARK-8979] Add a PID based rate estimator","user":{"login":"dragos","id":133742,"avatar_url":"https://avatars.githubusercontent.com/u/133742?v=3","gravatar_id":"","url":"https://api.github.com/users/dragos","html_url":"https://github.com/dragos","followers_url":"https://api.github.com/users/dragos/followers","following_url":"https://api.github.com/users/dragos/following{/other_user}","gists_url":"https://api.github.com/users/dragos/gists{/gist_id}","starred_url":"https://api.github.com/users/dragos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dragos/subscriptions","organizations_url":"https://api.github.com/users/dragos/orgs","repos_url":"https://api.github.com/users/dragos/repos","events_url":"https://api.github.com/users/dragos/events{/privacy}","received_events_url":"https://api.github.com/users/dragos/received_events","type":"User","site_admin":false},"body":"Based on #7600 \r\n\r\n/cc @tdas ","created_at":"2015-07-24T17:17:36Z","updated_at":"2015-07-31T09:48:21Z","closed_at":null,"merged_at":null,"merge_commit_sha":"90f490b50a04585dbd914faa36a77c1d7ecb47de","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/apache/spark/pulls/7648/commits","review_comments_url":"https://api.github.com/repos/apache/spark/pulls/7648/comments","review_comment_url":"https://api.github.com/repos/apache/spark/pulls/comments{/number}","comments_url":"https://api.github.com/repos/apache/spark/issues/7648/comments","statuses_url":"https://api.github.com/repos/apache/spark/statuses/aa5b097e3d58f07feb830f0ff5456088064b7fff","head":{"label":"typesafehub:topic/streaming-bp/pid","ref":"topic/streaming-bp/pid","sha":"aa5b097e3d58f07feb830f0ff5456088064b7fff","user":{"login":"typesafehub","id":784923,"avatar_url":"https://avatars.githubusercontent.com/u/784923?v=3","gravatar_id":"","url":"https://api.github.com/users/typesafehub","html_url":"https://github.com/typesafehub","followers_url":"https://api.github.com/users/typesafehub/followers","following_url":"https://api.github.com/users/typesafehub/following{/other_user}","gists_url":"https://api.github.com/users/typesafehub/gists{/gist_id}","starred_url":"https://api.github.com/users/typesafehub/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/typesafehub/subscriptions","organizations_url":"https://api.github.com/users/typesafehub/orgs","repos_url":"https://api.github.com/users/typesafehub/repos","events_url":"https://api.github.com/users/typesafehub/events{/privacy}","received_events_url":"https://api.github.com/users/typesafehub/received_events","type":"Organization","site_admin":false},"repo":{"id":29734925,"name":"spark","full_name":"typesafehub/spark","owner":{"login":"typesafehub","id":784923,"avatar_url":"https://avatars.githubusercontent.com/u/784923?v=3","gravatar_id":"","url":"https://api.github.com/users/typesafehub","html_url":"https://github.com/typesafehub","followers_url":"https://api.github.com/users/typesafehub/followers","following_url":"https://api.github.com/users/typesafehub/following{/other_user}","gists_url":"https://api.github.com/users/typesafehub/gists{/gist_id}","starred_url":"https://api.github.com/users/typesafehub/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/typesafehub/subscriptions","organizations_url":"https://api.github.com/users/typesafehub/orgs","repos_url":"https://api.github.com/users/typesafehub/repos","events_url":"https://api.github.com/users/typesafehub/events{/privacy}","received_events_url":"https://api.github.com/users/typesafehub/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/typesafehub/spark","description":"Mirror of Apache Spark","fork":true,"url":"https://api.github.com/repos/typesafehub/spark","forks_url":"https://api.github.com/repos/typesafehub/spark/forks","keys_url":"https://api.github.com/repos/typesafehub/spark/keys{/key_id}","collaborators_url":"https://api.github.com/repos/typesafehub/spark/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/typesafehub/spark/teams","hooks_url":"https://api.github.com/repos/typesafehub/spark/hooks","issue_events_url":"https://api.github.com/repos/typesafehub/spark/issues/events{/number}","events_url":"https://api.github.com/repos/typesafehub/spark/events","assignees_url":"https://api.github.com/repos/typesafehub/spark/assignees{/user}","branches_url":"https://api.github.com/repos/typesafehub/spark/branches{/branch}","tags_url":"https://api.github.com/repos/typesafehub/spark/tags","blobs_url":"https://api.github.com/repos/typesafehub/spark/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/typesafehub/spark/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/typesafehub/spark/git/refs{/sha}","trees_url":"https://api.github.com/repos/typesafehub/spark/git/trees{/sha}","statuses_url":"https://api.github.com/repos/typesafehub/spark/statuses/{sha}","languages_url":"https://api.github.com/repos/typesafehub/spark/languages","stargazers_url":"https://api.github.com/repos/typesafehub/spark/stargazers","contributors_url":"https://api.github.com/repos/typesafehub/spark/contributors","subscribers_url":"https://api.github.com/repos/typesafehub/spark/subscribers","subscription_url":"https://api.github.com/repos/typesafehub/spark/subscription","commits_url":"https://api.github.com/repos/typesafehub/spark/commits{/sha}","git_commits_url":"https://api.github.com/repos/typesafehub/spark/git/commits{/sha}","comments_url":"https://api.github.com/repos/typesafehub/spark/comments{/number}","issue_comment_url":"https://api.github.com/repos/typesafehub/spark/issues/comments{/number}","contents_url":"https://api.github.com/repos/typesafehub/spark/contents/{+path}","compare_url":"https://api.github.com/repos/typesafehub/spark/compare/{base}...{head}","merges_url":"https://api.github.com/repos/typesafehub/spark/merges","archive_url":"https://api.github.com/repos/typesafehub/spark/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/typesafehub/spark/downloads","issues_url":"https://api.github.com/repos/typesafehub/spark/issues{/number}","pulls_url":"https://api.github.com/repos/typesafehub/spark/pulls{/number}","milestones_url":"https://api.github.com/repos/typesafehub/spark/milestones{/number}","notifications_url":"https://api.github.com/repos/typesafehub/spark/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/typesafehub/spark/labels{/name}","releases_url":"https://api.github.com/repos/typesafehub/spark/releases{/id}","created_at":"2015-01-23T14:05:28Z","updated_at":"2015-05-07T13:38:44Z","pushed_at":"2015-07-31T09:27:58Z","git_url":"git://github.com/typesafehub/spark.git","ssh_url":"git@github.com:typesafehub/spark.git","clone_url":"https://github.com/typesafehub/spark.git","svn_url":"https://github.com/typesafehub/spark","homepage":null,"size":116396,"stargazers_count":1,"watchers_count":1,"language":"Scala","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":5,"forks":0,"open_issues":5,"watchers":1,"default_branch":"master"}},"base":{"label":"apache:master","ref":"master","sha":"6175d6cfe795fbd88e3ee713fac375038a3993a8","user":{"login":"apache","id":47359,"avatar_url":"https://avatars.githubusercontent.com/u/47359?v=3","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"repo":{"id":17165658,"name":"spark","full_name":"apache/spark","owner":{"login":"apache","id":47359,"avatar_url":"https://avatars.githubusercontent.com/u/47359?v=3","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/apache/spark","description":"Mirror of Apache Spark","fork":false,"url":"https://api.github.com/repos/apache/spark","forks_url":"https://api.github.com/repos/apache/spark/forks","keys_url":"https://api.github.com/repos/apache/spark/keys{/key_id}","collaborators_url":"https://api.github.com/repos/apache/spark/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/apache/spark/teams","hooks_url":"https://api.github.com/repos/apache/spark/hooks","issue_events_url":"https://api.github.com/repos/apache/spark/issues/events{/number}","events_url":"https://api.github.com/repos/apache/spark/events","assignees_url":"https://api.github.com/repos/apache/spark/assignees{/user}","branches_url":"https://api.github.com/repos/apache/spark/branches{/branch}","tags_url":"https://api.github.com/repos/apache/spark/tags","blobs_url":"https://api.github.com/repos/apache/spark/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/apache/spark/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/apache/spark/git/refs{/sha}","trees_url":"https://api.github.com/repos/apache/spark/git/trees{/sha}","statuses_url":"https://api.github.com/repos/apache/spark/statuses/{sha}","languages_url":"https://api.github.com/repos/apache/spark/languages","stargazers_url":"https://api.github.com/repos/apache/spark/stargazers","contributors_url":"https://api.github.com/repos/apache/spark/contributors","subscribers_url":"https://api.github.com/repos/apache/spark/subscribers","subscription_url":"https://api.github.com/repos/apache/spark/subscription","commits_url":"https://api.github.com/repos/apache/spark/commits{/sha}","git_commits_url":"https://api.github.com/repos/apache/spark/git/commits{/sha}","comments_url":"https://api.github.com/repos/apache/spark/comments{/number}","issue_comment_url":"https://api.github.com/repos/apache/spark/issues/comments{/number}","contents_url":"https://api.github.com/repos/apache/spark/contents/{+path}","compare_url":"https://api.github.com/repos/apache/spark/compare/{base}...{head}","merges_url":"https://api.github.com/repos/apache/spark/merges","archive_url":"https://api.github.com/repos/apache/spark/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/apache/spark/downloads","issues_url":"https://api.github.com/repos/apache/spark/issues{/number}","pulls_url":"https://api.github.com/repos/apache/spark/pulls{/number}","milestones_url":"https://api.github.com/repos/apache/spark/milestones{/number}","notifications_url":"https://api.github.com/repos/apache/spark/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/apache/spark/labels{/name}","releases_url":"https://api.github.com/repos/apache/spark/releases{/id}","created_at":"2014-02-25T08:00:08Z","updated_at":"2015-07-31T07:57:16Z","pushed_at":"2015-07-31T09:41:51Z","git_url":"git://github.com/apache/spark.git","ssh_url":"git@github.com:apache/spark.git","clone_url":"https://github.com/apache/spark.git","svn_url":"https://github.com/apache/spark","homepage":null,"size":1628367,"stargazers_count":4924,"watchers_count":4924,"language":"Scala","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":4465,"mirror_url":"git://git.apache.org/spark.git","open_issues_count":347,"forks":4465,"open_issues":347,"watchers":4924,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/apache/spark/pulls/7648"},"html":{"href":"https://github.com/apache/spark/pull/7648"},"issue":{"href":"https://api.github.com/repos/apache/spark/issues/7648"},"comments":{"href":"https://api.github.com/repos/apache/spark/issues/7648/comments"},"review_comments":{"href":"https://api.github.com/repos/apache/spark/pulls/7648/comments"},"review_comment":{"href":"https://api.github.com/repos/apache/spark/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/apache/spark/pulls/7648/commits"},"statuses":{"href":"https://api.github.com/repos/apache/spark/statuses/aa5b097e3d58f07feb830f0ff5456088064b7fff"}}}}