feat: Main Metrics Readme

cmd/config/main.go

@@ -114,7 +114,7 @@ var (
 		// ----------------------Metrics Config-----------------------	//
 		// -----------------------------------------------------------	//
 		Metrics:        config.MetricsConfig{},
-		UpdateInterval: 1500 * time.Millisecond,
+		UpdateInterval: 500 * time.Millisecond,
 		MaxPriceAge:    2 * time.Minute,
 		Providers: []config.ProviderConfig{
 			// -----------------------------------------------------------	//
@@ -284,7 +284,7 @@ func init() {
 		&updateInterval,
 		"update-interval",
 		"",
-		1500*time.Millisecond,
+		500*time.Millisecond,
 		"interval at which the oracle will update the prices. this should be set to the interval desired by the chain.",
 	)
 	rootCmd.Flags().DurationVarP(

cmd/oracle/main.go

@@ -128,6 +128,12 @@ func runOracle() error {
 		}
 	}
 
+	logger.Info(
+		"successfully read in configs",
+		zap.String("oracle_config_path", oracleCfgPath),
+		zap.String("market_config_path", marketCfgPath),
+	)
+
 	metrics := oraclemetrics.NewMetricsFromConfig(cfg.Metrics)
 
 	// Define the orchestrator and oracle options. These determine how the orchestrator and oracle are created & executed.
@@ -152,6 +158,8 @@ func runOracle() error {
 
 		orchestratorOpts = append(orchestratorOpts, customOrchestratorOps...)
 		oracleOpts = append(oracleOpts, customOracleOpts...)
+	} else {
+		logger.Warn("no custom orchestrator or oracle options for chain; running default version")
 	}
 
 	// Create the orchestrator and start the orchestrator.
@@ -227,6 +235,7 @@ func dydxOptions(
 	metrics oraclemetrics.Metrics,
 ) ([]orchestrator.Option, []oracle.Option, error) {
 	// dYdX uses the median index price aggregation strategy.
+	logger.Info("running dYdX sidecar; adding custom options for orchestrator and oracle")
 	aggregator, err := oraclemath.NewMedianAggregator(
 		logger,
 		marketCfg,

config/dydx/oracle.json

@@ -1,5 +1,5 @@
 {
-  "updateInterval": 1500000000,
+  "updateInterval": 500000000,
   "maxPriceAge": 120000000000,
   "providers": [
     {
@@ -401,7 +401,7 @@
         "reconnectTimeout": 2000000000,
         "maxQueries": 1,
         "atomic": true,
-        "url": "localhost:1317",
+        "url": "https://dydx-api.polkachu.com",
         "name": "dydx_api"
       },
       "webSocket": {

docker-compose.yml

@@ -10,14 +10,15 @@ services:
       context: .
       dockerfile: contrib/images/slinky.sidecar.e2e.Dockerfile
     volumes:
-      - ./config/local/oracle.json:/oracle/oracle.json
-      - ./config/local/market.json:/oracle/market.json
+      - ./config/dydx/oracle.json:/oracle/oracle.json
+      - ./config/dydx/market.json:/oracle/market.json
     entrypoint: [
       "oracle", 
       "--oracle-config-path", "/etc/slinky/default_config/oracle.json", 
       "--market-config-path", "/etc/slinky/default_config/market.json", 
+      "--chain-id", "dydx-mainnet-1",
       "--pprof-port", "6060", 
-      "--run-pprof", "true",
+      "--run-pprof",
       ]
     ports:
       - "8080:8080" # main oracle port