[GitHub] [incubator-pinot] mcvsubbu commented on a change in pull request #5737: Improvements to RealtimeProvisioningHelper command

[GitBox <gi...@apache.org>]

mcvsubbu commented on a change in pull request #5737:
URL: https://github.com/apache/incubator-pinot/pull/5737#discussion_r460333511



##########
File path: pinot-tools/src/main/java/org/apache/pinot/tools/admin/command/RealtimeProvisioningHelperCommand.java
##########
@@ -145,6 +146,20 @@ public boolean getHelp() {
     return _help;
   }
 
+  @Override
+  public void printExamples() {
+    StringBuilder builder = new StringBuilder();
+    builder.append("\n\nThis command allows you to estimate the capacity needed for provisioning realtime hosts")
+        .append("It assumes that there is no upper limit to the amount of memory you can mmap")
+        .append("\nIf you have a hybrid table, then consult the push frequency setting in your offline table specify it in the -pushFrequency argument")
+        .append("\nIf you have a realtime-only table, then the default behavior is to assume that your queries need all data in memory all the time")
+        .append("\nHowever, if most of your queries are going to be for (say) the last 96 hours, then you can specify that in -retentionHours")
+        .append("\nDoing so will let this program assume that you are willing to take a page hit when querying older data")
+        .append("\nand optimize memory and number of hosts accordingly.")
+        ;
+    System.out.println(builder.toString());

Review comment:
       No, sout. Think of this as a part of the result. When users cut/paste the results of the command, I found myself asking them : "So, what arguments were provided to the command?" We can now say "cut-paste everything under the === line" and get all information we want.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org