Go Manual Logger#

Logging calls to custom models is supported via the Helicone Python SDK.

Install the Helicone helpers package

go get github.com/helicone/go-helicone-helpers

Set `HELICONE_API_KEY` as an environment variable

export HELICONE_API_KEY=sk-<your-api-key>

Info

You can also set the Helicone API Key in your code (See below)

Create a new HeliconeManualLogger instance

package mainimport (  logger "github.com/helicone/go-helicone-helpers"  "github.com/openai/openai-go"  "github.com/openai/openai-go/option")func main() {  // Replace with your actual API key  apiKey := os.Getenv("HELICONE_API_KEY")  openaiApiKey := os.Getenv("OPENAI_API_KEY")  // Example: Basic Logger  fmt.Println("Testing Basic Logger...")  chatCompletionOperation(apiKey, openaiApiKey)}func chatCompletionOperation(apiKey string, openaiApiKey string) {  manualLogger := logger.New(logger.LoggerOptions{  	APIKey: apiKey,  	Headers: map[string]string{  		"Helicone-User-Id": "test-user-123",  	},  })  openaiClient := openai.NewClient(option.WithAPIKey(openaiApiKey))}

Define your operation and make the request

// Define your requestrequest := logger.ILogRequest{    Model: "gpt-4o",    Extra: map[string]interface{}{        "messages": []map[string]string{            {"role": "user", "content": "Hello from basic logger!"},        },    },}result, err := manualLogger.LogRequest(request, func(recorder *logger.ResultRecorder) (interface{}, error) {    chatCompletion, err := openaiClient.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{        Messages: []openai.ChatCompletionMessageParamUnion{            openai.UserMessage("Hello, world!"),        },        Model: openai.ChatModelGPT4o,    })    if err != nil {        panic(err.Error())    }    // Simulate some processing time    jsonData, _ := json.Marshal(chatCompletion)    var resultMap map[string]interface{}    json.Unmarshal(jsonData, &resultMap)    recorder.AppendResults(resultMap)    return "Response from basic logger test", nil}, map[string]string{    "Helicone-Session-Id":   sessionId, // Optional session tracking})

API Reference#

ManualLogger#

type ManualLogger struct {	apiKey          string	headers         map[string]string	loggingEndpoint string}func New(options LoggerOptions) *ManualLogger {    //...}type LoggerOptions struct {	APIKey          string	Headers         map[string]string	LoggingEndpoint string}

LogOptions#

type LogOptions struct {	StartTime         int64	EndTime           int64	AdditionalHeaders map[string]string	TimeToFirstToken  *int	Status            int}

LogRequest#

func (l *ManualLogger) LogRequest(request HeliconeLogRequest, operation func(*ResultRecorder) (any, error),    additionalHeaders map[string]string) (any, error) {    //...}// HeliconeLogRequest represents either a basic log request or a custom event requesttype HeliconeLogRequest interface{}

Parameters#

request: A HeliconeLogRequest (interface) containing the request parameters
operation: A function that takes a ResultRecorder and returns a result
additionalHeaders: A map of string keys to string values

ResultRecorder#

type ResultRecorder struct {	results map[string]interface{}}func NewResultRecorder(logger *ManualLogger, request HeliconeLogRequest) *ResultRecorder {    //...}func (r *ResultRecorder) AppendResults(data map[string]interface{}) {    //...}func (r *ResultRecorder) GetResults() map[string]interface{} {    //...}