[pkg/stanza/adapter] Deprecate ConvertFrom (#17494)

Similar to Convert, the API is not being used and shouldn't be exported.
open-telemetry · Jan 10, 2023 · 481e524 · 481e524
1 parent 6138996
commit 481e524
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/pkg/stanza/adapter/converter.go b/pkg/stanza/adapter/converter.go
@@ -288,7 +288,7 @@ func convert(ent *entry.Entry) plog.LogRecord {
 // Convert converts one entry.Entry into plog.Logs.
 // To be used in a stateless setting like tests where ease of use is more
 // important than performance or throughput.
-// Deprecated: [v0.68.0] Unnecessary exported API.
+// Deprecated: [v0.68.0] Unnecessarily exported API.
 // Please add a comment in https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/17429
 // if you use it.
 func Convert(ent *entry.Entry) plog.Logs {

diff --git a/pkg/stanza/adapter/frompdataconverter.go b/pkg/stanza/adapter/frompdataconverter.go
@@ -176,6 +176,9 @@ func convertFromLogs(workerItem fromConverterWorkerItem) []*entry.Entry {
 // ConvertFrom converts plog.Logs into a slice of entry.Entry
 // To be used in a stateless setting like tests where ease of use is more
 // important than performance or throughput.
+// Deprecated: [v0.69.0] Unnecessarily exported API.
+// Please add a comment in https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/17429
+// if you use it.
 func ConvertFrom(pLogs plog.Logs) []*entry.Entry {
 	result := make([]*entry.Entry, 0, pLogs.LogRecordCount())
 	for i := 0; i < pLogs.ResourceLogs().Len(); i++ {