github.com/sirupsen/logrus v1.9.3: FieldKeyTime

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify github.com/sirupsen/logrus.FieldKeyTime in pkg:golang/github.com/sirupsen/logrus@v1.9.3
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/sirupsen/logrus@v1.9.3
Demonstrate these symbols/APIs:
  - github.com/sirupsen/logrus.FieldKeyTime

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:e537c0d1002017d39918d1c9a47d2f896c28e604bdf614d249a7d68d9ec22115","contract":["logrus.FieldKeyTime constant equals default time key time","logrus.JSONFormatter outputs the timestamp under logrus.FieldKeyTime by default","logrus.JSONFormatter customizes the timestamp key using FieldMap with logrus.FieldKeyTime","logrus.TextFormatter customizes the timestamp key using FieldMap with logrus.FieldKeyTime"],"goal":"verify github.com/sirupsen/logrus.FieldKeyTime in pkg:golang/github.com/sirupsen/logrus@v1.9.3","kind":"HOW","packages":["pkg:golang/github.com/sirupsen/logrus@v1.9.3"],"schemaVersion":1,"symbols":["github.com/sirupsen/logrus.FieldKeyTime"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/sirupsen/logrus@v1.9.3"],"schemaVersion":1,"subject":"pkg:golang/github.com/sirupsen/logrus@v1.9.3","symbols":["github.com/sirupsen/logrus.FieldKeyTime"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require github.com/sirupsen/logrus v1.9.3

require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect

github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

package main

import (
	"bytes"
	"fmt"
	"os"

	"github.com/sirupsen/logrus"
)

func main() {
	fmt.Printf("Default logrus time field key: %s\n", logrus.FieldKeyTime)

	// Demonstration 1: Default JSON format uses FieldKeyTime ("time")
	logger := logrus.New()
	logger.SetOutput(os.Stdout)
	logger.SetFormatter(&logrus.JSONFormatter{})
	logger.Info("Demonstrating default logrus time field key")

	// Demonstration 2: Customizing the time key with FieldMap and FieldKeyTime in JSONFormatter
	customLogger := logrus.New()
	var buf bytes.Buffer
	customLogger.SetOutput(&buf)
	customLogger.SetFormatter(&logrus.JSONFormatter{
		FieldMap: logrus.FieldMap{
			logrus.FieldKeyTime: "@timestamp",
		},
	})
	customLogger.Info("Demonstrating customized time key in JSON")
	fmt.Printf("Custom JSON output: %s", buf.String())

	// Demonstration 3: Customizing the time key with FieldMap and FieldKeyTime in TextFormatter
	buf.Reset()
	customLogger.SetFormatter(&logrus.TextFormatter{
		DisableColors: true,
		FieldMap: logrus.FieldMap{
			logrus.FieldKeyTime: "timestamp",
		},
	})
	customLogger.Info("Demonstrating customized time key in text")
	fmt.Printf("Custom Text output: %s", buf.String())
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/sirupsen/logrus.FieldKeyTime in pkg:golang/github.com/sirupsen/logrus@v1.9.3",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/sirupsen/logrus@v1.9.3"
  ],
  "symbols": [
    "github.com/sirupsen/logrus.FieldKeyTime"
  ]
}

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"os"
	"strings"

	"github.com/sirupsen/logrus"
)

func main() {
	// Assertion 1: logrus.FieldKeyTime constant equals default time key time
	if logrus.FieldKeyTime != "time" {
		fmt.Fprintf(os.Stderr, "assertion 1 failed: expected FieldKeyTime to be %q, got %q\n", "time", logrus.FieldKeyTime)
		os.Exit(1)
	}

	// Assertion 2: logrus.JSONFormatter outputs the timestamp under logrus.FieldKeyTime by default
	{
		var buf bytes.Buffer
		logger := logrus.New()
		logger.SetOutput(&buf)
		logger.SetFormatter(&logrus.JSONFormatter{})

		logger.Info("default json log message")

		var data map[string]interface{}
		if err := json.Unmarshal(buf.Bytes(), &data); err != nil {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: invalid JSON output: %v\n", err)
			os.Exit(1)
		}

		val, ok := data[logrus.FieldKeyTime]
		if !ok {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: expected key %q to be present in output\n", logrus.FieldKeyTime)
			os.Exit(1)
		}
		timeStr, ok := val.(string)
		if !ok || timeStr == "" {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: expected non-empty string timestamp for key %q, got %v\n", logrus.FieldKeyTime, val)
			os.Exit(1)
		}
	}

	// Assertion 3: logrus.JSONFormatter customizes the timestamp key using FieldMap with logrus.FieldKeyTime
	{
		var buf bytes.Buffer
		logger := logrus.New()
		logger.SetOutput(&buf)
		customKey := "@timestamp"
		logger.SetFormatter(&logrus.JSONFormatter{
			FieldMap: logrus.FieldMap{
				logrus.FieldKeyTime: customKey,
			},
		})

		logger.Info("custom key json log message")

		var data map[string]interface{}
		if err := json.Unmarshal(buf.Bytes(), &data); err != nil {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: invalid JSON output: %v\n", err)
			os.Exit(1)
		}

		if _, exists := data[logrus.FieldKeyTime]; exists {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: default key %q should have been replaced\n", logrus.FieldKeyTime)
			os.Exit(1)
		}

		val, ok := data[customKey]
		if !ok {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: expected custom key %q to be present\n", customKey)
			os.Exit(1)
		}
		timeStr, ok := val.(string)
		if !ok || timeStr == "" {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: expected non-empty string timestamp for custom key %q, got %v\n", customKey, val)
			os.Exit(1)
		}
	}

	// Assertion 4: logrus.TextFormatter customizes the timestamp key using FieldMap with logrus.FieldKeyTime
	{
		var buf bytes.Buffer
		logger := logrus.New()
		logger.SetOutput(&buf)
		customKey := "timestamp"
		logger.SetFormatter(&logrus.TextFormatter{
			DisableColors: true,
			FieldMap: logrus.FieldMap{
				logrus.FieldKeyTime: customKey,
			},
		})

		logger.Info("custom text message")

		output := buf.String()
		expectedPrefix := fmt.Sprintf("%s=", customKey)
		defaultPrefix := fmt.Sprintf("%s=", logrus.FieldKeyTime)

		if !strings.Contains(output, expectedPrefix) {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: expected output to contain %q, got %q\n", expectedPrefix, output)
			os.Exit(1)
		}
		if strings.Contains(output, defaultPrefix) {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: output should not contain default key %q, got %q\n", defaultPrefix, output)
			os.Exit(1)
		}
	}

	fmt.Println("All contract assertions passed successfully.")
}