Skip to content
This repository has been archived by the owner on Dec 30, 2022. It is now read-only.

Latest commit

 

History

History

dashboard

README.md

Cloud Spanner Ticketshop Demo Dashboard (TSDB)

This is a simple dashboard to display the metrics captured from the Cloud Spanner Ticketshop demo backend. The metrics captured are tickets sold, as well as latency for each ticket purchase transaction. The dashboard displays total tickets sold, tickets sold per minute (rolling window 10 sec window extrapolated to 1 min), p50, p90, and p99 latencies for 10sec window. You can zoom into a region by clicking on it to see metrics for the region only.

Building a statically linked binary containerized running on alpine

Building the statically linked binary is automated using make.

To build and package the binary into a container run make container. To upload the container to Google Container Registry in the currently set gcloud project run make push-gcr.

Run from the source code dir directly

Command is the following (detailed help with go run *.go --help): It's possible to use environment variables, a config -config config.env file or parameters.

go run *.go

Run the container locally

docker run -v $PWD/<SERVICE_ACCOUNT>.json:/key.json -p 8080:8080 --env-file config.env -it <BINARY_NAME>:<VERSION>

Running the Ticketshop Dashboard on GCE

See README.md in the root dir on the prerequisites to run a container on GCE.

Setup config

The TSDB requires a config to connect to InfluxDB which gets injected to the running container via environment variables:

See config-sample.env as an example / template.

Run the container

SSH into your instance and execute:

sudo su -
docker pull gcr.io/<PROJECT_NAME>/<BINARY_NAME>:<VERSION>
docker run -d -p 8080:8080 --env-file config.env gcr.io/<PROJECT_NAME>/<BINARY_NAME>:<VERSION>

To stop your container, find the running container id with docker ps and run docker stop <container-id>

Running the Ticketshop Dashboard (TSDB) in Kubernetes (preferred way)

TODO: add k8s instructions. For now see how the setup.sh uses the Kubernetes templates in the k8sconfigtemplates folder in the repository root.

Credits

The dashboard was designed and built with the help of engine digital inc. (www.enginedigital.com)

Vendor Packaging

We use govendor (go get -u github.com/kardianos/govendor) as the vendor package manager.

third-party packages used in the dashboard web app

  1. GoogleMapsLoader
  2. CountUp
  3. MarkerWithLabel
  4. Reconnecting Websocket

Contributing

See CONTRIBUTING.md

License

Copyright 2018 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This is not an official Google product