{"id":36537915,"url":"https://github.com/checklogsdev/go-sdk","last_synced_at":"2026-01-15T02:22:02.537Z","repository":{"id":310722906,"uuid":"1040989844","full_name":"checklogsdev/go-sdk","owner":"checklogsdev","description":"La plateforme de gestion de logs la plus simple et entièrement gratuite.","archived":false,"fork":false,"pushed_at":"2025-09-07T02:37:30.000Z","size":49,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-07T03:28:31.396Z","etag":null,"topics":["go","go-sdk","golang","logs","monitoring-tool"],"latest_commit_sha":null,"homepage":"https://checklogs.dev","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checklogsdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-19T20:12:44.000Z","updated_at":"2025-09-07T02:37:09.000Z","dependencies_parsed_at":"2025-08-19T21:42:41.683Z","dependency_job_id":"88ae7b4a-44a4-4374-8011-4f675f2c17de","html_url":"https://github.com/checklogsdev/go-sdk","commit_stats":null,"previous_names":["checklogsdev/go-sdk"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/checklogsdev/go-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checklogsdev%2Fgo-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checklogsdev%2Fgo-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checklogsdev%2Fgo-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checklogsdev%2Fgo-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checklogsdev","download_url":"https://codeload.github.com/checklogsdev/go-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checklogsdev%2Fgo-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28441272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-15T00:55:22.719Z","status":"online","status_checked_at":"2026-01-15T02:00:08.019Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","go-sdk","golang","logs","monitoring-tool"],"created_at":"2026-01-12T05:13:30.600Z","updated_at":"2026-01-15T02:22:02.530Z","avatar_url":"https://github.com/checklogsdev.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CheckLogs Go SDK\n\n[![Go Version](https://img.shields.io/badge/Go-1.21+-blue.svg)](https://golang.org)\n[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)\n[![Go Report Card](https://goreportcard.com/badge/github.com/checklogsdev/go-sdk)](https://goreportcard.com/report/github.com/checklogsdev/go-sdk)\n\nOfficial Go SDK for [CheckLogs.dev](https://checklogs.dev) - A powerful log monitoring system.\n\n```bash\ngo get github.com/checklogsdev/go-sdk\n```\n\n## Basic Usage\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    // Create a logger instance\n    logger := checklogs.CreateLogger(\"your-api-key-here\")\n    \n    ctx := context.Background()\n    \n    // Log messages\n    logger.Info(ctx, \"Application started\")\n    logger.Error(ctx, \"Something went wrong\", map[string]interface{}{\n        \"error_code\": 500,\n    })\n}\n```\n\n## Package Support\n\nThis package supports all Go versions 1.21 and above.\n\nThe package automatically provides clean, idiomatic Go code with:\n- **Thread-safe operations** - Safe for concurrent goroutines\n- **Context support** - Native Go context integration for cancellation and timeouts\n- **Structured logging** - Rich metadata and context support\n\n## Features\n\n- ✅ Full API coverage (logging, retry management, analytics)\n- ✅ Thread-safe for concurrent use\n- ✅ Native Go context support\n- ✅ Automatic retry mechanism with exponential backoff\n- ✅ Enhanced logging with metadata (hostname, process info, timestamps)\n- ✅ Console output integration\n- ✅ Child loggers with inherited context\n- ✅ Timer functionality for performance measurement\n- ✅ Error handling with custom error types\n- ✅ Validation and sanitization\n- ✅ Configurable timeouts and endpoints\n\n## Core Usage\n\n### Basic Logger\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    logger := checklogs.CreateLogger(\"your-api-key\")\n    ctx := context.Background()\n    \n    // Log at different levels\n    logger.Debug(ctx, \"Debug information\")\n    logger.Info(ctx, \"Application started\")\n    logger.Warning(ctx, \"This is a warning\")\n    logger.Error(ctx, \"An error occurred\")\n    logger.Critical(ctx, \"Critical system failure\")\n}\n```\n\n### Advanced Logger\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"time\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    userID := int64(123)\n    \n    // Create logger with options\n    options := \u0026checklogs.Options{\n        Source:  \"my-go-app\",\n        UserID:  \u0026userID,\n        Context: map[string]interface{}{\n            \"version\": \"1.0.0\",\n            \"env\":     \"production\",\n        },\n        ConsoleOutput: true,\n        Timeout:       30 * time.Second,\n    }\n    \n    logger := checklogs.NewLogger(\"your-api-key\", options)\n    ctx := context.Background()\n    \n    // Send log with additional context\n    logger.Info(ctx, \"User action performed\", map[string]interface{}{\n        \"action\": \"file_upload\",\n        \"file_size\": 1024000,\n        \"duration_ms\": 250,\n    })\n}\n```\n\n## Configuration Options\n\n```go\ntype Options struct {\n    Source        string                 // Default source identifier\n    UserID        *int64                 // Default user ID\n    Context       map[string]interface{} // Default context merged with all logs\n    Silent        bool                   // Suppress HTTP requests (console only)\n    ConsoleOutput bool                   // Enable console output (default: true)\n    BaseURL       string                 // Custom API endpoint\n    Timeout       time.Duration          // HTTP request timeout (default: 30s)\n}\n```\n\n## Child Loggers\n\nCreate child loggers with inherited context:\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    // Main logger with service context\n    mainLogger := checklogs.CreateLogger(\"your-api-key\")\n    \n    // Child logger for user module\n    userLogger := mainLogger.Child(map[string]interface{}{\n        \"module\": \"user\",\n        \"service\": \"authentication\",\n    })\n    \n    // Child logger for order module  \n    orderLogger := mainLogger.Child(map[string]interface{}{\n        \"module\": \"orders\",\n        \"service\": \"payment\",\n    })\n    \n    ctx := context.Background()\n    \n    // Each child inherits parent context\n    userLogger.Info(ctx, \"User login attempt\")  // Context: {module: \"user\", service: \"authentication\"}\n    orderLogger.Error(ctx, \"Payment failed\")    // Context: {module: \"orders\", service: \"payment\"}\n}\n```\n\n## Performance Timing\n\nMeasure execution time:\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"time\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    logger := checklogs.CreateLogger(\"your-api-key\")\n    \n    // Start timer\n    timer := logger.Time(\"db-query\", \"Executing database query\")\n    \n    // Simulate some work\n    time.Sleep(100 * time.Millisecond)\n    \n    // End timer (automatically logs end time with duration)\n    duration := timer.End()\n    fmt.Printf(\"Operation took %v\\n\", duration)\n}\n```\n\n## Error Handling\n\nThe SDK provides specific error types:\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"fmt\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    logger := checklogs.CreateLogger(\"your-api-key\")\n    ctx := context.Background()\n    \n    err := logger.Info(ctx, \"Test message\")\n    if err != nil {\n        if checkLogsErr, ok := err.(*checklogs.CheckLogsError); ok {\n            switch checkLogsErr.Type {\n            case \"ValidationError\":\n                fmt.Println(\"Validation failed:\", checkLogsErr.Message)\n            case \"APIError\":\n                fmt.Printf(\"API error: %s (code: %d)\\n\", checkLogsErr.Message, checkLogsErr.Code)\n            case \"NetworkError\":\n                fmt.Println(\"Network problem:\", checkLogsErr.Message)\n            case \"ConfigurationError\":\n                fmt.Println(\"Configuration issue:\", checkLogsErr.Message)\n            }\n        }\n    }\n}\n```\n\n## Retry Queue Management\n\nThe logger automatically retries failed requests:\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"fmt\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    logger := checklogs.CreateLogger(\"your-api-key\")\n    \n    // Check retry queue status\n    queueSize := logger.GetRetryQueueSize()\n    fmt.Printf(\"%d logs pending retry\\n\", queueSize)\n    \n    // Wait for all logs to be sent\n    ctx := context.Background()\n    success := logger.FlushRetryQueue(ctx)\n    fmt.Printf(\"Successfully sent %d logs\\n\", success)\n    \n    // Clear retry queue if needed\n    logger.ClearRetryQueue()\n}\n```\n\n## Log Levels\n\nSupported log levels (in order of severity):\n\n- `checklogs.Debug` - Development and troubleshooting information\n- `checklogs.Info` - General application flow\n- `checklogs.Warning` - Potentially harmful situations  \n- `checklogs.Error` - Error events that might still allow the application to continue\n- `checklogs.Critical` - Very severe error events that might cause the application to abort\n\n## Data Validation\n\nThe SDK automatically validates and sanitizes data:\n\n- **Message**: Required, max 1024 characters\n- **Level**: Must be valid level\n- **Source**: Max 100 characters  \n- **Context**: Objects only, max 5000 characters when serialized\n- **User ID**: Must be a valid int64\n\n## Best Practices\n\n### Goroutine Safety\nThe logger is safe for concurrent use across goroutines:\n\n```go\nfunc handleRequest(logger *checklogs.Logger, requestID string) {\n    requestLogger := logger.Child(map[string]interface{}{\n        \"request_id\": requestID,\n    })\n    \n    // Use requestLogger safely in this goroutine\n    requestLogger.Info(context.Background(), \"Processing request\")\n}\n```\n\n### Context Management\nAlways use context for cancellation and timeouts:\n\n```go\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\ndefer cancel()\n\nerr := logger.Info(ctx, \"Important message\")\nif err != nil {\n    log.Printf(\"Failed to send log: %v\", err)\n}\n```\n\n### Error Handling\nAlways handle potential logging errors:\n\n```go\nif err := logger.Error(ctx, \"Database connection failed\", map[string]interface{}{\n    \"database\": \"users\",\n    \"error\": dbErr.Error(),\n}); err != nil {\n    // Log locally as fallback\n    log.Printf(\"Failed to send to CheckLogs: %v\", err)\n}\n```\n\n### Graceful Shutdown\nFlush pending logs before shutdown:\n\n```go\nfunc gracefulShutdown(logger *checklogs.Logger) {\n    ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)\n    defer cancel()\n    \n    success := logger.FlushRetryQueue(ctx)\n    if success == 0 {\n        log.Println(\"Warning: Some logs may not have been sent\")\n    }\n}\n```\n\n## Framework Integration\n\n### Gin Web Framework\n\n```go\npackage main\n\nimport (\n    \"github.com/gin-gonic/gin\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    logger := checklogs.CreateLogger(\"your-api-key\")\n    \n    r := gin.Default()\n    \n    // Request logging middleware\n    r.Use(func(c *gin.Context) {\n        requestLogger := logger.Child(map[string]interface{}{\n            \"request_id\": c.GetHeader(\"X-Request-ID\"),\n            \"method\":     c.Request.Method,\n            \"path\":       c.Request.URL.Path,\n            \"ip\":         c.ClientIP(),\n        })\n        \n        c.Set(\"logger\", requestLogger)\n        c.Next()\n    })\n    \n    r.GET(\"/users/:id\", func(c *gin.Context) {\n        logger := c.MustGet(\"logger\").(*checklogs.Logger)\n        userID := c.Param(\"id\")\n        \n        logger.Info(c.Request.Context(), \"Fetching user\", map[string]interface{}{\n            \"user_id\": userID,\n        })\n        \n        // ... your logic here ...\n        \n        logger.Info(c.Request.Context(), \"User fetched successfully\")\n        c.JSON(200, gin.H{\"user\": \"data\"})\n    })\n    \n    r.Run(\":8080\")\n}\n```\n\n### Echo Web Framework\n\n```go\npackage main\n\nimport (\n    \"github.com/labstack/echo/v4\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc main() {\n    logger := checklogs.CreateLogger(\"your-api-key\")\n    \n    e := echo.New()\n    \n    // Logging middleware\n    e.Use(func(next echo.HandlerFunc) echo.HandlerFunc {\n        return func(c echo.Context) error {\n            requestLogger := logger.Child(map[string]interface{}{\n                \"request_id\": c.Request().Header.Get(\"X-Request-ID\"),\n                \"method\":     c.Request().Method,\n                \"path\":       c.Request().URL.Path,\n            })\n            \n            c.Set(\"logger\", requestLogger)\n            return next(c)\n        }\n    })\n    \n    e.Start(\":8080\")\n}\n```\n\n### Background Job Processing\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"github.com/checklogsdev/go-sdk\"\n)\n\nfunc processJob(jobID string) {\n    logger := checklogs.CreateLogger(\"your-api-key\")\n    \n    jobLogger := logger.Child(map[string]interface{}{\n        \"job_id\": jobID,\n        \"worker\": \"background-processor\",\n    })\n    \n    timer := jobLogger.Time(\"job-processing\", \"Processing background job\")\n    \n    ctx := context.Background()\n    jobLogger.Info(ctx, \"Job started\")\n    \n    // ... job processing logic ...\n    \n    duration := timer.End()\n    jobLogger.Info(ctx, \"Job completed\", map[string]interface{}{\n        \"status\": \"success\",\n        \"duration_seconds\": duration.Seconds(),\n    })\n}\n```\n\nNote: The SDK supports Go 1.21 and above. Use standard `import` statements as shown in the examples.\n\n---\n\n**License**: MIT\n\n**Documentation**: [https://docs.checklogs.dev](https://docs.checklogs.dev)  \n**Issues**: [GitHub Issues](https://github.com/checklogsdev/go-sdk/issues)  \n**Email**: [contact@loggersimple.com](mailto:contact@loggersimple.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchecklogsdev%2Fgo-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchecklogsdev%2Fgo-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchecklogsdev%2Fgo-sdk/lists"}