Bunnynet Magic Containers as a supported runtime (#10)

- Adds automatic detection of [BunnyNet's Magic
Containers](https://docs.bunny.net/docs/magic-containers-overview) as a
cloud runtime.
- Adds `HACHYBOOP_TEST_FREQUENCY_SECONDS` (integer) to control how often
tests run in seconds.

Author: Preskton

.envrc.example

@@ -8,9 +8,15 @@
 export HACHYBOOP_OBSERVER_ID=esk
 export HACHYBOOP_OBSERVER_REGION=exandria
 
-## DNS Configuration
+## Testing parameters
 
-### Resolvers and questions - what DNS entries are you poking, and who are you asking?
+### Frequency
+
+export HACHYBOOP_TEST_FREQUENCY_SECONDS=300
+
+### DNS Configuration
+
+#### Resolvers and questions - what DNS entries are you poking, and who are you asking?
 export HACHYBOOP_RESOLVERS=91.200.176.1:53,8.8.8.8:53
 export HACHYBOOP_QUESTIONS=hachyderm.io,hachyderm.wtf
 

Dockerfile

@@ -22,4 +22,20 @@ FROM alpine
 
 COPY --from=build /out/hachyboop /bin
 
+# Envvars
+
+ENV HACHYBOOP_OBSERVER_ID=anonymous-hachyfriend
+ENV HACHYBOOP_OBSERVER_REGION=analog-nowhere
+ENV HACHYBOOP_RESOLVERS=91.200.176.1:53,8.8.8.8:53
+ENV HACHYBOOP_QUESTIONS=hachyderm.io
+ENV HACHYBOOP_S3_WRITER_ENABLED=false
+ENV HACHYBOOP_S3_ENDPOINT=replace-me.local
+ENV HACHYBOOP_S3_BUCKET=replace-me
+ENV HACHYBOOP_S3_PATH=replace-me/with-something
+ENV HACHYBOOP_S3_ACCESS_KEY_ID=replace-me
+ENV HACHYBOOP_S3_SECRET_ACCESS_KEY=replace-me
+ENV HACHYBOOP_LOCAL_WRITER_ENABLED=true
+ENV HACHYBOOP_LOCAL_RESULTS_PATH=data
+ENV HACHYBOOP_TEST_FREQUENCY_SECONDS=300
+
 ENTRYPOINT [ "/bin/hachyboop" ]

Makefile

@@ -40,6 +40,10 @@ compile: ## Compile for the local architecture ⚙
 	-X 'github.com/$(org)/$(target).Name=$(target)'" \
 	-o $(target) cmd/*.go
 
+.PHONY: run
+run: compile
+	./hachyboop
+
 .PHONY: container
 container:
 	docker build . -t $(target):latest
@@ -57,6 +61,11 @@ runcontainer: container
 		-e HACHYBOOP_RESOLVERS \
 		-e HACHYBOOP_QUESTIONS \
 		-e HACHYBOOP_LOCAL_RESULTS_PATH \
+		-e BUNNYNET_MC_REGION \
+		-e BUNNYNET_MC_ZONE \
+		-e BUNNYNET_MC_APPID \
+		-e BUNNYNET_MC_PODID \
+		-e HACHYBOOP_TEST_FREQUENCY_SECONDS \
 		--mount type=bind,src=data/,dst=/data \
 	 	$(target):latest
 

README.md

@@ -56,9 +56,15 @@ Hachyboop provides several environment variables to configure how it behaves. If
 export HACHYBOOP_OBSERVER_ID=esk  # unique (or not) identifier for you. recommendation is you provide a pseudonym or generated unique ID.
 export HACHYBOOP_OBSERVER_REGION=exandria  # see below, region code that most closely matches where you are
 
-## DNS Configuration
+## Testing parameters
 
-### Resolvers and questions - what DNS entries are you poking, and who are you asking?
+### Frequency
+
+export HACHYBOOP_TEST_FREQUENCY_SECONDS=300 # how often should we run our rtest?
+
+### DNS Configuration
+
+#### Resolvers and questions - what DNS entries are you poking, and who are you asking?
 export HACHYBOOP_RESOLVERS=91.200.176.1:53,8.8.8.8:53  # comma-separated, requires port number, e.g. 8.8.8.8:53
 export HACHYBOOP_QUESTIONS=hachyderm.io  # which records do you want to test
 
@@ -110,6 +116,14 @@ When choosing a value, choose the value that most closely matches how you would
   - australia-east
   - australia-west
 
+### Runtime cloud detection
+
+Hachyboop can detect some clouds based on metadata available to it. It will detect:
+
+- **Bunny.net Magic Containers** - if `BUNNYNET_MC_PODIP` is present in the environment it will set (and override):
+  - `HACHYBOOP_OBSERVER_ID` = `BUNNYNET_MC_APPID` / `BUNNYNET_MC_PODIP`
+  - `HACHYBOOP_OBSERVER_REGION` = `BUNNYNET_MC_REGION` / `BUNNYNET_MC_ZONE`
+
 ## Example of collected data
 
 > [!IMPORTANT]  
@@ -120,4 +134,3 @@ Here's a screenshot of the data we collect with `hachyboop`. The `observedby` an
 ![image](https://github.com/user-attachments/assets/3e1a8ddf-7777-4336-8139-b233e53839c6)
 
 
-

cmd/main.go

@@ -18,7 +18,9 @@ package main
 
 import (
 	"context"
+	"fmt"
 	"os"
+	"strconv"
 	"strings"
 
 	hb "github.com/hachyderm/hachyboop"
@@ -37,8 +39,9 @@ var banner = `
 `
 
 var cfg = &service.HachyboopOptions{
-	S3Output:   &service.S3Options{},
-	FileOutput: &service.FileOptions{},
+	S3Output:                     &service.S3Options{},
+	FileOutput:                   &service.FileOptions{},
+	RuntimeCloudProviderMetadata: &service.RuntimeCloudProviderMetadata{},
 }
 
 func main() {
@@ -75,6 +78,23 @@ A longer sentence, about how exactly to use this program`,
 			cfg.Resolvers = strings.Split(cfg.ResolversRaw, ",")
 			cfg.ObservationHandler = make(chan *service.HachyboopDnsObservation, 32)
 
+			testSec, err := strconv.Atoi(cfg.TestFrequencySecondsRaw)
+			if err != nil {
+				logrus.WithField("rawValue", cfg.TestFrequencySecondsRaw).Warn("couldn't convert HACHYBOOP_TEST_FREQUENCY_SECONDS to an int, defaulting to 300")
+				testSec = 300
+			}
+			cfg.TestFrequencySeconds = testSec
+			logrus.WithField("seconds", cfg.TestFrequencySeconds).Info("Running tests every x seconds")
+
+			// TODO make this dynamic and less hardcoded
+			if cfg.RuntimeCloudProviderMetadata.BunnyPodId != "" {
+				logrus.Info("Cloud provider: Bunny Magic Container Runtime detected")
+				cfg.ObservationRegion = fmt.Sprintf("%s/%s", cfg.RuntimeCloudProviderMetadata.BunnyRegion, cfg.RuntimeCloudProviderMetadata.BunnyZone)
+				cfg.ObserverId = fmt.Sprintf("%s/%s", cfg.RuntimeCloudProviderMetadata.BunnyAppId, cfg.RuntimeCloudProviderMetadata.BunnyPodId)
+			}
+
+			logrus.WithField("observer", cfg.ObserverId).WithField("region", cfg.ObservationRegion).Debug("Set region and observer")
+
 			// TODO validate at least one question & one resolver
 
 			return hachyboopInstance.Run()
@@ -89,7 +109,7 @@ A longer sentence, about how exactly to use this program`,
 	}
 	logrus.Info("==========================================================================")
 
-	logrus.Debugf("Parsing config")
+	logrus.Debug("Parsing config")
 
 	// Load environment variables
 	err = Environment()
@@ -101,7 +121,7 @@ A longer sentence, about how exactly to use this program`,
 	// Arbitrary (non-error) pre load
 	BeforeAppRun()
 
-	logrus.Debugf("Entering main app loop")
+	logrus.Debug("Entering main app loop")
 
 	// Runtime
 	err = app.Run(context.Background(), os.Args)

cmd/main_env.go

@@ -89,6 +89,30 @@ var (
 			Destination: &cfg.ObservationRegion,
 			Required:    false,
 		},
+		{
+			Name:        "BUNNYNET_MC_REGION",
+			Destination: &cfg.RuntimeCloudProviderMetadata.BunnyRegion,
+			Value:       "",
+			Required:    false,
+		},
+		{
+			Name:        "BUNNYNET_MC_PODID",
+			Destination: &cfg.RuntimeCloudProviderMetadata.BunnyPodId,
+			Value:       "",
+			Required:    false,
+		},
+		{
+			Name:        "BUNNYNET_MC_APPID",
+			Destination: &cfg.RuntimeCloudProviderMetadata.BunnyAppId,
+			Value:       "",
+			Required:    false,
+		},
+		{
+			Name:        "BUNNYNET_MC_ZONE",
+			Destination: &cfg.RuntimeCloudProviderMetadata.BunnyZone,
+			Value:       "",
+			Required:    false,
+		},
 		{
 			Name:        "HACHYBOOP_QUESTIONS",
 			Value:       "hachyderm.io",
@@ -101,6 +125,12 @@ var (
 			Destination: &cfg.ResolversRaw,
 			Required:    false,
 		},
+		{
+			Name:        "HACHYBOOP_TEST_FREQUENCY_SECONDS",
+			Value:       "300",
+			Destination: &cfg.TestFrequencySecondsRaw,
+			Required:    false,
+		},
 	}
 )
 
@@ -113,12 +143,16 @@ type EnvironmentVariable struct {
 
 func Environment() error {
 	for _, v := range registry {
-		v.Value = os.Getenv(v.Name)
-		if v.Required && v.Value == "" {
+		readValue := os.Getenv(v.Name)
+		if v.Required && readValue == "" {
 			// If required and the variable is empty
 			return fmt.Errorf("empty or undefined environmental variable [%s]", v.Name)
 		}
-		*v.Destination = v.Value
+
+		if readValue != "" {
+			v.Value = readValue // we don't use v.Value but why not
+			*v.Destination = readValue
+		}
 	}
 	return nil
 }

internal/service/hachyboop.go

@@ -39,15 +39,18 @@ import (
 
 // Configuration options for Hachyboop.
 type HachyboopOptions struct {
-	Verbose           bool
-	S3Output          *S3Options
-	FileOutput        *FileOptions
-	ObserverId        string
-	ObservationRegion string
-	QuestionsRaw      string // raw input from env/args
-	Questions         []string
-	ResolversRaw      string
-	Resolvers         []string
+	Verbose                      bool
+	S3Output                     *S3Options
+	FileOutput                   *FileOptions
+	RuntimeCloudProviderMetadata *RuntimeCloudProviderMetadata
+	ObserverId                   string
+	ObservationRegion            string
+	QuestionsRaw                 string // raw input from env/args
+	Questions                    []string
+	ResolversRaw                 string
+	Resolvers                    []string
+	TestFrequencySecondsRaw      string
+	TestFrequencySeconds         int
 
 	ObservationHandler chan *HachyboopDnsObservation
 }
@@ -72,8 +75,26 @@ type FileOptions struct {
 	ParquetWriter *writer.ParquetWriter
 }
 
+// Mostly for runtime provider contextual info
+type RuntimeCloudProviderMetadata struct {
+	// eventually we'll do something magical/dynamic to choose a provider based on detected runtime. for now, keeping it simple.
+	// Bunny stuff https://docs.bunny.net/docs/magic-containers-app-metadata
+	// BUNNYNET_MC_REGION
+	BunnyRegion string
+	// BUNNYNET_MC_PODID
+	BunnyPodId string
+	// BUNNYNET_MC_ZONE
+	BunnyZone string
+	// BUNNYNET_MC_APPID
+	BunnyAppId string
+}
+
 // True if we should output to S3.
 func (s *S3Options) Enabled() bool {
+	if s.EnabledRaw == "" {
+		return false
+	}
+
 	res, err := strconv.ParseBool(s.EnabledRaw)
 
 	if err != nil {
@@ -85,6 +106,10 @@ func (s *S3Options) Enabled() bool {
 
 // True if we should output to a local file.
 func (f *FileOptions) Enabled() bool {
+	if f.EnabledRaw == "" {
+		return false
+	}
+
 	res, err := strconv.ParseBool(f.EnabledRaw)
 
 	if err != nil {
@@ -146,8 +171,8 @@ func (hb *Hachyboop) Run() error {
 	for Enabled {
 		hb.queryResolvers(resolvers)
 
-		// TODO from config
-		time.Sleep(10 * time.Second)
+		logrus.WithField("seconds", hb.Options.TestFrequencySeconds).Debug("Sleeping")
+		time.Sleep(time.Duration(hb.Options.TestFrequencySeconds) * time.Second)
 	}
 	return nil
 }