Updated SDK to use SDK_TOKEN and API_KEY

Author: timpratim

README.md

@@ -69,8 +69,8 @@ import (
 
 func main() {
     treblle.Configure(treblle.Configuration{
-        APIKey:    "your-treblle-api-key",
-        ProjectID: "your-treblle-project-id",
+        SDK_TOKEN: "your-treblle-sdk-token",
+        API_KEY:   "your-treblle-api-key",
     })
 
     // Your API server setup
@@ -93,8 +93,8 @@ import (
 func main() {
     // Configure Treblle
     treblle.Configure(treblle.Configuration{
-        APIKey:    "your-treblle-api-key",
-        ProjectID: "your-treblle-project-id",
+        SDK_TOKEN: "your-treblle-sdk-token",
+        API_KEY:   "your-treblle-api-key",
     })
 
     // Create a new router
@@ -124,8 +124,8 @@ import (
 func main() {
     // Configure Treblle
     treblle.Configure(treblle.Configuration{
-        APIKey:    "your-treblle-api-key",
-        ProjectID: "your-treblle-project-id",
+        SDK_TOKEN: "your-treblle-sdk-token",
+        API_KEY:   "your-treblle-api-key",
     })
 
     // Create a new serve mux

batch_error_test.go

@@ -10,8 +10,8 @@ import (
 func TestBatchErrorCollector(t *testing.T) {
 	// Configure Treblle with test settings
 	Configure(Configuration{
-		APIKey:    "test-api-key",
-		ProjectID: "test-project-id",
+		SDK_TOKEN: "test-sdk-token",
+		API_KEY:   "test-api-key",
 		Endpoint:  "http://localhost:8080",
 	})
 

configuration.go

@@ -11,8 +11,8 @@ var Config internalConfiguration
 
 // Configuration sets up and customizes communication with the Treblle API
 type Configuration struct {
-	APIKey                  string
-	ProjectID               string
+	SDK_TOKEN               string
+	API_KEY                 string
 	AdditionalFieldsToMask  []string
 	DefaultFieldsToMask     []string
 	MaskingEnabled          bool
@@ -47,15 +47,15 @@ type internalConfiguration struct {
 	AsyncProcessingEnabled  bool
 	MaxConcurrentProcessing int
 	AsyncShutdownTimeout    time.Duration
-	IgnoredEnvironments     []string // Environments where Treblle does not track requests
+	IgnoredEnvironments     []string
 }
 
 func Configure(config Configuration) {
-	if config.APIKey != "" {
-		Config.APIKey = config.APIKey
+	if config.SDK_TOKEN != "" {
+		Config.APIKey = config.SDK_TOKEN
 	}
-	if config.ProjectID != "" {
-		Config.ProjectID = config.ProjectID
+	if config.API_KEY != "" {
+		Config.ProjectID = config.API_KEY
 	}
 	if config.Endpoint != "" {
 		Config.Endpoint = config.Endpoint
@@ -65,11 +65,11 @@ func Configure(config Configuration) {
 	Config.Debug = config.Debug
 
 	// Initialize server and language info
-	Config.serverInfo = GetServerInfo(nil) // Pass nil as request, protocol will be updated in middleware
+	Config.serverInfo = GetServerInfo(nil)
 	Config.languageInfo = GetLanguageInfo()
 
 	// Initialize default masking settings
-	Config.MaskingEnabled = true // Enable by default
+	Config.MaskingEnabled = true
 
 	// Set SDK Name and Version (Can be overridden via ENV)
 	sdkName := "go"
@@ -94,21 +94,19 @@ func Configure(config Configuration) {
 	Config.AsyncProcessingEnabled = config.AsyncProcessingEnabled
 	Config.MaxConcurrentProcessing = config.MaxConcurrentProcessing
 	if Config.MaxConcurrentProcessing <= 0 {
-		Config.MaxConcurrentProcessing = 10 // Default to 10 concurrent operations
+		Config.MaxConcurrentProcessing = 10
 	}
 
 	Config.AsyncShutdownTimeout = config.AsyncShutdownTimeout
 	if Config.AsyncShutdownTimeout <= 0 {
-		Config.AsyncShutdownTimeout = 5 * time.Second // Default to 5 seconds
+		Config.AsyncShutdownTimeout = 5 * time.Second
 	}
 
 	// Initialize batch error collector if enabled
 	if config.BatchErrorEnabled {
-		// Close existing collector if any
 		if Config.batchErrorCollector != nil {
 			Config.batchErrorCollector.Close()
 		}
-		// Create new batch error collector
 		Config.batchErrorCollector = NewBatchErrorCollector(config.BatchErrorSize, config.BatchFlushInterval)
 	}
 
@@ -131,15 +129,13 @@ func Configure(config Configuration) {
 	if len(config.IgnoredEnvironments) > 0 {
 		Config.IgnoredEnvironments = config.IgnoredEnvironments
 	} else {
-		// Default ignored environments: dev, test, testing
 		defaultIgnoredEnvs := []string{"dev", "test", "testing"}
 		Config.IgnoredEnvironments = getEnvAsSlice("TREBLLE_IGNORED_ENV", defaultIgnoredEnvs)
 	}
 
 	Config.FieldsMap = generateFieldsToMask(Config.DefaultFieldsToMask, Config.AdditionalFieldsToMask)
 }
 
-// getEnvMaskedFields reads masked fields from environment variable
 func getEnvMaskedFields() []string {
 	fieldsStr := os.Getenv("TREBLLE_MASKED_FIELDS")
 	if fieldsStr == "" {
@@ -148,7 +144,6 @@ func getEnvMaskedFields() []string {
 	return strings.Split(fieldsStr, ",")
 }
 
-// getDefaultFieldsToMask returns the default list of fields to mask
 func getDefaultFieldsToMask() []string {
 	return []string{
 		"password",
@@ -184,37 +179,30 @@ func generateFieldsToMask(defaultFields, additionalFields []string) map[string]b
 	return fieldsToMask
 }
 
-// Utility function to get env variable or return default
 func getEnvOrDefault(envKey, defaultValue string) string {
 	if value := os.Getenv(envKey); value != "" {
 		return value
 	}
 	return defaultValue
 }
 
-// GetSDKInfo returns SDK name and version (for debugging)
 func GetSDKInfo() map[string]string {
 	return map[string]string{
 		"SDK Name":    Config.SDKName,
 		"SDK Version": strconv.FormatFloat(Config.SDKVersion, 'f', 2, 64),
 	}
 }
 
-// getEnvAsSlice reads a comma-separated environment variable and returns it as a slice
-// If the environment variable is not set, it returns the default values
 func getEnvAsSlice(envKey string, defaultValues []string) []string {
 	if value := os.Getenv(envKey); value != "" {
 		return strings.Split(value, ",")
 	}
 	return defaultValues
 }
 
-// IsEnvironmentIgnored checks if the current environment should be ignored
 func IsEnvironmentIgnored() bool {
-	// Get the current environment
-	currentEnv := os.Getenv("GO_ENV") // Default Go environment variable
+	currentEnv := os.Getenv("GO_ENV")
 	if currentEnv == "" {
-		// Try alternative environment variables if GO_ENV is not set
 		currentEnv = os.Getenv("ENV")
 		if currentEnv == "" {
 			currentEnv = os.Getenv("ENVIRONMENT")
@@ -224,12 +212,10 @@ func IsEnvironmentIgnored() bool {
 		}
 	}
 
-	// If no environment is set, don't ignore
 	if currentEnv == "" {
 		return false
 	}
 
-	// Check if the environment is in the ignored list
 	for _, ignoredEnv := range Config.IgnoredEnvironments {
 		if strings.TrimSpace(currentEnv) == strings.TrimSpace(ignoredEnv) {
 			return true

configuration_ignored_env_test.go

@@ -88,9 +88,9 @@ func TestIgnoredEnvironments(t *testing.T) {
 
 			// Configure Treblle with test case settings
 			config := Configuration{
-				APIKey:              "test-api-key",
-				ProjectID:           "test-project-id",
-				IgnoredEnvironments: tc.ignoredEnvs,
+				SDK_TOKEN:              "test-sdk-token",
+				API_KEY:                "test-api-key",
+				IgnoredEnvironments:    tc.ignoredEnvs,
 			}
 			Configure(config)
 

configuration_test.go

@@ -10,8 +10,8 @@ import (
 func TestSDKVersioning(t *testing.T) {
 	// Initialize with default configuration
 	Configure(Configuration{
-		APIKey:    "test-api-key",
-		ProjectID: "test-project-id",
+		SDK_TOKEN: "test-sdk-token",
+		API_KEY:   "test-api-key",
 	})
 
 	// Ensure default version is correct

debug.go

@@ -12,8 +12,8 @@ func DebugCommand() {
 	// Initialize configuration from environment variables if not already set
 	if Config.APIKey == "" {
 		// Read configuration from environment variables
-		apiKey := getEnvOrDefault("TREBLLE_API_KEY", "")
-		projectID := getEnvOrDefault("TREBLLE_PROJECT_ID", "")
+		apiKey := getEnvOrDefault("TREBLLE_SDK_TOKEN", "")
+		projectID := getEnvOrDefault("TREBLLE_API_KEY", "")
 		endpoint := getEnvOrDefault("TREBLLE_ENDPOINT", "")
 		ignoredEnvs := getEnvAsSlice("TREBLLE_IGNORED_ENVIRONMENTS", []string{"local", "development"})
 
@@ -38,8 +38,8 @@ func DebugCommand() {
 
 	// Display basic SDK configuration
 	fmt.Println("SDK Version:", strconv.FormatFloat(Config.SDKVersion, 'f', 1, 64))
-	fmt.Println("Project ID:", maskString(Config.ProjectID))
-	fmt.Println("API Key:", maskString(Config.APIKey))
+	fmt.Println("API Key:", maskString(Config.ProjectID))
+	fmt.Println("SDK Token:", maskString(Config.APIKey))
 	fmt.Println("Configured Treblle URL:", getConfiguredEndpoint())
 	fmt.Println("Ignored Environments:", Config.IgnoredEnvironments)
 }

examples/gorilla_example/main.go

@@ -88,8 +88,9 @@ func getUsersHandler(w http.ResponseWriter, r *http.Request) {
 func main() {
 	// Configure Treblle
 	treblle.Configure(treblle.Configuration{
-		APIKey:    "Treblle API key",    // Set your Treblle API key
-		ProjectID: "Treblle Project ID", // Set your Treblle Project ID
+		SDK_TOKEN: "Treblle SDK Token", // Set your Treblle SDK Token
+		API_KEY:   "Treblle API Key",   // Set your Treblle API Key
+		Debug:     true,                // Enable debug mode to see what's being sent to Treblle
 	})
 
 	// Create a new router

examples/standard_example/main.go

@@ -81,8 +81,9 @@ func createUserHandler(w http.ResponseWriter, r *http.Request) {
 func main() {
 	// Configure Treblle
 	treblle.Configure(treblle.Configuration{
-		APIKey:    "Treblle API key",    // Set your Treblle API key
-		ProjectID: "Treblle Project ID", // Set your Treblle Project ID
+		SDK_TOKEN: "Treblle SDK Token", // Set your Treblle SDK Token
+		API_KEY:   "Treblle API Key",   // Set your Treblle API Key
+		Debug:     true,                // Enable debug mode to see what's being sent to Treblle
 	})
 
 	// Create a new serve mux

examples/test_cli/main.go

@@ -19,20 +19,23 @@ import (
 
 func main() {
 	// Set environment variables for testing
-	os.Setenv("TREBLLE_API_KEY", "test_api_key_12345")
-	os.Setenv("TREBLLE_PROJECT_ID", "test_project_id_67890")
+	os.Setenv("TREBLLE_SDK_TOKEN", "test_api_key_12345")
+	os.Setenv("TREBLLE_API_KEY", "test_project_id_67890")
 	os.Setenv("TREBLLE_ENDPOINT", "https://test-api.treblle.com")
 	os.Setenv("TREBLLE_IGNORED_ENVIRONMENTS", "local,testing")
 
-	// Configure Treblle with test values
+	// Configure Treblle
 	treblle.Configure(treblle.Configuration{
-		APIKey:                  "test_api_key_12345",
-		ProjectID:               "test_project_id_67890",
-		AdditionalFieldsToMask:  []string{"custom_field", "secret_data"},
-		MaskingEnabled:          true,
+		SDK_TOKEN: os.Getenv("TREBLLE_SDK_TOKEN"), // Get SDK Token from environment variable
+		API_KEY:   os.Getenv("TREBLLE_API_KEY"),   // Get API Key from environment variable
+		Debug:     true,                           // Enable debug mode
+		AdditionalFieldsToMask:  []string{"custom_field", "another_field"},
+		BatchErrorEnabled:       true,
+		BatchErrorSize:          5,
+		BatchFlushInterval:      10 * time.Second,
 		AsyncProcessingEnabled:  true,
 		MaxConcurrentProcessing: 5,
-		AsyncShutdownTimeout:    time.Second * 3,
+		AsyncShutdownTimeout:    3 * time.Second,
 		IgnoredEnvironments:     []string{"local", "testing"},
 	})
 

examples/treblle-go-sdk-example/main.go

@@ -138,10 +138,10 @@ func main() {
 	}
 
 	treblle.Configure(treblle.Configuration{
-		APIKey:                 os.Getenv("TREBLLE_API_KEY"),
-		ProjectID:              os.Getenv("TREBLLE_PROJECT_ID"),
-		AdditionalFieldsToMask: []string{"bank_account", "routing_number", "tax_id", "auth_token", "ssn", "api_key", "password", "credit_card"},
+		APIKey:                 os.Getenv("TREBLLE_SDK_TOKEN"),
+		ProjectID:              os.Getenv("TREBLLE_API_KEY"),
 		Debug:                  debug == "true",
+		AdditionalFieldsToMask: []string{"bank_account", "routing_number", "tax_id", "auth_token", "ssn", "api_key", "password", "credit_card"},
 	})
 
 	r := mux.NewRouter()

metadata.go

@@ -12,8 +12,8 @@ import (
 )
 
 type MetaData struct {
-	ApiKey    string   `json:"api_key"`
-	ProjectID string   `json:"project_id"`
+	ApiKey    string   `json:"api_key"`    // Renamed internally but kept the same JSON field name
+	ProjectID string   `json:"project_id"` // Renamed internally but kept the same JSON field name
 	Version   float64  `json:"version"`
 	Sdk       string   `json:"sdk"`
 	Data      DataInfo `json:"data"`

middleware_test.go

@@ -35,8 +35,8 @@ func (s *TestSuite) SetupTest() {
 	s.treblleMockMux = http.NewServeMux()
 	s.treblleMockServer = httptest.NewServer(s.treblleMockMux)
 	Configure(Configuration{
-		APIKey:    "test-api-key",
-		ProjectID: "test-project",
+		SDK_TOKEN: "test-sdk-token",
+		API_KEY:   "test-api-key",
 		DefaultFieldsToMask: []string{
 			"password",
 			"api_key",
@@ -183,8 +183,8 @@ func (s *TestSuite) TestMiddleware() {
 		log.Printf("Test case: %s, Mock URL: %s", tn, mockURL)
 
 		Configure(Configuration{
-			APIKey:              "test-api-key",
-			ProjectID:           "test-project-id",
+			SDK_TOKEN:              "test-sdk-token",
+			API_KEY:                "test-api-key",
 			DefaultFieldsToMask: []string{"password"},
 			Endpoint:            mockURL,
 		})
@@ -198,9 +198,9 @@ func (s *TestSuite) TestMiddleware() {
 				log.Printf("Error decoding request body in mock server: %v", err)
 				return
 			}
-			log.Printf("Received metadata - APIKey: %s, ProjectID: %s", treblleMetadata.ApiKey, treblleMetadata.ProjectID)
-			s.Require().Equal("test-api-key", treblleMetadata.ApiKey)
-			s.Require().Equal("test-project-id", treblleMetadata.ProjectID)
+			log.Printf("Received metadata - SDK Token: %s, API Key: %s", treblleMetadata.ApiKey, treblleMetadata.ProjectID)
+			s.Require().Equal("test-sdk-token", treblleMetadata.ApiKey)
+			s.Require().Equal("test-api-key", treblleMetadata.ProjectID)
 
 			if tn == "non-json-response" {
 				// For non-JSON responses, the body should be a JSON string
@@ -264,8 +264,8 @@ func (s *TestSuite) TestProtocolDetection() {
 	mockURL := s.treblleMockServer.URL
 
 	Configure(Configuration{
-		APIKey:              "test-api-key",
-		ProjectID:           "test-project-id",
+		SDK_TOKEN: "test-sdk-token",
+		API_KEY:   "test-api-key",
 		DefaultFieldsToMask: []string{"password"},
 		Endpoint:            mockURL,
 	})

shutdown_test.go

@@ -11,8 +11,8 @@ import (
 func TestShutdown(t *testing.T) {
 	// Configure Treblle for testing
 	Configure(Configuration{
-		APIKey:    "test-api-key",
-		ProjectID: "test-project-id",
+		SDK_TOKEN: "test-sdk-token",
+		API_KEY:   "test-api-key",
 		Endpoint:  "https://test-endpoint.treblle.com", // Use a test endpoint
 	})
 
@@ -92,12 +92,12 @@ func TestShutdown(t *testing.T) {
 func TestGracefulShutdown(t *testing.T) {
 	// Configure Treblle with batch error collector
 	Configure(Configuration{
-		APIKey:            "test-api-key",
-		ProjectID:         "test-project-id",
-		Endpoint:          "https://test-endpoint.treblle.com",
-		BatchErrorEnabled: true,
-		BatchErrorSize:    10,
-		BatchFlushInterval: 5 * time.Second,
+		SDK_TOKEN:              "test-sdk-token",
+		API_KEY:                "test-api-key",
+		Endpoint:             "https://test-endpoint.treblle.com",
+		BatchErrorEnabled:    true,
+		BatchErrorSize:       10,
+		BatchFlushInterval:   5 * time.Second,
 	})
 
 	// Add some errors to the batch collector