OTL-3623 Deprecate script receiver

.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. Please use native OTel Collector receivers instead, such as the hostmetricsreceiver for system metrics.
+
+# 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,94 @@
+# Scripted Inputs Receiver Deprecation
+
+The Scripted Inputs Receiver 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.
+
+### Recommended Replacements
+
+For system metrics collection, we recommend using the [Host Metrics Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver), which provides comprehensive system monitoring capabilities.
+
+#### Migration Mapping
+
+Below is a mapping of scripted input scripts to their recommended OTel Collector receiver alternatives:
+
+| Scripted Input | Recommended Receiver | Notes |
+|----------------|---------------------|--------|
+| `cpu`, `iostat`, `vmstat` | [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) | Use CPU, disk, memory, and process scrapers |
+| `df` | [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) | Use filesystem scraper |
+| `netstat`, `bandwidth`, `interfaces`, `protocol` | [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) | Use network scraper |
+| `nfsiostat` | [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) | Use NFS scraper |
+| `ps`, `top`, `lsof` | [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) | Use process scraper |
+| `package`, `service`, `version`, `hardware` | [filelogreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) | For log-based data collection |
+| `lastlog`, `who`, `passwd`, `usersWithLoginPrivs` | [filelogreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) | Monitor system log files |
+| `rlog` | [filelogreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) | Monitor `/var/log/audit/audit.log` |
+| `openPorts`, `openPortsEnhanced` | [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) | Use network scraper or custom monitoring solution |
+| `selinuxChecker`, `sshdChecker`, `vsftpdChecker` | [filelogreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) | Monitor configuration files |
+| `time`, `uptime` | [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) or [ntpreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/ntpreceiver) | For uptime and time sync monitoring |
+| `update` | Custom monitoring solution | No direct receiver replacement available for package updates |
+
+### Example: Migrating from df script to Host Metrics Receiver
+
+**Before (Scripted Inputs):**
+```yaml
+receivers:
+  scripted_inputs/df:
+    script_name: df
+    collection_interval: 10s
+    source: df
+    sourcetype: df
+
+service:
+  pipelines:
+    logs:
+      receivers: [scripted_inputs/df]
+      processors: [memory_limiter, batch]
+      exporters: [splunk_hec]
+```
+
+**After (Host Metrics Receiver):**
+```yaml
+receivers:
+  hostmetrics:
+    collection_interval: 10s
+    scrapers:
+      filesystem:
+        metrics:
+          system.filesystem.usage:
+            enabled: true
+          system.filesystem.utilization:
+            enabled: true
+
+processors:
+  resource:
+    attributes:
+      - key: com.splunk.source
+        value: hostmetrics
+        action: upsert
+      - key: com.splunk.sourcetype
+        value: otel
+        action: upsert
+
+service:
+  pipelines:
+    metrics:
+      receivers: [hostmetrics]
+      processors: [resource, memory_limiter, batch]
+      exporters: [splunk_hec]
+```
+
+### Additional Resources
+
+- [Host Metrics Receiver Documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver)
+- [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,17 @@
 # Scripted Inputs Receiver
 
+> **⚠️ DEPRECATION NOTICE**: This receiver is deprecated and will be removed in a future release. 
+> Please use native OTel Collector receivers instead, such as the 
+> [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) 
+> for system metrics.
+
 <!-- 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()