diff --git a/README.md b/README.md index a10a3c9a1..9ccb0b200 100644 --- a/README.md +++ b/README.md @@ -174,7 +174,7 @@ sudo scope launch --service-token= Scope comes with built-in Kubernetes support. We recommend to run Scope natively in your Kubernetes cluster using -[this resource definitions](https://github.com/TheNewNormal/kube-charts/tree/master/weavescope/manifests). +[these resource definitions](https://github.com/TheNewNormal/kube-charts/tree/master/weavescope/manifests). 1. If you are running a Kubernetes version lower than 1.1, make sure your cluster allows running pods in privileged mode (required by the Scope @@ -198,7 +198,9 @@ in your Kubernetes cluster using 3. Download the resource definitions: ``` -for I in app-rc app-svc probe-ds; do curl -s -L https://raw.githubusercontent.com/TheNewNormal/kube-charts/master/weavescope/manifests/scope-$I.yaml -o scope-$I.yaml; done +for I in app-rc app-svc probe-ds; do + curl -s -L https://raw.githubusercontent.com/TheNewNormal/kube-charts/master/weavescope/manifests/scope-$I.yaml -o scope-$I.yaml +done ``` 4. Tweak the Scope probe configuration at `scope-probe-ds.yaml`, namely: @@ -224,7 +226,7 @@ proceeding. The main build is `make`, which builds the UI build container, builds the UI in said container, builds the backend build container, builds -the app and probe in a said container, and finally pushes the lot into +the app and probe in said container, and finally pushes the lot into a Docker image called **weaveworks/scope**. ``` @@ -244,11 +246,11 @@ make deps ``` Note that the tools from `make deps` will depend on a local install of -[go](https://golang.org). +[Go](https://golang.org). ## Debugging -Scope has a collection of built in debugging tools to aid Scope delevopers. +Scope has a collection of built-in debugging tools to aid Scope developers. - To get debug information in the logs launch Scope with `--debug`: ``` @@ -262,26 +264,25 @@ kill -QUIT $(pgrep -f scope-(app|probe)) docker logs weavescope ``` -- The Scope Probe is instrumented with various counters and timers. To have it dump - those values, run: +- The Scope Probe is instrumented with various counters and timers. To have it dump those values, run: ``` kill -USR1 $(pgrep -f scope-probe) docker logs weavescope ``` - Both the Scope App and the Scope Probe offer - [http endpoints with profiling information](https://golang.org/pkg/net/http/pprof/). + [HTTP endpoints with profiling information](https://golang.org/pkg/net/http/pprof/). These cover things such as CPU usage and memory consumption: - * The Scope App enables its http profiling endpoints by default, which + * The Scope App enables its HTTP profiling endpoints by default, which are accessible on the same port the Scope UI is served (4040). * The Scope Probe doesn't enable its profiling endpoints by default. To enable them, you must launch Scope with `--probe.http.listen addr:port`. - For instance, launching scope with `scope launch --probe.http.listen :4041`, will + For instance, launching Scope with `scope launch --probe.http.listen :4041`, will allow you access the Scope Probe's profiling endpoints on port 4041. Then, you can collect profiles in the usual way. For instance: - * To collect the Memory profile of the Scope App: + * To collect the memory profile of the Scope App: ``` go tool pprof http://localhost:4040/debug/pprof/heap @@ -292,9 +293,9 @@ go tool pprof http://localhost:4040/debug/pprof/heap go tool pprof http://localhost:4041/debug/pprof/profile ``` - If you don't have `go` installed, you can use a docker container instead: + If you don't have `go` installed, you can use a Docker container instead: - * To collect the Memory profile of the Scope App: + * To collect the memory profile of the Scope App: ``` docker run --net=host -v $PWD:/root/pprof golang go tool pprof http://localhost:4040/debug/pprof/heap