set GOPROCMAX and include gops in docker image (#63)

* set GOPROCMAX and include gops in docker image

* remove secret detection

* tweak cache ttl testcase because GH action runs on weird timer

* tweak cache ttl test case, what's wrong with GH actions today

Author: zzzming

.github/workflows/go.yml

@@ -37,11 +37,6 @@ jobs:
         with:
           python-version: '3.x' # Version range or exact version of a Python version to use, using SemVer's version range syntax
           architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
-      - name: Detect Secrets
-        run: |
-          python -m pip install --upgrade pip
-          pip install detect-secrets
-          detect-secrets scan | python3 ./scripts/secret-post-process.py
   build_test:
     name: build and test
     runs-on: ubuntu-latest

Dockerfile

@@ -4,9 +4,13 @@
 FROM golang:alpine AS builder
 
 # Add Maintainer Info
-LABEL maintainer="kafkaesque.io"
+LABEL maintainer="kesque"
 
 RUN apk --no-cache add build-base git
+
+# Build Delve
+RUN go get github.com/google/gops
+
 WORKDIR /root/
 ADD . /root
 RUN cd /root/src && go build -o pulsar-beam
@@ -23,5 +27,8 @@ COPY --from=builder /root/src/pulsar-beam /root/bin
 COPY --from=builder /root/config/pulsar_beam_inmemory_db.yml /root/config/pulsar_beam.yml
 COPY --from=builder /root/src/unit-test/example_p* /root/config/
 
+# Copy debug tools
+COPY --from=builder /go/bin/gops /root/bin
+
 # Command to run the executable
 ENTRYPOINT ["./pulsar-beam"]

README.md

@@ -107,6 +107,8 @@ This is an example of a default configurations using in-memory database. Customi
 $ sudo docker run -d -it -v /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem:/etc/ssl/certs/ca-bundle.crt -p 8085:8085 --name=pbeam-server pulsar-beam
 ```
 
+`gops` is built in the docker image for troubleshooting purpose.
+
 ### Pulsar Kubernetes cluster deployment
 
 Pulsar Beam can be deployed within the same cluster as Pulsar. This [helm chart](https://github.com/kafkaesque-io/pulsar-helm-chart/blob/master/helm-chart-sources/pulsar/templates/beamwh-deployment.yaml) deploys a webhook broker in its own pod. The rest of HTTP receiver endpoint and REST API are deployed as a container within the [Pulsar proxy pod](https://github.com/kafkaesque-io/pulsar-helm-chart), that offers scalability with multiple replicas.

go.mod

@@ -8,16 +8,19 @@ require (
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
 	github.com/ghodss/yaml v1.0.0
 	github.com/golang/snappy v0.0.1 // indirect
+	github.com/google/gops v0.3.10
 	github.com/gorilla/mux v1.7.3
 	github.com/hashicorp/go-retryablehttp v0.6.4
 	github.com/prometheus/client_golang v1.4.1
 	github.com/rs/cors v1.7.0
+	github.com/shirou/gopsutil v2.20.5+incompatible // indirect
 	github.com/sirupsen/logrus v1.5.0
 	github.com/tidwall/pretty v1.0.1 // indirect
 	github.com/xdg/scram v0.0.0-20180814205039-7eeb5667e42c // indirect
 	github.com/xdg/stringprep v1.0.0 // indirect
 	go.mongodb.org/mongo-driver v1.2.0
 	golang.org/x/crypto v0.0.0-20191206172530-e9b2fee46413 // indirect
+	golang.org/x/sys v0.0.0-20200622214017-ed371f2e16b4 // indirect
 )
 
 // temporary pulsar client until https://github.com/apache/pulsar-client-go/pull/238 can be merged

go.sum

@@ -3,7 +3,9 @@ package main
 import (
 	"flag"
 	"os"
+	"runtime"
 
+	"github.com/google/gops/agent"
 	"github.com/kafkaesque-io/pulsar-beam/src/broker"
 	"github.com/kafkaesque-io/pulsar-beam/src/route"
 	"github.com/kafkaesque-io/pulsar-beam/src/util"
@@ -16,6 +18,15 @@ import (
 var mode = util.AssignString(os.Getenv("ProcessMode"), *flag.String("mode", "hybrid", "server running mode"))
 
 func main() {
+	// runtime.GOMAXPROCS does not the container's CPU quota in Kubernetes
+	// therefore, it requires to be set explicitly
+	runtime.GOMAXPROCS(util.GetEnvInt("GOMAXPROCS", 1))
+
+	// gops debug instrument
+	if err := agent.Listen(agent.Options{}); err != nil {
+		log.Panicf("gops instrument error %v", err)
+	}
+
 	exit := make(chan bool) // future use to exit the main program if in broker only mode
 	util.Init()