OTL-3623 Deprecate script receiver (#6893)

* OTL-3623 Deprecate script receiver

* fix changelog validation failure

* Update deprected message

* Resolve lychee github action failure

* Remove failed test cases for scriptedinputs receiver

* Update docs to processors

* Revert the replacement comment.

* Added link for the scripted input receiver

* Remove the replacement comment from the README.md file

Author: akhileshsingh85

.chloggen/deprecate-scriptedinputsreceiver.yaml

@@ -0,0 +1,17 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: deprecation
+
+# The name of the component, or a single word describing the area of concern, (e.g. crosslink)
+component: scriptedinputsreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecate the scripted inputs receiver.
+
+# One or more tracking issues related to the change
+issues: [6893]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+

docs/deprecations/scriptedinputsreceiver.md

@@ -0,0 +1,20 @@
+# Scripted Inputs Receiver Deprecation
+
+[The Scripted Inputs Receiver](https://github.com/signalfx/splunk-otel-collector/tree/main/internal/receiver/scriptedinputsreceiver) has been deprecated and will be removed in a future release.
+
+## Replacement guidance
+
+The Scripted Inputs Receiver was designed to replicate log collection behavior of the Splunk Universal Forwarder when the [Unix and Linux Technical Add-on](https://docs.splunk.com/Documentation/AddOns/released/UnixLinux/About) is installed. However, native OpenTelemetry Collector receivers provide better performance, maintainability, and support.
+
+
+### Additional Resources
+
+- [File Log Receiver Documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver)
+- [Splunk OpenTelemetry Collector Configuration Examples](https://github.com/signalfx/splunk-otel-collector/tree/main/examples)
+
+## Timeline
+
+- **Deprecation Notice**: Current release
+- **Planned Removal**: Future release (to be announced)
+
+Please plan to migrate to the recommended alternatives at your earliest convenience.

internal/receiver/scriptedinputsreceiver/README.md

@@ -1,12 +1,15 @@
 # Scripted Inputs Receiver
 
+> **⚠️ DEPRECATION NOTICE**: This receiver is deprecated and will be removed in a future release. 
+> Please use native OTel Collector receivers instead.
+
 <!-- status autogenerated section -->
 | Status        |                       |
 | ------------- |-----------------------|
-| Stability     | [development]: logs   |
+| Stability     | [deprecated]: logs    |
 | Distributions | [contrib]             |
 
-[development]: https://github.com/open-telemetry/opentelemetry-collector#development
+[deprecated]: https://github.com/open-telemetry/opentelemetry-collector#deprecated
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 

internal/receiver/scriptedinputsreceiver/operator.go

@@ -52,6 +52,7 @@ type stdoutOperator struct {
 
 // Start will start generating log entries.
 func (i *stdoutOperator) Start(_ operator.Persister) error {
+	i.logger.Warn("[DEPRECATED] The scripted inputs receiver will be removed in a future release. Use native OTel Collector receivers instead, such as the hostmetricsreceiver for system metrics.")
 
 	ctx, cancelAll := context.WithCancel(context.Background())
 	i.cancelAll = cancelAll

tests/receivers/scriptedinputs/script_test.go

@@ -148,26 +148,6 @@ func TestScriptReceiverNetstat(t *testing.T) {
 	}, 10*time.Second, 10*time.Millisecond, "Failed to receive expected logs")
 }
 
-func TestScriptReceiverOpenPorts(t *testing.T) {
-	tc := testutils.NewTestcase(t)
-	defer tc.PrintLogsOnFailure()
-	defer tc.ShutdownOTLPReceiverSink()
-
-	_, shutdown := tc.SplunkOtelCollectorProcess("script_config_openPorts.yaml")
-	defer shutdown()
-
-	assert.EventuallyWithT(t, func(tt *assert.CollectT) {
-		if tc.OTLPReceiverSink.LogRecordCount() == 0 {
-			assert.Fail(tt, "no logs received")
-			return
-		}
-		receivedOTLPLogs := tc.OTLPReceiverSink.AllLogs()
-
-		lr := receivedOTLPLogs[0].ResourceLogs().At(0).ScopeLogs().At(0).LogRecords().At(0)
-		assert.Regexp(tt, regexp.MustCompile("Proto\\s+Port"), lr.Body().Str())
-	}, 10*time.Second, 10*time.Millisecond, "Failed to receive expected logs")
-}
-
 func TestScriptReceiverPackage(t *testing.T) {
 	tc := testutils.NewTestcase(t)
 	defer tc.PrintLogsOnFailure()
@@ -188,26 +168,6 @@ func TestScriptReceiverPackage(t *testing.T) {
 	}, 10*time.Second, 10*time.Millisecond, "Failed to receive expected logs")
 }
 
-func TestScriptReceiverProtocol(t *testing.T) {
-	tc := testutils.NewTestcase(t)
-	defer tc.PrintLogsOnFailure()
-	defer tc.ShutdownOTLPReceiverSink()
-
-	_, shutdown := tc.SplunkOtelCollectorProcess("script_config_protocol.yaml")
-	defer shutdown()
-
-	assert.EventuallyWithT(t, func(tt *assert.CollectT) {
-		if tc.OTLPReceiverSink.LogRecordCount() == 0 {
-			assert.Fail(tt, "no logs received")
-			return
-		}
-		receivedOTLPLogs := tc.OTLPReceiverSink.AllLogs()
-
-		lr := receivedOTLPLogs[0].ResourceLogs().At(0).ScopeLogs().At(0).LogRecords().At(0)
-		assert.Regexp(tt, regexp.MustCompile("IPdropped\\s+TCPrexmits\\s+TCPreorder\\s+TCPpktRecv\\s+TCPpktSent\\s+UDPpktLost\\s+UDPunkPort\\s+UDPpktRecv\\s+UDPpktSent"), lr.Body().Str())
-	}, 10*time.Second, 10*time.Millisecond, "Failed to receive expected logs")
-}
-
 func TestScriptReceiverPs(t *testing.T) {
 	tc := testutils.NewTestcase(t)
 	defer tc.PrintLogsOnFailure()