Skip to content

Conversation

@niveshdandyan
Copy link

Summary

Adds a shared logger package to toolhive-core for use by ToolHive Runtime, Registry, and other ToolHive ecosystem projects.

Related to stacklok/toolhive#3614

Changes

  • Added logger package with structured logging capabilities
  • Supports both structured (JSON) and unstructured (human-readable) output
  • Integration with logr.Logger for Kubernetes controller compatibility
  • Configurable debug mode via DebugProvider interface
  • Environment-based configuration via UNSTRUCTURED_LOGS env var
  • Added comprehensive test coverage

Features

The logger package provides:

  • Multiple log levels: Debug, Info, Warn, Error, Panic, DPanic, Fatal
  • Flexible output: Structured JSON or unstructured human-readable format
  • Kubernetes integration: NewLogr() for controller-runtime compatibility
  • Dependency injection: DebugProvider interface for configurable debug mode
  • Testing support: InitializeWithOptions() for test isolation

API

// Initialize with default (non-debug) mode
logger.Initialize()

// Initialize with custom debug provider
logger.InitializeWithDebug(myDebugProvider)

// Initialize with full options for testing
logger.InitializeWithOptions(envReader, debugProvider)

// Logging functions
logger.Debug("message")
logger.Debugf("format %s", arg)
logger.Debugw("message", "key", value)
// ... same pattern for Info, Warn, Error, Panic, DPanic, Fatal

Testing

  • go build ./... succeeds
  • go test ./... passes

AI Transparency

This PR was created with the assistance of AI (Claude by Anthropic) for code generation and review.

This adds a structured logging package that can be used by both
ToolHive Runtime and Registry projects. The logger provides:

- Multiple log levels (Debug, Info, Warn, Error, Panic, Fatal)
- Support for both structured (JSON) and unstructured (human-readable) output
- Integration with logr.Logger for Kubernetes controller compatibility
- Configurable debug mode via DebugProvider interface
- Environment-based configuration via UNSTRUCTURED_LOGS env var

The DebugProvider interface allows projects to plug in their own
debug flag implementation (e.g., viper configuration).

Related to stacklok/toolhive#3614

Co-Authored-By: Claude (claude-opus-4-5) <noreply@anthropic.com>
@eleftherias
Copy link
Member

Thanks for the PR @niveshdandyan. In the future, please comment on the issue so we can assign it to you before creating pull requests. This helps us coordinate contributions and avoid work duplication. Please check the contribution process here https://github.com/stacklok/toolhive/blob/main/CONTRIBUTING.md#claiming-an-issue

@niveshdandyan
Copy link
Author

Thank you for the feedback @eleftherias! I apologize for not following the contribution process properly. I will make sure to comment on issues first to get them assigned before creating PRs in the future. I've noted the contribution guidelines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants