Update README.md

README.md

@@ -5,15 +5,18 @@ A super tiny agent (binary 7MB, container 12MB) that pushs app logs to Azure Log
 I have been exploring options to push container logs to a remote storage like Log Analytics. A few available options are:
 
 * Use OMS container (https://hub.docker.com/r/microsoft/oms/) to push logs. However, 1) this solution requires running the OMS container as privileged. 2) the size of the image (307MB)...isn't very nice.
-* Install OMS agent into my app container. I tried, and realized 1) it comes with lots of dependencies, python etc. 2) it doesn't support alpine. 2) Size of just the installer (omsagent-1.4.4-210.universal.x64.sh 110MB), isn't very container fridenly..
+* Install OMS agent into my app container. I tried, and realized 1) it comes with lots of dependencies, python etc. 2) it doesn't support alpine. 2) Size of just the installer (omsagent-1.4.4-210.universal.x64.sh 110MB), isn't very container fridenly. Since I only want to upload logs, most of the dependencies are unnecessary.
 
-Given I simply want logs uploaded, I decided to implement a tiny agent that uses Log Analytics data collector API (https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-data-collector-api), and keept it container friendly.
+Given I simply want logs uploaded, I decided to implement a tiny agent that uses Log Analytics data collector API (https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-data-collector-api), and make it container friendly.
 
 # How to use it
-## Upload container logs
-The best way to use this agent is by adopting the "sidecar" pattern. Having this agent container (yangl/log2oms) run as a "sidecar" of your app container, and use a shared volume to share the app logs to log2oms.
+## Sidecar
 
-Take a nginx web server as example, you simply run yangl/log2oms as another container and shares the nginx /var/log/nginx volume. Log2OMS will tail the nginx logs and upload to Log Analytics.
+The docker image is published at https://hub.docker.com/r/yangl/log2oms/
+
+The best way to use log2oms is by adopting the "[sidecar](https://docs.microsoft.com/en-us/azure/architecture/patterns/sidecar)" pattern. Having log2oms container (image `yangl/log2oms`) run as a "sidecar" of your app container, and use a shared volume to read the app logs and uplaod to log2oms.
+
+Take a nginx web server as example, you simply run `yangl/log2oms` as another container and shares the nginx /var/log/nginx volume. log2oms will tail the nginx logs and upload to Log Analytics automatically.
 
 ```
   +-----------------------------+
@@ -29,9 +32,22 @@ Take a nginx web server as example, you simply run yangl/log2oms as another cont
 The log2oms container requires only 4 environment variables to run:
 
 * `LOG2OMS_WORKSPACE_ID` This is the workspace ID of Log Analytics.
-* `LOG2OMS_WORKSPACE_SECRET` This is the secret of your workspace, you can get from "Advanced Settings" in Azure portal.
+* `LOG2OMS_WORKSPACE_SECRET` This is the secret of your workspace, you can find it from "Advanced Settings" in Azure portal.
 * `LOG2OMS_LOG_FILE` This is the log file to tail and upload. Right now only support 1 file, in nginx case, this will be `access.log`
 * `LOG2OMS_LOG_TYPE` This is the table you want logs upload to. Note that LogAnalytics will add a postfix `_CL` to this name. so if we have `nginx` here, in LogAnalytics the table will be `nginx_CL`.
 
 And that's it. No changes needed from app container.
 
+## Sample in Kubernetes
+`samples/kubernetes/deploy.yaml` is a sample yaml how to deploy an nginx server with log2oms as a sidecar. 
+
+To try the sample:
+1. Run `kubectl create -f samples/kubernetes/deploy.yaml` to create the deployment. 
+2. curl the pod IP on port 80 to generate a few lines of nginx logs.
+3. `kubectl logs {pod-name} log2oms` should show some agent logs like following
+```
+Start tail logs from: /logs/access.log
+[Tue, 27 Feb 2018 07:04:49 GMT] Posted 2 messages.
+[Tue, 27 Feb 2018 07:11:13 GMT] Posted 2 messages.
+```
+４． Wait a few minutes to let LogAnalytics process, then you can query `nginx_access_CL | take 100` in LogAnalytics to see the nginx access logs.