-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
diff --git a/gui/web/src/components/screens/NewBot/NewBot.js b/gui/web/src/components/screens/NewBot/NewBot.js
index e3c22e420..ab67eba0a 100644
--- a/gui/web/src/components/screens/NewBot/NewBot.js
+++ b/gui/web/src/components/screens/NewBot/NewBot.js
@@ -195,6 +195,7 @@ class NewBot extends Component {
saveFn={this.saveNew}
saveText="Create Bot"
errorResp={this.state.errorResp}
+ eventPrefix="config-new"
/>);
}
@@ -239,6 +240,7 @@ class NewBot extends Component {
saveText="Save Bot Updates"
errorResp={this.state.errorResp}
readOnly={isDetails}
+ eventPrefix="config-edit"
/>);
}
}
diff --git a/gui/web/src/kelp-ops-api/sendMetricEvent.js b/gui/web/src/kelp-ops-api/sendMetricEvent.js
index eefa30a96..a2afc6a0f 100644
--- a/gui/web/src/kelp-ops-api/sendMetricEvent.js
+++ b/gui/web/src/kelp-ops-api/sendMetricEvent.js
@@ -1,10 +1,10 @@
-export default (baseUrl, name, eventData) => {
+export default (baseUrl, eventType, eventData) => {
return fetch(baseUrl + "/api/v1/sendMetricEvent", {
method: "POST",
- body: {
- event_name: name,
- event_props: eventData,
- },
+ body: JSON.stringify({
+ event_type: eventType,
+ event_data: eventData,
+ }),
}).then(resp => {
return resp.json();
});
diff --git a/plugins/metricsTracker.go b/plugins/metricsTracker.go
index 70dbe2c4e..b9becb166 100644
--- a/plugins/metricsTracker.go
+++ b/plugins/metricsTracker.go
@@ -29,7 +29,7 @@ type MetricsTracker struct {
apiKey string
userID string
deviceID string
- props map[string]interface{}
+ eventProps map[string]interface{}
botStartTime time.Time
isDisabled bool
updateEventSentTime *time.Time
@@ -39,34 +39,64 @@ type MetricsTracker struct {
// TODO DS Investigate other fields to add to this top-level event.
// fields for the event object: https://help.amplitude.com/hc/en-us/articles/360032842391-HTTP-API-V2#http-api-v2-events
type event struct {
- UserID string `json:"user_id"`
- SessionID int64 `json:"session_id"`
- DeviceID string `json:"device_id"`
- EventType string `json:"event_type"`
- Version string `json:"app_version"`
- Props interface{} `json:"event_properties"`
+ UserID string `json:"user_id"`
+ SessionID int64 `json:"session_id"`
+ DeviceID string `json:"device_id"`
+ EventType string `json:"event_type"`
+ Version string `json:"app_version"`
+ EventProperties interface{} `json:"event_properties"`
}
-// props holds the properties that we need for all Amplitude events.
-// This lives on the `MetricsTracker` struct.
+// CommonPropsStruct holds the properties that are common to all our Amplitude events.
// TODO DS Add geodata.
// TODO DS Add cloud server information.
// TODO DS Add time to run update function as `millisForUpdate`.
-type commonProps struct {
- CliVersion string `json:"cli_version"`
- GitHash string `json:"git_hash"`
- Env string `json:"env"`
- Goos string `json:"goos"`
- Goarch string `json:"goarch"`
- Goarm string `json:"goarm"`
- GoVersion string `json:"go_version"`
- GuiVersion string `json:"gui_version"`
+type CommonPropsStruct struct {
+ CliVersion string `json:"cli_version"`
+ GitHash string `json:"git_hash"`
+ Env string `json:"env"`
+ Goos string `json:"goos"`
+ Goarch string `json:"goarch"`
+ Goarm string `json:"goarm"`
+ GoVersion string `json:"go_version"`
+ SecondsSinceStart float64 `json:"seconds_since_start"`
+ IsTestnet bool `json:"is_testnet"`
+ GuiVersion string `json:"gui_version"` // can be present for cli trackers if they are started from the GUI
+}
+
+// MakeCommonProps is a factory mmethod for CommonPropsStruct
+func MakeCommonProps(
+ cliVersion string,
+ gitHash string,
+ env string,
+ goos string,
+ goarch string,
+ goarm string,
+ goVersion string,
+ secondsSinceStart float64,
+ isTestnet bool,
+ guiVersion string,
+) *CommonPropsStruct {
+ return &CommonPropsStruct{
+ CliVersion: cliVersion,
+ GitHash: gitHash,
+ Env: env,
+ Goos: goos,
+ Goarch: goarch,
+ Goarm: goarm,
+ GoVersion: goVersion,
+ SecondsSinceStart: secondsSinceStart,
+ IsTestnet: isTestnet,
+ GuiVersion: guiVersion,
+ }
+}
+
+// CliPropsStruct contains only those props that are needed for all CLI events
+type CliPropsStruct struct {
Strategy string `json:"strategy"`
UpdateTimeIntervalSeconds float64 `json:"update_time_interval_seconds"`
Exchange string `json:"exchange"`
TradingPair string `json:"trading_pair"`
- SecondsSinceStart float64 `json:"seconds_since_start"`
- IsTestnet bool `json:"is_testnet"`
MaxTickDelayMillis int64 `json:"max_tick_delay_millis"`
SubmitMode string `json:"submit_mode"`
DeleteCyclesThreshold int64 `json:"delete_cycles_threshold"`
@@ -86,6 +116,55 @@ type commonProps struct {
FixedIterations uint64 `json:"fixed_iterations"`
}
+// MakeCliProps is a factory mmethod for CommonPropsStruct
+func MakeCliProps(
+ strategy string,
+ updateTimeIntervalSeconds float64,
+ exchange string,
+ tradingPair string,
+ maxTickDelayMillis int64,
+ submitMode string,
+ deleteCyclesThreshold int64,
+ fillTrackerSleepMillis uint32,
+ fillTrackerDeleteCyclesThreshold int64,
+ synchronizeStateLoadEnable bool,
+ synchronizeStateLoadMaxRetries int,
+ enabledFeatureDollarValue bool,
+ alertType string,
+ enabledFeatureMonitoring bool,
+ enabledFeatureFilters bool,
+ enabledFeaturePostgres bool,
+ enabledFeatureLogging bool,
+ operationalBuffer float64,
+ operationalBufferNonNativePct float64,
+ simMode bool,
+ fixedIterations uint64,
+) *CliPropsStruct {
+ return &CliPropsStruct{
+ Strategy: strategy,
+ UpdateTimeIntervalSeconds: updateTimeIntervalSeconds,
+ Exchange: exchange,
+ TradingPair: tradingPair,
+ MaxTickDelayMillis: maxTickDelayMillis,
+ SubmitMode: submitMode,
+ DeleteCyclesThreshold: deleteCyclesThreshold,
+ FillTrackerSleepMillis: fillTrackerSleepMillis,
+ FillTrackerDeleteCyclesThreshold: fillTrackerDeleteCyclesThreshold,
+ SynchronizeStateLoadEnable: synchronizeStateLoadEnable,
+ SynchronizeStateLoadMaxRetries: synchronizeStateLoadMaxRetries,
+ EnabledFeatureDollarValue: enabledFeatureDollarValue,
+ AlertType: alertType,
+ EnabledFeatureMonitoring: enabledFeatureMonitoring,
+ EnabledFeatureFilters: enabledFeatureFilters,
+ EnabledFeaturePostgres: enabledFeaturePostgres,
+ EnabledFeatureLogging: enabledFeatureLogging,
+ OperationalBuffer: operationalBuffer,
+ OperationalBufferNonNativePct: operationalBufferNonNativePct,
+ SimMode: simMode,
+ FixedIterations: fixedIterations,
+ }
+}
+
// updateProps holds the properties for the update Amplitude event.
type updateProps struct {
Success bool `json:"success"`
@@ -139,128 +218,37 @@ func (ar amplitudeResponse) String() string {
)
}
-// MakeMetricsTrackerCli is a factory method to create a `metrics.Tracker` from the CLI.
-func MakeMetricsTrackerCli(
+// MakeMetricsTracker is a factory method
+func MakeMetricsTracker(
+ client *http.Client,
+ apiKey string,
userID string,
deviceID string,
- apiKey string,
- client *http.Client,
botStartTime time.Time,
- version string,
- gitHash string,
- env string,
- goos string,
- goarch string,
- goarm string,
- goVersion string,
- guiVersion string,
- strategy string,
- updateTimeIntervalSeconds float64,
- exchange string,
- tradingPair string,
isDisabled bool,
- isTestnet bool,
- maxTickDelayMillis int64,
- submitMode string,
- deleteCyclesThreshold int64,
- fillTrackerSleepMillis uint32,
- fillTrackerDeleteCyclesThreshold int64,
- synchronizeStateLoadEnable bool,
- synchronizeStateLoadMaxRetries int,
- enabledFeatureDollarValue bool,
- alertType string,
- enabledFeatureMonitoring bool,
- enabledFeatureFilters bool,
- enabledFeaturePostgres bool,
- enabledFeatureLogging bool,
- operationalBuffer float64,
- operationalBufferNonNativePct float64,
- simMode bool,
- fixedIterations uint64,
+ commonProps *CommonPropsStruct,
+ cliProps *CliPropsStruct,
) (*MetricsTracker, error) {
- props := commonProps{
- CliVersion: version,
- GitHash: gitHash,
- Env: env,
- Goos: goos,
- Goarch: goarch,
- Goarm: goarm,
- GoVersion: goVersion,
- GuiVersion: guiVersion,
- Strategy: strategy,
- UpdateTimeIntervalSeconds: updateTimeIntervalSeconds,
- Exchange: exchange,
- TradingPair: tradingPair,
- SecondsSinceStart: 0,
- IsTestnet: isTestnet,
- MaxTickDelayMillis: maxTickDelayMillis,
- SubmitMode: submitMode,
- DeleteCyclesThreshold: deleteCyclesThreshold,
- FillTrackerSleepMillis: fillTrackerSleepMillis,
- FillTrackerDeleteCyclesThreshold: fillTrackerDeleteCyclesThreshold,
- SynchronizeStateLoadEnable: synchronizeStateLoadEnable,
- SynchronizeStateLoadMaxRetries: synchronizeStateLoadMaxRetries,
- EnabledFeatureDollarValue: enabledFeatureDollarValue,
- AlertType: alertType,
- EnabledFeatureMonitoring: enabledFeatureMonitoring,
- EnabledFeatureFilters: enabledFeatureFilters,
- EnabledFeaturePostgres: enabledFeaturePostgres,
- EnabledFeatureLogging: enabledFeatureLogging,
- OperationalBuffer: operationalBuffer,
- OperationalBufferNonNativePct: operationalBufferNonNativePct,
- SimMode: simMode,
- FixedIterations: fixedIterations,
+ if commonProps == nil {
+ return nil, fmt.Errorf("need a non-nil commonProps to make a metrics tracker")
}
- propsMap, e := utils.ToMapStringInterface(props)
+ commonPropsMap, e := utils.ToMapStringInterface(*commonProps)
if e != nil {
- return nil, fmt.Errorf("could not convert props to map: %s", e)
+ return nil, fmt.Errorf("could not convert commonProps to map: %s", e)
}
- return &MetricsTracker{
- client: client,
- apiKey: apiKey,
- userID: userID,
- deviceID: deviceID,
- props: propsMap,
- botStartTime: botStartTime,
- isDisabled: isDisabled,
- updateEventSentTime: nil,
- cliVersion: version,
- }, nil
-}
-
-// MakeMetricsTrackerGui is a factory method to create a `metrics.Tracker` from the CLI.
-func MakeMetricsTrackerGui(
- userID string,
- deviceID string,
- apiKey string,
- client *http.Client,
- botStartTime time.Time,
- version string,
- gitHash string,
- env string,
- goos string,
- goarch string,
- goarm string,
- goVersion string,
- guiVersion string,
- isDisabled bool,
-) (*MetricsTracker, error) {
- props := commonProps{
- CliVersion: version,
- GitHash: gitHash,
- Env: env,
- Goos: goos,
- Goarch: goarch,
- Goarm: goarm,
- GoVersion: goVersion,
- GuiVersion: guiVersion,
+ var cliPropsMap map[string]interface{}
+ if cliProps != nil {
+ cliPropsMap, e = utils.ToMapStringInterface(*cliProps)
+ if e != nil {
+ return nil, fmt.Errorf("could not convert cliProps to map: %s", e)
+ }
}
- propsMap, e := utils.ToMapStringInterface(props)
+ mergedProps, e := utils.MergeMaps(commonPropsMap, cliPropsMap)
if e != nil {
- return nil, fmt.Errorf("could not convert props to map: %s", e)
+ return nil, fmt.Errorf("could not merge commonPropsMap and cliPropsMap: %s", e)
}
return &MetricsTracker{
@@ -268,11 +256,11 @@ func MakeMetricsTrackerGui(
apiKey: apiKey,
userID: userID,
deviceID: deviceID,
- props: propsMap,
+ eventProps: mergedProps,
botStartTime: botStartTime,
isDisabled: isDisabled,
updateEventSentTime: nil,
- cliVersion: version,
+ cliVersion: commonProps.CliVersion,
}, nil
}
@@ -283,7 +271,7 @@ func (mt *MetricsTracker) GetUpdateEventSentTime() *time.Time {
// SendStartupEvent sends the startup Amplitude event.
func (mt *MetricsTracker) SendStartupEvent(now time.Time) error {
- return mt.SendEvent(startupEventName, mt.props, now)
+ return mt.SendEvent(startupEventName, mt.eventProps, now)
}
// SendUpdateEvent sends the update Amplitude event.
@@ -326,20 +314,20 @@ func (mt *MetricsTracker) SendDeleteEvent(exit bool) error {
// SendEvent sends an event with its type and properties to Amplitude.
func (mt *MetricsTracker) SendEvent(eventType string, eventPropsInterface interface{}, now time.Time) error {
- if mt.apiKey == "" || mt.userID == "-1" || mt.isDisabled {
+ if mt == nil || mt.apiKey == "" || mt.userID == "-1" || mt.isDisabled {
log.Printf("metric - not sending event metric of type '%s' because metrics are disabled", eventType)
return nil
}
- trackerProps := mt.props
+ trackerProps := mt.eventProps
trackerProps[secondsSinceStartKey] = now.Sub(mt.botStartTime).Seconds()
- eventProps, e := utils.ToMapStringInterface(eventPropsInterface)
+ inputProps, e := utils.ToMapStringInterface(eventPropsInterface)
if e != nil {
- return fmt.Errorf("could not convert event props to map: %s", e)
+ return fmt.Errorf("could not convert event inputProps to map: %s", e)
}
- mergedProps, e := utils.MergeMaps(trackerProps, eventProps)
+ mergedProps, e := utils.MergeMaps(trackerProps, inputProps)
if e != nil {
return fmt.Errorf("could not merge event properties: %s", e)
}
@@ -349,12 +337,12 @@ func (mt *MetricsTracker) SendEvent(eventType string, eventPropsInterface interf
eventW := eventWrapper{
APIKey: mt.apiKey,
Events: []event{{
- UserID: mt.userID,
- SessionID: mt.botStartTime.Unix() * 1000, // convert to millis based on docs
- DeviceID: mt.deviceID,
- EventType: eventType,
- Props: mergedProps,
- Version: mt.cliVersion,
+ UserID: mt.userID,
+ SessionID: mt.botStartTime.Unix() * 1000, // convert to millis based on docs
+ DeviceID: mt.deviceID,
+ EventType: eventType,
+ EventProperties: mergedProps,
+ Version: mt.cliVersion,
}},
}
requestBody, e := json.Marshal(eventW)
@@ -378,10 +366,9 @@ func (mt *MetricsTracker) SendEvent(eventType string, eventPropsInterface interf
eventWCensored.APIKey = ""
requestWCensored, e := json.Marshal(eventWCensored)
if e != nil {
- log.Printf("metric - failed to send event metric of type '%s' (response=%s), error while trying to marshall requestWCensored: %s", eventType, responseData.String(), e)
- } else {
- log.Printf("metric - failed to send event metric of type '%s' (requestWCensored=%s; response=%s)", eventType, string(requestWCensored), responseData.String())
+ return fmt.Errorf("metric - failed to send event metric of type '%s' (response=%s), error while trying to marshall requestWCensored: %s", eventType, responseData.String(), e)
}
+ return fmt.Errorf("metric - failed to send event metric of type '%s' (requestWCensored=%s; response=%s)", eventType, string(requestWCensored), responseData.String())
}
return nil
}