diff --git a/CHANGELOG.md b/CHANGELOG.md index 2ca9c8e8e..0b1fe9f74 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm - Drop support for [Go 1.22]. (#6381, #6418) - Remove `Resource` field from `EnabledParameters` in `go.opentelemetry.io/otel/sdk/log`. (#6494) +- Remove `RecordFactory` type from `go.opentelemetry.io/otel/log/logtest`. (#6492) ### Changed diff --git a/log/logtest/factory.go b/log/logtest/factory.go deleted file mode 100644 index 0c3b389c3..000000000 --- a/log/logtest/factory.go +++ /dev/null @@ -1,38 +0,0 @@ -// Copyright The OpenTelemetry Authors -// SPDX-License-Identifier: Apache-2.0 - -package logtest // import "go.opentelemetry.io/otel/log/logtest" - -import ( - "time" - - "go.opentelemetry.io/otel/log" -) - -// RecordFactory is used to facilitate unit testing bridge implementations that -// make use of a [go.opentelemetry.io/otel/log.Record] -// -// Do not use RecordFactory to create records in production code. -type RecordFactory struct { - EventName string - Timestamp time.Time - ObservedTimestamp time.Time - Severity log.Severity - SeverityText string - Body log.Value - Attributes []log.KeyValue -} - -// NewRecord returns a log record. -func (b RecordFactory) NewRecord() log.Record { - var record log.Record - record.SetEventName(b.EventName) - record.SetTimestamp(b.Timestamp) - record.SetObservedTimestamp(b.ObservedTimestamp) - record.SetSeverity(b.Severity) - record.SetSeverityText(b.SeverityText) - record.SetBody(b.Body) - record.AddAttributes(b.Attributes...) - - return record -} diff --git a/log/logtest/factory_test.go b/log/logtest/factory_test.go deleted file mode 100644 index 084c31bc2..000000000 --- a/log/logtest/factory_test.go +++ /dev/null @@ -1,70 +0,0 @@ -// Copyright The OpenTelemetry Authors -// SPDX-License-Identifier: Apache-2.0 - -package logtest - -import ( - "testing" - "time" - - "github.com/stretchr/testify/assert" - - "go.opentelemetry.io/otel/log" -) - -func TestRecordFactory(t *testing.T) { - now := time.Now() - observed := now.Add(time.Second) - evnt := "my_event" - severity := log.SeverityDebug - severityText := "DBG" - body := log.StringValue("Message") - attrs := []log.KeyValue{ - log.Int("int", 1), - log.String("str", "foo"), - log.Float64("flt", 3.14), - } - - got := RecordFactory{ - EventName: evnt, - Timestamp: now, - ObservedTimestamp: observed, - Severity: severity, - SeverityText: severityText, - Body: body, - Attributes: attrs, - }.NewRecord() - - assert.Equal(t, evnt, got.EventName()) - assert.Equal(t, now, got.Timestamp()) - assert.Equal(t, observed, got.ObservedTimestamp()) - assert.Equal(t, severity, got.Severity()) - assert.Equal(t, severityText, got.SeverityText()) - assertBody(t, body, got) - assertAttributes(t, attrs, got) -} - -func TestRecordFactoryMultiple(t *testing.T) { - now := time.Now() - attrs := []log.KeyValue{ - log.Int("int", 1), - log.String("str", "foo"), - log.Float64("flt", 3.14), - } - - f := RecordFactory{ - Timestamp: now, - Attributes: attrs, - } - - record1 := f.NewRecord() - f.Attributes = append(f.Attributes, log.Bool("added", true)) - - record2 := f.NewRecord() - assert.Equal(t, now, record2.Timestamp()) - assertAttributes(t, append(attrs, log.Bool("added", true)), record2) - - // Previously returned record is unharmed by the builder changes. - assert.Equal(t, now, record1.Timestamp()) - assertAttributes(t, attrs, record1) -}