From c16f0a3a50668320059e466a8efe9f189aa6c363 Mon Sep 17 00:00:00 2001 From: c9s Date: Tue, 28 Dec 2021 01:22:24 +0800 Subject: [PATCH 1/2] doc: update helm chart doc --- doc/deployment/helm-chart.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/deployment/helm-chart.md b/doc/deployment/helm-chart.md index f8f855e49..d9e183722 100644 --- a/doc/deployment/helm-chart.md +++ b/doc/deployment/helm-chart.md @@ -74,6 +74,12 @@ To use the latest version: helm install --set existingConfigmap=bbgo-$INSTANCE --set image.tag=latest bbgo-$INSTANCE ./charts/bbgo ``` +Or, if you have custom values.yaml to override the default values: + +```sh +helm install --values deploy/my-bbgo-values.yaml bbgo-$INSTANCE ./charts/bbgo +``` + To upgrade: ```sh From a0e41650be5a89eb25694ead978cddcc1764c24c Mon Sep 17 00:00:00 2001 From: c9s Date: Tue, 28 Dec 2021 01:39:17 +0800 Subject: [PATCH 2/2] add metricsLastUpdateTimeBalance metrics --- pkg/bbgo/metrics.go | 16 +++++++++++ pkg/bbgo/session.go | 68 +++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 78 insertions(+), 6 deletions(-) diff --git a/pkg/bbgo/metrics.go b/pkg/bbgo/metrics.go index f543e6eb1..338c0f639 100644 --- a/pkg/bbgo/metrics.go +++ b/pkg/bbgo/metrics.go @@ -82,6 +82,21 @@ var ( "liquidity", // maker or taker }, ) + + metricsLastUpdateTimeBalance = prometheus.NewGaugeVec( + prometheus.GaugeOpts{ + Name: "bbgo_last_update_time", + Help: "bbgo last update time of different channel", + }, + []string{ + "exchange", // exchange name + "margin", // margin of connection. none, margin or isolated + "channel", // channel: user, market + "data_type", // type: balance, ticker, kline, orderbook, trade, order + "symbol", // for market data, trade and order + "currency", // for balance + }, + ) ) func init() { @@ -92,5 +107,6 @@ func init() { metricsAvailableBalances, metricsTradesTotal, metricsTradingVolume, + metricsLastUpdateTimeBalance, ) } diff --git a/pkg/bbgo/session.go b/pkg/bbgo/session.go index 90c10bc55..d52449897 100644 --- a/pkg/bbgo/session.go +++ b/pkg/bbgo/session.go @@ -8,6 +8,7 @@ import ( "github.com/prometheus/client_golang/prometheus" log "github.com/sirupsen/logrus" + "github.com/spf13/viper" "github.com/c9s/bbgo/pkg/cmd/cmdutil" "github.com/c9s/bbgo/pkg/fixedpoint" @@ -323,8 +324,11 @@ func (session *ExchangeSession) Init(ctx context.Context, environ *Environment) session.UserDataStream.OnOrderUpdate(session.OrderExecutor.EmitOrderUpdate) session.Account.BindStream(session.UserDataStream) - session.metricsBalancesUpdater(balances) - session.bindUserDataStreamMetrics(session.UserDataStream) + // if metrics mode is enabled, we bind the callbacks to update metrics + if viper.GetBool("metrics") { + session.metricsBalancesUpdater(balances) + session.bindUserDataStreamMetrics(session.UserDataStream) + } } // TODO: move this logic to Environment struct @@ -799,7 +803,27 @@ func (session *ExchangeSession) metricsBalancesUpdater(balances types.BalanceMap metricsTotalBalances.With(labels).Set(balance.Total().Float64()) metricsLockedBalances.With(labels).Set(balance.Locked.Float64()) metricsAvailableBalances.With(labels).Set(balance.Available.Float64()) + metricsLastUpdateTimeBalance.With(prometheus.Labels{ + "exchange": session.ExchangeName.String(), + "margin": session.MarginType(), + "channel": "user", + "data_type": "balance", + "symbol": "", + "currency": currency, + }).SetToCurrentTime() } + +} + +func (session *ExchangeSession) metricsOrderUpdater(order types.Order) { + metricsLastUpdateTimeBalance.With(prometheus.Labels{ + "exchange": session.ExchangeName.String(), + "margin": session.MarginType(), + "channel": "user", + "data_type": "order", + "symbol": order.Symbol, + "currency": "", + }).SetToCurrentTime() } func (session *ExchangeSession) metricsTradeUpdater(trade types.Trade) { @@ -812,23 +836,55 @@ func (session *ExchangeSession) metricsTradeUpdater(trade types.Trade) { } metricsTradingVolume.With(labels).Add(trade.Quantity * trade.Price) metricsTradesTotal.With(labels).Inc() + metricsLastUpdateTimeBalance.With(prometheus.Labels{ + "exchange": session.ExchangeName.String(), + "margin": session.MarginType(), + "channel": "user", + "data_type": "trade", + "symbol": trade.Symbol, + "currency": "", + }).SetToCurrentTime() +} + +func (session *ExchangeSession) bindMarketDataStreamMetrics(stream types.Stream) { + stream.OnBookUpdate(func(book types.SliceOrderBook) { + metricsLastUpdateTimeBalance.With(prometheus.Labels{ + "exchange": session.ExchangeName.String(), + "margin": session.MarginType(), + "channel": "market", + "data_type": "book", + "symbol": book.Symbol, + "currency": "", + }).SetToCurrentTime() + }) + stream.OnKLineClosed(func(kline types.KLine) { + metricsLastUpdateTimeBalance.With(prometheus.Labels{ + "exchange": session.ExchangeName.String(), + "margin": session.MarginType(), + "channel": "market", + "data_type": "kline", + "symbol": kline.Symbol, + "currency": "", + }).SetToCurrentTime() + }) } func (session *ExchangeSession) bindUserDataStreamMetrics(stream types.Stream) { stream.OnBalanceUpdate(session.metricsBalancesUpdater) stream.OnBalanceSnapshot(session.metricsBalancesUpdater) stream.OnTradeUpdate(session.metricsTradeUpdater) + stream.OnOrderUpdate(session.metricsOrderUpdater) stream.OnDisconnect(func() { metricsConnectionStatus.With(prometheus.Labels{ - "exchange": session.ExchangeName.String(), - "margin": session.MarginType(), + "exchange": session.ExchangeName.String(), + "margin": session.MarginType(), "symbol": session.IsolatedMarginSymbol, }).Set(0.0) }) stream.OnConnect(func() { metricsConnectionStatus.With(prometheus.Labels{ - "exchange": session.ExchangeName.String(), - "margin": session.MarginType(), + "exchange": session.ExchangeName.String(), + "margin": session.MarginType(), "symbol": session.IsolatedMarginSymbol, }).Set(1.0) })