mirror of
https://github.com/weaveworks/scope.git
synced 2026-03-03 18:20:27 +00:00
202 lines
7.4 KiB
Markdown
202 lines
7.4 KiB
Markdown
# Scope
|
|
|
|
[](https://circleci.com/gh/weaveworks/scope/tree/master) [](https://coveralls.io/r/weaveworks/scope) [](https://sourcegraph.com/github.com/weaveworks/scope)
|
|
|
|
|
|
|
|
|
|
## <a name="overview"></a>Overview
|
|
|
|
Weave Scope automatically generates a map of your containers, enabling you to
|
|
intuitively understand, monitor, and control your applications.
|
|
|
|
|
|
## <a name="getting-started"></a>Getting started
|
|
|
|
```
|
|
sudo wget -O /usr/local/bin/scope \
|
|
https://github.com/weaveworks/scope/releases/download/latest_release/scope
|
|
sudo chmod a+x /usr/local/bin/scope
|
|
sudo scope launch
|
|
```
|
|
|
|
This script will download and run a recent Scope image from the Docker Hub.
|
|
Now, open your web browser to **http://localhost:4040**. (If you're using
|
|
boot2docker, replace localhost with the output of `boot2docker ip`.)
|
|
|
|
|
|
## <a name="requirements"></a>Requirements
|
|
|
|
Scope does not need any configuration and does not require the Weave Network.
|
|
But Scope does need to be running on every machine you want to monitor.
|
|
|
|
|
|
## <a name="architecture"></a>Architecture
|
|
|
|
Weave Scope consists of two components: the app and the probe. These two
|
|
components are deployed as a single Docker container using the `scope`
|
|
script.
|
|
|
|
The probe is responsible for gathering information about the host is it running
|
|
on. This information is sent to the app in the form of a report. The app is
|
|
responsible for processing reports from the probe into usable topologies,
|
|
serving the UI, and pushing these topologies to the UI.
|
|
|
|
```
|
|
+--Docker host----------+
|
|
| +--Container------+ | .---------------.
|
|
| | | | | Browser |
|
|
| | +-----------+ | | |---------------|
|
|
| | | scope-app |<---------| |
|
|
| | +-----------+ | | | |
|
|
| | ^ | | | |
|
|
| | | | | '---------------'
|
|
| | +-------------+ | |
|
|
| | | scope-probe | | |
|
|
| | +-------------+ | |
|
|
| | | |
|
|
| +-----------------+ |
|
|
+-----------------------+
|
|
```
|
|
|
|
## <a name="using-weave-scope-in-standalone-mode"></a>Using Weave Scope in Standalone Mode
|
|
|
|
When running Scope in a cluster, each probe sends reports to each app.
|
|
The App merges the reports from each probe into a more complete report.
|
|
You need to run Scope on every machine you want to monitor.
|
|
|
|
```
|
|
+--Docker host----------+ +--Docker host----------+
|
|
| +--Container------+ | | +--Container------+ |
|
|
| | | | | | | |
|
|
| | +-----------+ | | | | +-----------+ | |
|
|
| | | scope-app |<-----. .----->| scope-app | | |
|
|
| | +-----------+ | | \ / | | +-----------+ | |
|
|
| | ^ | | \/ | | ^ | |
|
|
| | | | | /\ | | | | |
|
|
| | +-------------+ | | / \ | | +-------------+ | |
|
|
| | | scope-probe |-----' '-----| scope-probe | | |
|
|
| | +-------------+ | | | | +-------------+ | |
|
|
| | | | | | | |
|
|
| +-----------------+ | | +-----------------+ |
|
|
+-----------------------+ +-----------------------+
|
|
```
|
|
|
|
If you run Scope on the same machine as the Weave Network, the probe will use
|
|
weaveDNS to automatically discover other apps on your network. Scope acheives
|
|
this by registering itself under the address **scope.weave.local**. Each probe
|
|
will send reports to every app registered under this address. Therefore, if
|
|
you have a running weaveDNS setup, you do not need to take any further steps.
|
|
|
|
If you do not wish to use weaveDNS, you can instruct Scope to cluster with
|
|
other Scope instances on the command line. Hostnames and IP addresses are
|
|
acceptable, both with and without ports:
|
|
|
|
```
|
|
# scope launch scope1:4030 192.168.0.12 192.168.0.11:4030
|
|
```
|
|
|
|
Hostnames will be regularly resolved as A records, and each answer used as a
|
|
target.
|
|
|
|
## <a name="using-weave-scope-in-cloud-service-mode"></a>Using Weave Scope in Cloud Service Mode
|
|
|
|
Scope can also be used to feed reports to the Scope Service. The Scope Service
|
|
allows you centrally manage and share access to your Scope UI. In this
|
|
configuration, you only run the probe locally; the apps are hosted for you.
|
|
|
|
To get an account on the Scope Service, sign up at [scope.weave.works][]. You
|
|
need to run a probe on every machine you want to monitor with Scope. To launch
|
|
a probe and send reports to the service, run the following command:
|
|
|
|
[scope.weave.works]: http://scope.weave.works
|
|
|
|
```
|
|
sudo scope launch --service-token=<token>
|
|
```
|
|
|
|
```
|
|
.-~~~-.
|
|
.- ~'` )_ ___
|
|
/ `-' )_
|
|
| scope.weave.works \
|
|
\ .'
|
|
~-______________..--'
|
|
^^
|
|
||
|
|
||
|
|
+--Docker host----------+ || +--Docker host----------+
|
|
| +--Container------+ | || | +--Container------+ |
|
|
| | | | || | | | |
|
|
| | +-------------+ | | / \ | | +-------------+ | |
|
|
| | | scope-probe |-----' '-----| scope-probe | | |
|
|
| | +-------------+ | | | | +-------------+ | |
|
|
| | | | | | | |
|
|
| +-----------------+ | | +-----------------+ |
|
|
+-----------------------+ +-----------------------+
|
|
```
|
|
|
|
|
|
## <a name="using-weave-scope-with-kubernetes"></a>Using Weave Scope with Kubernetes
|
|
|
|
To use Scope's Kubernetes integration, you need to start Scope with the
|
|
`--probe.kubernetes true` flag. Scope needs to be installed on all
|
|
nodes (master and minions), but this flag should only be enabled on the
|
|
Kubernetes master node.
|
|
|
|
As per the normal requirements, you will need to run Scope on every
|
|
machine you want to monitor, as shown in [Getting
|
|
Started](#getting-started). However, when launching Scope you
|
|
need to pass different arguments to the Kubernetes master and minion
|
|
nodes.
|
|
|
|
On the master node you need to launch Scope with Kubernetes support:
|
|
|
|
```
|
|
sudo scope launch --probe.kubernetes true
|
|
```
|
|
|
|
Depending on your setup, you may find that Kubernetes has renamed your
|
|
Docker bridge interface. In this instance you'll need to tell Scope
|
|
about the new name when launching it. For example, if your Docker bridge is
|
|
named `cbr0`:
|
|
|
|
```
|
|
sudo DOCKER_BRIDGE=cbr0 scope launch --probe.docker.bridge cbr0 --probe.kubernetes true
|
|
```
|
|
|
|
On each minion node you need to launch Scope telling it
|
|
to connect to the master node.
|
|
|
|
```
|
|
sudo scope launch --no-app kubernetes-master.my.network
|
|
```
|
|
|
|
Again, if your Docker bridge interface is named differently, you'll
|
|
need to pass that to your probe when launching it.
|
|
|
|
Once the first few reports come in, the UI should begin displaying two
|
|
Kubernetes-specific views "Pods", and "Pods by Service".
|
|
|
|
|
|
## <a name="developing"></a>Developing
|
|
|
|
The build is in five stages. `make deps` installs some tools we use later in
|
|
the build. `make frontend` builds a UI build image with all NPM dependencies.
|
|
`make static` compiles the UI into `static.go` which is part of the repository
|
|
for convenience. The final `make` builds the app and probe, in a container,
|
|
and pushes the lot into a Docker image called **weaveworks/scope**.
|
|
|
|
```
|
|
make deps
|
|
make frontend
|
|
make static
|
|
make
|
|
```
|
|
|
|
Then, run the local build via
|
|
|
|
```
|
|
./scope launch
|
|
```
|