From 29cf79b5123fc1a604c5779e7aff2aadfb4ae8bf Mon Sep 17 00:00:00 2001 From: Antoine Toulme Date: Tue, 22 Oct 2024 17:28:17 -0700 Subject: [PATCH] Deprecate genericjmx and all downstream monitors --- CHANGELOG.md | 9 +++++++++ .../pkg/monitors/collectd/activemq/metadata.yaml | 2 ++ .../pkg/monitors/collectd/cassandra/metadata.yaml | 2 ++ .../pkg/monitors/collectd/genericjmx/genericjmx.go | 2 +- .../pkg/monitors/collectd/genericjmx/metadata.yaml | 2 ++ .../pkg/monitors/collectd/hadoop/hadoop.go | 1 + .../pkg/monitors/collectd/hadoop/metadata.yaml | 2 ++ .../pkg/monitors/collectd/hadoopjmx/metadata.yaml | 2 ++ .../pkg/monitors/collectd/kafka/metadata.yaml | 2 ++ .../pkg/monitors/collectd/kafkaconsumer/metadata.yaml | 2 ++ .../pkg/monitors/collectd/kafkaproducer/metadata.yaml | 2 ++ .../pkg/monitors/collectd/solr/metadata.yaml | 2 ++ .../pkg/monitors/collectd/tomcat/metadata.yaml | 2 ++ 13 files changed, 31 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d460b325b2..adfa28a2a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,15 @@ - (Splunk) Deprecate collectd/mysql monitor. Use the [mysql receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/mysqlreceiver) instead. ([#5538](https://github.com/signalfx/splunk-otel-collector/pull/5538)) - (Splunk) Deprecate the collectd/nginx monitor. Please use the [nginx receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/nginxreceiver/) instead. ([#5537](https://github.com/signalfx/splunk-otel-collector/pull/5537)) - (Splunk) Deprecate the collectd/chrony monitor. Please use the [chronyreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/chronyreceiver) instead. ([#5536](https://github.com/signalfx/splunk-otel-collector/pull/5536)) +- (Splunk) Deprecate the collectd/genericjmx monitor. Please use the [jmxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) instead. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) +- (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. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) +- (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. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) +- (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. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) +- (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. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) +- (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. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) +- (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. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) +- (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. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) +- (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. ([#](https://github.com/signalfx/splunk-otel-collector/pull/)) ### 🚀 New components 🚀 diff --git a/internal/signalfx-agent/pkg/monitors/collectd/activemq/metadata.yaml b/internal/signalfx-agent/pkg/monitors/collectd/activemq/metadata.yaml index 8c9abda4bf..74327a4d28 100644 --- 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 index 72e484b7cd..313f39218a 100644 --- 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 index da04127d0b..08038a169a 100644 --- 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 index 10fae99076..a40bce0d88 100644 --- 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 index 681a860bbe..629aa36a20 100644 --- 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 index 074a6436f0..86941a0653 100644 --- 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 index 0d429cb2b3..28b491af05 100644 --- 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 index 3dbc1d31e7..a892e1340c 100644 --- 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 index 3f78bf68ab..423d7ca617 100644 --- 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 index 648739ecaf..4e76763a7f 100644 --- 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 index f3ad091c65..2d0457c515 100644 --- 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 index 5f2e201c3d..bdd7a6ae3d 100644 --- 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.