[chore] Deprecate unnecessary fileconsumer API (#23281)

* [chore] Deprecate unnecessary fileconsumer API * Add deprecation version and tentative removal version
open-telemetry · Jun 13, 2023 · 375da69 · 375da69
1 parent 6ac5285
commit 375da69
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/pkg/stanza/fileconsumer/finder.go b/pkg/stanza/fileconsumer/finder.go
@@ -13,6 +13,8 @@ type Finder struct {
 }
 
 // FindFiles gets a list of paths given an array of glob patterns to include and exclude
+//
+// Deprecated: [v0.80.0] This will be made internal in a future release, tentatively v0.82.0.
 func (f Finder) FindFiles() []string {
 	all := make([]string, 0, len(f.Include))
 	for _, include := range f.Include {

diff --git a/pkg/stanza/fileconsumer/fingerprint.go b/pkg/stanza/fileconsumer/fingerprint.go
@@ -11,16 +11,23 @@ import (
 	"os"
 )
 
+// Deprecated: [v0.80.0] This will be made internal in a future release, tentatively v0.82.0.
 const DefaultFingerprintSize = 1000 // bytes
-const MinFingerprintSize = 16       // bytes
+
+// Deprecated: [v0.80.0] This will be made internal in a future release, tentatively v0.82.0.
+const MinFingerprintSize = 16 // bytes
 
 // Fingerprint is used to identify a file
 // A file's fingerprint is the first N bytes of the file
+//
+// Deprecated: [v0.80.0] This will be made internal in a future release, tentatively v0.82.0.
 type Fingerprint struct {
 	FirstBytes []byte
 }
 
 // NewFingerprint creates a new fingerprint from an open file
+//
+// Deprecated: [v0.80.0] This will be made internal in a future release, tentatively v0.82.0.
 func NewFingerprint(file *os.File, size int) (*Fingerprint, error) {
 	buf := make([]byte, size)
 

diff --git a/pkg/stanza/fileconsumer/reader.go b/pkg/stanza/fileconsumer/reader.go
@@ -23,6 +23,8 @@ type readerConfig struct {
 }
 
 // Reader manages a single file
+//
+// Deprecated: [v0.80.0] This will be made internal in a future release, tentatively v0.82.0.
 type Reader struct {
 	*zap.SugaredLogger `json:"-"` // json tag excludes embedded fields from storage
 	*readerConfig

diff --git a/pkg/stanza/fileconsumer/scanner.go b/pkg/stanza/fileconsumer/scanner.go
@@ -14,12 +14,16 @@ import (
 const defaultBufSize = 16 * 1024
 
 // PositionalScanner is a scanner that maintains position
+//
+// Deprecated: [v0.80.0] This will be made internal in a future release, tentatively v0.82.0.
 type PositionalScanner struct {
 	pos int64
 	*bufio.Scanner
 }
 
 // NewPositionalScanner creates a new positional scanner
+//
+// Deprecated: [v0.80.0] This will be made internal in a future release, tentatively v0.82.0.
 func NewPositionalScanner(r io.Reader, maxLogSize int, startOffset int64, splitFunc bufio.SplitFunc) *PositionalScanner {
 	ps := &PositionalScanner{
 		pos:     startOffset,