Tonnes of documentation added #16
Conversation
kafka-stream-q-example-dsl/README.md Outdated
| | ||
| ```bash | ||
| $ sbt | ||
| $ dslPackage/universal:packageZipTarball |
There was a problem hiding this comment.
I would use > as the prompt here inside sbt, like you normally do, to avoid potential confusion.
kafka-stream-q-example-dsl/README.md Outdated
| | ||
| 1. Zookeeper and Kafka are running | ||
| 2. All topics mentioned above are created | ||
| 3. The folder mentioned in `directoyToWatch` in `application.conf` has the data file |
There was a problem hiding this comment.
directoryToWatch (missing second r)
| | ||
| This starts the single instance of the application. After some time you will see data printed in the console regarding the host access information as present from the data file. | ||
| | ||
| In the log file, created under `<...>/dslpackage-0.0.1/logs`, check if the REST service has started and note the host and port details. It should be something like `localhost:7070` (the default setting in `application.conf`). |
There was a problem hiding this comment.
You suggest they edit the logback.xml file above. If the REST endpoint is written using a log statement, is it written with warning, or something like that, so the user is unlikely to suppress it accidentally?
There was a problem hiding this comment.
Currently it's at the INFO level - will change to WARN - good suggestion ..
kafka-stream-q-example-dsl/README.md Outdated
| | ||
| ### Step 3: Run the second instance of the application | ||
| | ||
| If you decide to run multiple instances of the application you may choose to split the dataset into 2 parts and keep them in different folders. Also you need to copy the current distribution in some other folder and start the seocnd instance from there, since you need to run it with changed settings in `application.conf`. Say we want to copy in a folder named `clarknet-2`. |
| | ||
| ```bash | ||
| $ sbt | ||
| $ procPackage/universal:packageZipTarball |
| | ||
| 1. Zookeeper and Kafka are running | ||
| 2. All topics mentioned above are created | ||
| 3. The folder mentioned in `directoyToWatch` in `application.conf` has the data file |
| | ||
| This starts the single instance of the application. After some time you will see data printed in the console regarding the host access information as present from the data file. | ||
| | ||
| In the log file, created under `<...>/procpackage-0.0.1/logs`, check if the REST service has started and note the host and port details. It should be something like `localhost:7070` (the default setting in `application.conf`). |
There was a problem hiding this comment.
Same comment as previously about ensuring the REST message isn't suppressed if the log threshold is set high (like WARN).
Or, is it possible to write this URL to the console?
There was a problem hiding this comment.
Changed to WARN and also added a println which will print to the console
| | ||
| Here are a few examples: | ||
| | ||
| ```bash |
There was a problem hiding this comment.
I think you put these bash comments after the commands in the other README. True? I actually prefer them before the commands, like you have here, but I'm just suggesting you do it consistently, one way or the other.
There was a problem hiding this comment.
Now all the comments are before the commands ..
| Thanks .. I will work on these changes and then merge. |
Some suggested by @deanwampler. Added documentation on how to run applications in distributed mode using the query layer.