Deprecate genericjmx and all downstream monitors (#5539)

Co-authored-by: Paulo Janotti <[email protected]>
signalfx · Dec 12, 2024 · cca5c0d · cca5c0d
1 parent 60befdb
commit cca5c0d
Show file tree

Hide file tree

Showing 13 changed files with 34 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,18 @@
 
 ## Unreleased
 
+### 🚩Deprecations 🚩
+
+- (Splunk) Deprecate the collectd/genericjmx monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+- (Splunk) Deprecate the collectd/activemq monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the activemq target system instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+- (Splunk) Deprecate the collectd/cassandra monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the cassandra target system instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+- (Splunk) Deprecate the collectd/hadoop monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the hadoop target system instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+- (Splunk) Deprecate the collectd/kafka monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the kafka target system instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+- (Splunk) Deprecate the collectd/kafka-consumer monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the kafka-consumer target system instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+- (Splunk) Deprecate the collectd/kafka-producer monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the kafka-producer target system instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+- (Splunk) Deprecate the collectd/solr monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the solr target system instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+- (Splunk) Deprecate the collectd/tomcat monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the tomcat target system instead. ([#5539](https://github.com/signalfx/splunk-otel-collector/pull/5539))
+
 ## v0.114.0
 
 ### 💡 Enhancements 💡

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/activemq/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/activemq/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/activemq monitor is deprecated. Use the jmxreceiver with the activemq target system instead.**
+
     SignalFx's integration with ActiveMQ wraps the [Collectd GenericJMX
     monitor](https://docs.splunk.com/observability/gdi/genericjmx/genericjmx.html)
     to monitor ActiveMQ.

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/cassandra/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/cassandra/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/cassandra monitor is deprecated. Use the jmxreceiver with the cassandra target system instead.**
+    
     Monitors Cassandra using the Collectd GenericJMX plugin.  This is
     essentially a wrapper around the
     [collectd-genericjmx](./collectd-genericjmx.md)[](sfx_link:java) monitor that comes with a

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/genericjmx/genericjmx.go b/internal/signalfx-agent/pkg/monitors/collectd/genericjmx/genericjmx.go
@@ -102,5 +102,5 @@ func (m *JMXMonitorCore) Configure(conf *Config) error {
 		conf.ServiceName = m.defaultServiceName
 	}
 
-	return m.SetConfigurationAndRun(conf)
+	return m.SetConfigurationAndRun(conf, collectd.WithDeprecationWarningLog("jmxreceiver"))
 }
diff --git a/internal/signalfx-agent/pkg/monitors/collectd/genericjmx/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/genericjmx/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/genericjmx monitor is deprecated. Use the jmxreceiver instead.**
+
     Monitors Java services that expose metrics on JMX using collectd's
     GenericJMX plugin. The GenericJMX plugin reads Managed Beans (MBeans) from
     an MBeanServer using JMX. The monitor uses an embedded Java runtime in

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/hadoop/hadoop.go b/internal/signalfx-agent/pkg/monitors/collectd/hadoop/hadoop.go
@@ -62,6 +62,7 @@ func (m *Monitor) Configure(conf *Config) error {
 			"Verbose":             conf.Verbose,
 		},
 	}
+	m.Logger().Warn("[NOTICE] the collectd/hadoop monitor is deprecated. Use the jmxreceiver instead")
 
 	return m.PyMonitor.Configure(conf)
 }
diff --git a/internal/signalfx-agent/pkg/monitors/collectd/hadoop/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/hadoop/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/hadoop monitor is deprecated. Use the jmxreceiver with the hadoop target system instead.**
+
     Collects metrics about a Hadoop 2.0+ cluster using the [collectd Hadoop Python
     plugin](https://github.com/signalfx/collectd-hadoop). If a remote JMX port
     is exposed in the hadoop cluster, then you may also configure the

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/hadoopjmx/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/hadoopjmx/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/hadoopjmx monitor is deprecated. Use the jmxreceiver with the hadoop target system instead.**
+
     Collects metrics about a Hadoop 2.0+ cluster using using collectd's GenericJMX
     plugin. You may also configure the
     [collectd/hadoop](https://github.com/signalfx/signalfx-agent/tree/main/docs/monitors/collectd-hadoop.md)

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/kafka/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/kafka/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/kafka monitor is deprecated. Use the jmxreceiver with the kafka target system instead.**
+
     Monitors a Kafka instance using collectd's
     GenericJMX plugin. See the [collectd/genericjmx
     monitor](./collectd-genericjmx.md)[](sfx_link:java) for more information on

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/kafkaconsumer/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/kafkaconsumer/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/kafkaconsumer monitor is deprecated. Use the jmxreceiver with the kafka-consumer target system instead.**
+
     Monitors a Java based Kafka consumer using [collectd's GenericJMX plugin](./collectd-genericjmx.md)[](sfx_link:java).
 
     This monitor has a set of [built in MBeans

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/kafkaproducer/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/kafkaproducer/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/kafkaproducer monitor is deprecated. Use the jmxreceiver with the kafka-producer target system instead.**
+
     Monitors a Java based Kafka producer using GenericJMX.
 
     This monitor has a set of [built in MBeans

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/solr/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/solr/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/solr monitor is deprecated. Use the jmxreceiver with the solr target system instead.**
+
     Monitors Solr instances by using the [collectd Solr
     plugin](https://github.com/signalfx/collectd-solr).  Supports Solr 6.6 and
     later.

diff --git a/internal/signalfx-agent/pkg/monitors/collectd/tomcat/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/tomcat/metadata.yaml
@@ -1,6 +1,8 @@
 monitors:
 - dimensions:
   doc: |
+    **The collectd/tomcat monitor is deprecated. Use the jmxreceiver with the tomcat target system instead.**
+
     Monitors Tomcat using the Collectd GenericJMX plugin. This is essentially a wrapper around 
     the [collectd-genericjmx](./collectd-genericjmx.md)[](sfx_link:java) monitor that comes with 
     a set of predefined MBean definitions that a standard Tomcat deployment will expose.