Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[receiver/jmx] mark receiver as deprecated #9063

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- `datadogexporter`: Deprecate `service` setting in favor of `service.name` semantic convention (#8784)
- `datadogexporter`: Deprecate `version` setting in favor of `service.version` semantic convention (#8784)
- `datadogexporter`: Deprecate `GetHostTags` method from `TagsConfig` struct (#8975)
- `jmxreceiver`: Deprecate JMX receiver (#9063)

### 🚀 New components 🚀

Expand Down
5 changes: 4 additions & 1 deletion receiver/jmxreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# JMX Receiver
# Deprecated JMX Receiver

This receiver has been deprecated due to security concerns around the ability to specify the execution of
any arbitrary processes via its configuration. See [#6750](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/6750) for additional details.

### Overview

Expand Down
11 changes: 11 additions & 0 deletions receiver/jmxreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,23 @@ package jmxreceiver // import "github.com/open-telemetry/opentelemetry-collector

import (
"context"
"sync"
"time"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/config"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/exporter/exporterhelper"
"go.uber.org/zap"
)

const (
typeStr = "jmx"
otlpEndpoint = "0.0.0.0:0"
)

var once sync.Once

func NewFactory() component.ReceiverFactory {
return component.NewReceiverFactory(
typeStr,
Expand All @@ -51,12 +55,19 @@ func createDefaultConfig() config.Receiver {
}
}

func logDeprecation(logger *zap.Logger) {
once.Do(func() {
logger.Warn("jmx receiver is deprecated and will be removed in future versions.")
})
}

func createReceiver(
_ context.Context,
params component.ReceiverCreateSettings,
cfg config.Receiver,
consumer consumer.Metrics,
) (component.MetricsReceiver, error) {
logDeprecation(params.Logger)
jmxConfig := cfg.(*Config)
if err := jmxConfig.validate(); err != nil {
return nil, err
Expand Down