Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added prometheus metrics to the live running host #396

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

added prometheus metrics to the live running host #396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4cd7713
added prometheus metrics
tehlers320 Jan 12, 2023
f48d396
remove output as it breaks web reporting
tehlers320 Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
116 changes: 67 additions & 49 deletions cmd/ghz/main.go
View file
Open in desktop
Expand Up @@ -4,7 +4,9 @@ import (
"encoding/json"
"errors"
"fmt"
"github.com/prometheus/client_golang/prometheus/promhttp"
"io"
"net/http"
"os"
"runtime"
"strconv"
Expand All @@ -30,81 +32,81 @@ var (
// Proto
isProtoSet = false
proto = kingpin.Flag("proto", `The Protocol Buffer .proto file.`).
PlaceHolder(" ").IsSetByUser(&isProtoSet).String()
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry my IDE did this should i revert all of them?

PlaceHolder(" ").IsSetByUser(&isProtoSet).String()

isProtoSetSet = false
protoset = kingpin.Flag("protoset", "The compiled protoset file. Alternative to proto. -proto takes precedence.").
PlaceHolder(" ").IsSetByUser(&isProtoSetSet).String()
PlaceHolder(" ").IsSetByUser(&isProtoSetSet).String()

isCallSet = false
call = kingpin.Flag("call", `A fully-qualified method name in 'package.Service/method' or 'package.Service.Method' format.`).
PlaceHolder(" ").IsSetByUser(&isCallSet).String()
PlaceHolder(" ").IsSetByUser(&isCallSet).String()

isImportSet = false
paths = kingpin.Flag("import-paths", "Comma separated list of proto import paths. The current working directory and the directory of the protocol buffer file are automatically added to the import list.").
Short('i').PlaceHolder(" ").IsSetByUser(&isImportSet).String()
Short('i').PlaceHolder(" ").IsSetByUser(&isImportSet).String()

// Security
isCACertSet = false
cacert = kingpin.Flag("cacert", "File containing trusted root certificates for verifying the server.").
PlaceHolder(" ").IsSetByUser(&isCACertSet).String()
PlaceHolder(" ").IsSetByUser(&isCACertSet).String()

isCertSet = false
cert = kingpin.Flag("cert", "File containing client certificate (public key), to present to the server. Must also provide -key option.").
PlaceHolder(" ").IsSetByUser(&isCertSet).String()
PlaceHolder(" ").IsSetByUser(&isCertSet).String()

isKeySet = false
key = kingpin.Flag("key", "File containing client private key, to present to the server. Must also provide -cert option.").
PlaceHolder(" ").IsSetByUser(&isKeySet).String()
PlaceHolder(" ").IsSetByUser(&isKeySet).String()

isCNameSet = false
cname = kingpin.Flag("cname", "Server name override when validating TLS certificate - useful for self signed certs.").
PlaceHolder(" ").IsSetByUser(&isCNameSet).String()
PlaceHolder(" ").IsSetByUser(&isCNameSet).String()

isSkipSet = false
skipVerify = kingpin.Flag("skipTLS", "Skip TLS client verification of the server's certificate chain and host name.").
Default("false").IsSetByUser(&isSkipSet).Bool()
Default("false").IsSetByUser(&isSkipSet).Bool()

isInsecSet = false
insecure = kingpin.Flag("insecure", "Use plaintext and insecure connection.").
Default("false").IsSetByUser(&isInsecSet).Bool()
Default("false").IsSetByUser(&isInsecSet).Bool()

isAuthSet = false
authority = kingpin.Flag("authority", "Value to be used as the :authority pseudo-header. Only works if -insecure is used.").
PlaceHolder(" ").IsSetByUser(&isAuthSet).String()
PlaceHolder(" ").IsSetByUser(&isAuthSet).String()

// Run
isAsyncSet = false
async = kingpin.Flag("async", "Make requests asynchronous as soon as possible. Does not wait for request to finish before sending next one.").
Default("false").IsSetByUser(&isAsyncSet).Bool()
Default("false").IsSetByUser(&isAsyncSet).Bool()

isRPSSet = false
rps = kingpin.Flag("rps", "Requests per second (RPS) rate limit for constant load schedule. Default is no rate limit.").
Default("0").Short('r').IsSetByUser(&isRPSSet).Uint()
Default("0").Short('r').IsSetByUser(&isRPSSet).Uint()

isScheduleSet = false
schedule = kingpin.Flag("load-schedule", "Specifies the load schedule. Options are const, step, or line. Default is const.").
Default("const").IsSetByUser(&isScheduleSet).String()
Default("const").IsSetByUser(&isScheduleSet).String()

isLoadStartSet = false
loadStart = kingpin.Flag("load-start", "Specifies the RPS load start value for step or line schedules.").
Default("0").IsSetByUser(&isLoadStartSet).Uint()
Default("0").IsSetByUser(&isLoadStartSet).Uint()

isLoadStepSet = false
loadStep = kingpin.Flag("load-step", "Specifies the load step value or slope value.").
Default("0").IsSetByUser(&isLoadStepSet).Int()
Default("0").IsSetByUser(&isLoadStepSet).Int()

isLoadEndSet = false
loadEnd = kingpin.Flag("load-end", "Specifies the load end value for step or line load schedules.").
Default("0").IsSetByUser(&isLoadEndSet).Uint()
Default("0").IsSetByUser(&isLoadEndSet).Uint()

isLoadStepDurSet = false
loadStepDuration = kingpin.Flag("load-step-duration", "Specifies the load step duration value for step load schedule.").
Default("0").IsSetByUser(&isLoadStepDurSet).Duration()
Default("0").IsSetByUser(&isLoadStepDurSet).Duration()

isLoadMaxDurSet = false
loadMaxDuration = kingpin.Flag("load-max-duration", "Specifies the max load duration value for step or line load schedule.").
Default("0").IsSetByUser(&isLoadMaxDurSet).Duration()
Default("0").IsSetByUser(&isLoadMaxDurSet).Duration()

// Concurrency
isCSet = false
Expand All @@ -113,27 +115,27 @@ var (

isCScheduleSet = false
cschdule = kingpin.Flag("concurrency-schedule", "Concurrency change schedule. Options are const, step, or line. Default is const.").
Default("const").IsSetByUser(&isCScheduleSet).String()
Default("const").IsSetByUser(&isCScheduleSet).String()

isCStartSet = false
cStart = kingpin.Flag("concurrency-start", "Concurrency start value for step and line concurrency schedules.").
Default("0").IsSetByUser(&isCStartSet).Uint()
Default("0").IsSetByUser(&isCStartSet).Uint()

isCEndSet = false
cEnd = kingpin.Flag("concurrency-end", "Concurrency end value for step and line concurrency schedules.").
Default("0").IsSetByUser(&isCEndSet).Uint()
Default("0").IsSetByUser(&isCEndSet).Uint()

isCStepSet = false
cstep = kingpin.Flag("concurrency-step", "Concurrency step / slope value for step and line concurrency schedules.").
Default("1").IsSetByUser(&isCStepSet).Int()
Default("1").IsSetByUser(&isCStepSet).Int()

isCStepDurSet = false
cStepDuration = kingpin.Flag("concurrency-step-duration", "Specifies the concurrency step duration value for step concurrency schedule.").
Default("0").IsSetByUser(&isCStepDurSet).Duration()
Default("0").IsSetByUser(&isCStepDurSet).Duration()

isCMaxDurSet = false
cMaxDuration = kingpin.Flag("concurrency-max-duration", "Specifies the max concurrency adjustment duration value for step or line concurrency schedule.").
Default("0").IsSetByUser(&isCMaxDurSet).Duration()
Default("0").IsSetByUser(&isCMaxDurSet).Duration()

// Other
isNSet = false
Expand All @@ -154,32 +156,32 @@ var (

isZStopSet = false
zstop = kingpin.Flag("duration-stop", "Specifies how duration stop is reported. Options are close, wait or ignore. Default is close.").
Default("close").IsSetByUser(&isZStopSet).String()
Default("close").IsSetByUser(&isZStopSet).String()

// Data
isDataSet = false
data = kingpin.Flag("data", "The call data as stringified JSON. If the value is '@' then the request contents are read from stdin.").
Short('d').PlaceHolder(" ").IsSetByUser(&isDataSet).String()
Short('d').PlaceHolder(" ").IsSetByUser(&isDataSet).String()

isDataPathSet = false
dataPath = kingpin.Flag("data-file", "File path for call data JSON file. Examples: /home/user/file.json or ./file.json.").
Short('D').PlaceHolder("PATH").PlaceHolder(" ").IsSetByUser(&isDataPathSet).String()
Short('D').PlaceHolder("PATH").PlaceHolder(" ").IsSetByUser(&isDataPathSet).String()

isBinDataSet = false
binData = kingpin.Flag("binary", "The call data comes as serialized binary message or multiple count-prefixed messages read from stdin.").
Short('b').Default("false").IsSetByUser(&isBinDataSet).Bool()
Short('b').Default("false").IsSetByUser(&isBinDataSet).Bool()

isBinDataPathSet = false
binPath = kingpin.Flag("binary-file", "File path for the call data as serialized binary message or multiple count-prefixed messages.").
Short('B').PlaceHolder(" ").IsSetByUser(&isBinDataPathSet).String()
Short('B').PlaceHolder(" ").IsSetByUser(&isBinDataPathSet).String()

isMDSet = false
md = kingpin.Flag("metadata", "Request metadata as stringified JSON.").
Short('m').PlaceHolder(" ").IsSetByUser(&isMDSet).String()

isMDPathSet = false
mdPath = kingpin.Flag("metadata-file", "File path for call metadata JSON file. Examples: /home/user/metadata.json or ./metadata.json.").
Short('M').PlaceHolder(" ").IsSetByUser(&isMDPathSet).String()
Short('M').PlaceHolder(" ").IsSetByUser(&isMDPathSet).String()

isSISet = false
si = kingpin.Flag("stream-interval", "Interval for stream requests between message sends.").
Expand All @@ -191,37 +193,41 @@ var (

isSCCSet = false
scc = kingpin.Flag("stream-call-count", "Count of messages sent, after which client will close the stream in each streaming call.").
Default("0").IsSetByUser(&isSCCSet).Uint()
Default("0").IsSetByUser(&isSCCSet).Uint()

isSDMSet = false
sdm = kingpin.Flag("stream-dynamic-messages", "In streaming calls, regenerate and apply call template data on every message send.").
Default("false").IsSetByUser(&isSDMSet).Bool()
Default("false").IsSetByUser(&isSDMSet).Bool()

isRMDSet = false
rmd = kingpin.Flag("reflect-metadata", "Reflect metadata as stringified JSON used only for reflection request.").
PlaceHolder(" ").IsSetByUser(&isRMDSet).String()
PlaceHolder(" ").IsSetByUser(&isRMDSet).String()

// Output
isOutputSet = false
output = kingpin.Flag("output", "Output path. If none provided stdout is used.").
Short('o').PlaceHolder(" ").IsSetByUser(&isOutputSet).String()
Short('o').PlaceHolder(" ").IsSetByUser(&isOutputSet).String()

isFormatSet = false
format = kingpin.Flag("format", "Output format. One of: summary, csv, json, pretty, html, influx-summary, influx-details. Default is summary.").
Short('O').Default("summary").PlaceHolder(" ").IsSetByUser(&isFormatSet).Enum("summary", "csv", "json", "pretty", "html", "influx-summary", "influx-details", "prometheus")
Short('O').Default("summary").PlaceHolder(" ").IsSetByUser(&isFormatSet).Enum("summary", "csv", "json", "pretty", "html", "influx-summary", "influx-details", "prometheus")

isPrometheusSet = false
prometheus = kingpin.Flag("prometheus", "Enable prometheus listener").
Default("false").IsSetByUser(&isPrometheusSet).Bool()

isSkipFirstSet = false
skipFirst = kingpin.Flag("skipFirst", "Skip the first X requests when doing the results tally.").
Default("0").IsSetByUser(&isSkipFirstSet).Uint()
Default("0").IsSetByUser(&isSkipFirstSet).Uint()

isCESet = false
countErrors = kingpin.Flag("count-errors", "Count erroneous (non-OK) resoponses in stats calculations.").
Default("false").IsSetByUser(&isCESet).Bool()
Default("false").IsSetByUser(&isCESet).Bool()

// Connection
isConnSet = false
conns = kingpin.Flag("connections", "Number of connections to use. Concurrency is distributed evenly among all the connections. Default is 1.").
Default("1").IsSetByUser(&isConnSet).Uint()
Default("1").IsSetByUser(&isConnSet).Uint()

isCTSet = false
ct = kingpin.Flag("connect-timeout", "Connection timeout for the initial connection dial. Default is 10s.").
Expand All @@ -234,45 +240,45 @@ var (
// Meta
isNameSet = false
name = kingpin.Flag("name", "User specified name for the test.").
PlaceHolder(" ").IsSetByUser(&isNameSet).String()
PlaceHolder(" ").IsSetByUser(&isNameSet).String()

isTagsSet = false
tags = kingpin.Flag("tags", "JSON representation of user-defined string tags.").
PlaceHolder(" ").IsSetByUser(&isTagsSet).String()
PlaceHolder(" ").IsSetByUser(&isTagsSet).String()

isCPUSet = false
cpus = kingpin.Flag("cpus", "Number of cpu cores to use.").
Default(strconv.FormatUint(uint64(nCPUs), 10)).IsSetByUser(&isCPUSet).Uint()
Default(strconv.FormatUint(uint64(nCPUs), 10)).IsSetByUser(&isCPUSet).Uint()

// Debug
isDebugSet = false
debug = kingpin.Flag("debug", "The path to debug log file.").
PlaceHolder(" ").IsSetByUser(&isDebugSet).String()
PlaceHolder(" ").IsSetByUser(&isDebugSet).String()

isEnableCompressionSet = false
enableCompression = kingpin.Flag("enable-compression", "Enable Gzip compression on requests.").
Short('e').Default("false").IsSetByUser(&isEnableCompressionSet).Bool()
Short('e').Default("false").IsSetByUser(&isEnableCompressionSet).Bool()

isLBStrategySet = false
lbStrategy = kingpin.Flag("lb-strategy", "Client load balancing strategy.").
PlaceHolder(" ").IsSetByUser(&isLBStrategySet).String()
PlaceHolder(" ").IsSetByUser(&isLBStrategySet).String()

// message size
isMaxRecvMsgSizeSet = false
maxRecvMsgSize = kingpin.Flag("max-recv-message-size", "Maximum message size the client can receive.").
PlaceHolder(" ").IsSetByUser(&isMaxRecvMsgSizeSet).String()
PlaceHolder(" ").IsSetByUser(&isMaxRecvMsgSizeSet).String()

isMaxSendMsgSizeSet = false
maxSendMsgSize = kingpin.Flag("max-send-message-size", "Maximum message size the client can send.").
PlaceHolder(" ").IsSetByUser(&isMaxSendMsgSizeSet).String()
PlaceHolder(" ").IsSetByUser(&isMaxSendMsgSizeSet).String()

isDisableTemplateFuncsSet = false
disableTemplateFuncs = kingpin.Flag("disable-template-functions", "Do not use and execute any template functions in call template data. Useful for better performance").
Default("false").IsSetByUser(&isDisableTemplateFuncsSet).Bool()
Default("false").IsSetByUser(&isDisableTemplateFuncsSet).Bool()

isDisableTemplateDataSet = false
disableTemplateData = kingpin.Flag("disable-template-data", "Do not use and execute any call template data. Useful for better performance.").
Default("false").IsSetByUser(&isDisableTemplateDataSet).Bool()
Default("false").IsSetByUser(&isDisableTemplateDataSet).Bool()

// host main argument
isHostSet = false
Expand Down Expand Up @@ -310,6 +316,13 @@ func main() {
kingpin.FatalIfError(err, "")
}

if cfg.Prometheus {
http.Handle("/metrics", promhttp.Handler())
go func() {
http.ListenAndServe(":9090", nil)
}()
}

var logger *zap.SugaredLogger

options := []runner.Option{runner.WithConfig(&cfg)}
Expand Down Expand Up @@ -488,6 +501,7 @@ func createConfigFromArgs(cfg *runner.Config) error {
cfg.StreamDynamicMessages = *sdm
cfg.Output = *output
cfg.Format = *format
cfg.Prometheus = *prometheus
cfg.ImportPaths = iPaths
cfg.Connections = *conns
cfg.DialTimeout = runner.Duration(*ct)
Expand Down Expand Up @@ -652,6 +666,10 @@ func mergeConfig(dest *runner.Config, src *runner.Config) error {
dest.Format = src.Format
}

if isPrometheusSet {
dest.Prometheus = src.Prometheus
}

if isImportSet {
dest.ImportPaths = src.ImportPaths
}
Expand Down
3 changes: 2 additions & 1 deletion go.mod
View file
Open in desktop
Expand Up @@ -13,13 +13,15 @@ require (
github.com/golang/protobuf v1.5.2
github.com/golangci/golangci-lint v1.46.2
github.com/google/uuid v1.3.0
github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0
github.com/jhump/protoreflect v1.9.0
github.com/jinzhu/configor v1.1.1
github.com/jinzhu/gorm v1.9.11
github.com/labstack/echo v3.3.10+incompatible
github.com/labstack/gommon v0.3.0
github.com/mfridman/tparse v0.10.3
github.com/pkg/errors v0.9.1
github.com/prometheus/client_golang v1.12.1
github.com/prometheus/client_model v0.2.0
github.com/prometheus/common v0.32.1
github.com/rakyll/statik v0.1.6
Expand Down Expand Up @@ -157,7 +159,6 @@ require (
github.com/phayes/checkstyle v0.0.0-20170904204023-bfd46e6a821d // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/polyfloyd/go-errorlint v1.0.0 // indirect
github.com/prometheus/client_golang v1.12.1 // indirect
github.com/prometheus/procfs v0.7.3 // indirect
github.com/quasilyte/go-ruleguard v0.3.16-0.20220213074421-6aa060fab41a // indirect
github.com/quasilyte/gogrep v0.0.0-20220120141003-628d8b3623b5 // indirect
Expand Down
1 change: 1 addition & 0 deletions go.sum
View file
Open in desktop
Expand Up @@ -432,6 +432,7 @@ github.com/gostaticanalysis/testutil v0.4.0 h1:nhdCmubdmDF6VEatUNjgUZBJKWRqugoIS
github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA=
github.com/grpc-ecosystem/go-grpc-middleware v1.0.1-0.20190118093823-f849b5445de4/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs=
github.com/grpc-ecosystem/go-grpc-middleware v1.2.2/go.mod h1:EaizFBKfUKtMIF5iaDEhniwNedqGo9FuLFzppDr3uwI=
github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 h1:Ovs26xHkKqVztRpIrF/92BcuyuQ/YW4NSIpoGtfXNho=
github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk=
github.com/grpc-ecosystem/grpc-gateway v1.9.5/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY=
github.com/grpc-ecosystem/grpc-gateway v1.12.1/go.mod h1:8XEsbTttt/W+VvjtQhLACqCisSPWTxCZ7sBRjU6iH9c=
Expand Down
1 change: 1 addition & 0 deletions runner/config.go
View file
Open in desktop
Expand Up @@ -97,6 +97,7 @@ type Config struct {
StreamDynamicMessages bool `json:"stream-dynamic-messages" toml:"stream-dynamic-messages" yaml:"stream-dynamic-messages"`
Output string `json:"output" toml:"output" yaml:"output"`
Format string `json:"format" toml:"format" yaml:"format" default:"summary"`
Prometheus bool `json:"prometheus" toml:"prometheus" yaml:"prometheus"`
DialTimeout Duration `json:"connect-timeout" toml:"connect-timeout" yaml:"connect-timeout" default:"10s"`
KeepaliveTime Duration `json:"keepalive" toml:"keepalive" yaml:"keepalive"`
CPUs uint `json:"cpus" toml:"cpus" yaml:"cpus"`
Expand Down