https://github.com/permify/sloggcp
A log/slog handler for Google Cloud Logging, enabling seamless integration with Google Cloud's logging infrastructure
https://github.com/permify/sloggcp
Last synced: 2 months ago
JSON representation
A log/slog handler for Google Cloud Logging, enabling seamless integration with Google Cloud's logging infrastructure
- Host: GitHub
- URL: https://github.com/permify/sloggcp
- Owner: Permify
- License: apache-2.0
- Created: 2024-10-29T13:19:31.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-10-29T17:40:30.000Z (8 months ago)
- Last Synced: 2025-04-04T07:35:14.103Z (3 months ago)
- Language: Go
- Size: 21.5 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sloggcp
A `log/slog` handler for Google Cloud Logging, enabling seamless integration with Google Cloud's logging infrastructure.
## Quick Start
### Installation
Ensure you have the Google Cloud SDK installed and authenticated. Then, add `sloggcp` and necessary dependencies:
```bash
go get github.com/Permify/sloggcp
```
### Usage
Below is a minimal example of configuring and using sloggcp to send logs to Google Cloud Logging.
```go
package main
import (
"context"
"fmt"
"log/slog"
"os"
"github.com/Permify/sloggcp"
"github.com/joho/godotenv"
)
func main() {
// Load environment variables from .env file
if err := godotenv.Load(); err != nil {
fmt.Printf("Error loading .env file: %v\n", err)
os.Exit(1)
}
// Set up context and Google Cloud project ID
ctx := context.Background()
projectID := os.Getenv("GOOGLE_CLOUD_PROJECT")
if projectID == "" {
fmt.Println("GOOGLE_CLOUD_PROJECT environment variable is not set")
os.Exit(1)
}
logName := "my-application-log"
// Create a new GoogleCloudSlogHandler
handler, err := sloggcp.NewGoogleCloudSlogHandler(ctx, projectID, logName, &slog.HandlerOptions{
Level: slog.LevelInfo,
})
if err != nil {
fmt.Printf("Failed to create Google Cloud slog handler: %v\n", err)
os.Exit(1)
}
defer handler.Close()
// Set up the slog logger with the Google Cloud handler
logger := slog.New(handler)
slog.SetDefault(logger)
// Log messages at different levels
slog.Info("Application started", "version", "1.0")
slog.Debug("Debugging info", "module", "auth")
slog.Warn("Potential issue detected", "component", "database")
slog.Error("An error occurred", "error", "database connection failed")
// Optional: Close the handler when done to ensure logs are flushed
if err := handler.Close(); err != nil {
fmt.Printf("Failed to close the Google Cloud slog handler: %v\n", err)
}
}
```
### Explanation
- Project ID and Log Name: Set projectID and logName to your Google Cloud Project ID and desired log name.
- slog Handler: GoogleCloudSlogHandler sends logs directly to Google Cloud, handling attributes and severity levels automatically.
- Logging Levels: Log messages can be sent with various levels (Info, Debug, Warn, Error), automatically converting to the corresponding Google Cloud severity level.
### Environment Setup
Make sure the environment running this code has the necessary permissions to write to Google Cloud Logging. You can achieve this by:
1. Setting up authentication with a service account key.
2. Configuring the GOOGLE_APPLICATION_CREDENTIALS environment variable to point to the key file.
```bash
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-key.json"
```
### Testing Logs
After running the example, go to Google Cloud Logging and check for entries under the specified log name (my-application-log).
```bash
go test -v
```