From 8a5d49cada58844b766bd3f27c009e0cee6008df Mon Sep 17 00:00:00 2001 From: Bogdan Drutu Date: Wed, 2 Jun 2021 07:39:53 -0700 Subject: [PATCH] Avoid exposing internal implementation public in OC/OTEL receivers Signed-off-by: Bogdan Drutu --- .golangci.yml | 2 +- .../opencensusreceiver/{ => internal}/ocmetrics/doc.go | 0 .../{ => internal}/ocmetrics/opencensus.go | 0 .../{ => internal}/ocmetrics/opencensus_test.go | 0 .../opencensusreceiver/{ => internal}/octrace/doc.go | 0 .../{ => internal}/octrace/observability_test.go | 0 .../{ => internal}/octrace/opencensus.go | 0 .../{ => internal}/octrace/opencensus_test.go | 0 receiver/opencensusreceiver/opencensus.go | 4 ++-- receiver/otlpreceiver/{ => internal}/logs/otlp.go | 0 receiver/otlpreceiver/{ => internal}/logs/otlp_test.go | 0 receiver/otlpreceiver/{ => internal}/marshal_jsonpb.go | 2 +- .../otlpreceiver/{ => internal}/marshal_jsonpb_test.go | 2 +- receiver/otlpreceiver/{ => internal}/metrics/otlp.go | 0 .../otlpreceiver/{ => internal}/metrics/otlp_test.go | 0 receiver/otlpreceiver/{ => internal}/trace/otlp.go | 0 receiver/otlpreceiver/{ => internal}/trace/otlp_test.go | 0 receiver/otlpreceiver/otlp.go | 9 +++++---- 18 files changed, 10 insertions(+), 9 deletions(-) rename receiver/opencensusreceiver/{ => internal}/ocmetrics/doc.go (100%) rename receiver/opencensusreceiver/{ => internal}/ocmetrics/opencensus.go (100%) rename receiver/opencensusreceiver/{ => internal}/ocmetrics/opencensus_test.go (100%) rename receiver/opencensusreceiver/{ => internal}/octrace/doc.go (100%) rename receiver/opencensusreceiver/{ => internal}/octrace/observability_test.go (100%) rename receiver/opencensusreceiver/{ => internal}/octrace/opencensus.go (100%) rename receiver/opencensusreceiver/{ => internal}/octrace/opencensus_test.go (100%) rename receiver/otlpreceiver/{ => internal}/logs/otlp.go (100%) rename receiver/otlpreceiver/{ => internal}/logs/otlp_test.go (100%) rename receiver/otlpreceiver/{ => internal}/marshal_jsonpb.go (99%) rename receiver/otlpreceiver/{ => internal}/marshal_jsonpb_test.go (99%) rename receiver/otlpreceiver/{ => internal}/metrics/otlp.go (100%) rename receiver/otlpreceiver/{ => internal}/metrics/otlp_test.go (100%) rename receiver/otlpreceiver/{ => internal}/trace/otlp.go (100%) rename receiver/otlpreceiver/{ => internal}/trace/otlp_test.go (100%) diff --git a/.golangci.yml b/.golangci.yml index d6292a25265..155eb2e08ad 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -119,7 +119,7 @@ issues: linters: # See https://github.com/golangci/golangci-lint/issues/537#issuecomment-545170007 - structcheck - - path: receiver/otlpreceiver/marshal_jsonpb\.go + - path: receiver/otlpreceiver/internal/marshal_jsonpb\.go linters: - gocritic - gosimple diff --git a/receiver/opencensusreceiver/ocmetrics/doc.go b/receiver/opencensusreceiver/internal/ocmetrics/doc.go similarity index 100% rename from receiver/opencensusreceiver/ocmetrics/doc.go rename to receiver/opencensusreceiver/internal/ocmetrics/doc.go diff --git a/receiver/opencensusreceiver/ocmetrics/opencensus.go b/receiver/opencensusreceiver/internal/ocmetrics/opencensus.go similarity index 100% rename from receiver/opencensusreceiver/ocmetrics/opencensus.go rename to receiver/opencensusreceiver/internal/ocmetrics/opencensus.go diff --git a/receiver/opencensusreceiver/ocmetrics/opencensus_test.go b/receiver/opencensusreceiver/internal/ocmetrics/opencensus_test.go similarity index 100% rename from receiver/opencensusreceiver/ocmetrics/opencensus_test.go rename to receiver/opencensusreceiver/internal/ocmetrics/opencensus_test.go diff --git a/receiver/opencensusreceiver/octrace/doc.go b/receiver/opencensusreceiver/internal/octrace/doc.go similarity index 100% rename from receiver/opencensusreceiver/octrace/doc.go rename to receiver/opencensusreceiver/internal/octrace/doc.go diff --git a/receiver/opencensusreceiver/octrace/observability_test.go b/receiver/opencensusreceiver/internal/octrace/observability_test.go similarity index 100% rename from receiver/opencensusreceiver/octrace/observability_test.go rename to receiver/opencensusreceiver/internal/octrace/observability_test.go diff --git a/receiver/opencensusreceiver/octrace/opencensus.go b/receiver/opencensusreceiver/internal/octrace/opencensus.go similarity index 100% rename from receiver/opencensusreceiver/octrace/opencensus.go rename to receiver/opencensusreceiver/internal/octrace/opencensus.go diff --git a/receiver/opencensusreceiver/octrace/opencensus_test.go b/receiver/opencensusreceiver/internal/octrace/opencensus_test.go similarity index 100% rename from receiver/opencensusreceiver/octrace/opencensus_test.go rename to receiver/opencensusreceiver/internal/octrace/opencensus_test.go diff --git a/receiver/opencensusreceiver/opencensus.go b/receiver/opencensusreceiver/opencensus.go index e875cce70d7..3b4dc4c38c0 100644 --- a/receiver/opencensusreceiver/opencensus.go +++ b/receiver/opencensusreceiver/opencensus.go @@ -33,8 +33,8 @@ import ( "go.opentelemetry.io/collector/config" "go.opentelemetry.io/collector/config/configgrpc" "go.opentelemetry.io/collector/consumer" - "go.opentelemetry.io/collector/receiver/opencensusreceiver/ocmetrics" - "go.opentelemetry.io/collector/receiver/opencensusreceiver/octrace" + "go.opentelemetry.io/collector/receiver/opencensusreceiver/internal/ocmetrics" + "go.opentelemetry.io/collector/receiver/opencensusreceiver/internal/octrace" ) // ocReceiver is the type that exposes Trace and Metrics reception. diff --git a/receiver/otlpreceiver/logs/otlp.go b/receiver/otlpreceiver/internal/logs/otlp.go similarity index 100% rename from receiver/otlpreceiver/logs/otlp.go rename to receiver/otlpreceiver/internal/logs/otlp.go diff --git a/receiver/otlpreceiver/logs/otlp_test.go b/receiver/otlpreceiver/internal/logs/otlp_test.go similarity index 100% rename from receiver/otlpreceiver/logs/otlp_test.go rename to receiver/otlpreceiver/internal/logs/otlp_test.go diff --git a/receiver/otlpreceiver/marshal_jsonpb.go b/receiver/otlpreceiver/internal/marshal_jsonpb.go similarity index 99% rename from receiver/otlpreceiver/marshal_jsonpb.go rename to receiver/otlpreceiver/internal/marshal_jsonpb.go index ab452e8c982..e0ab286fbf6 100644 --- a/receiver/otlpreceiver/marshal_jsonpb.go +++ b/receiver/otlpreceiver/internal/marshal_jsonpb.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package otlpreceiver +package internal import ( "bytes" diff --git a/receiver/otlpreceiver/marshal_jsonpb_test.go b/receiver/otlpreceiver/internal/marshal_jsonpb_test.go similarity index 99% rename from receiver/otlpreceiver/marshal_jsonpb_test.go rename to receiver/otlpreceiver/internal/marshal_jsonpb_test.go index 6126b24fd0f..6e57754c3af 100644 --- a/receiver/otlpreceiver/marshal_jsonpb_test.go +++ b/receiver/otlpreceiver/internal/marshal_jsonpb_test.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package otlpreceiver +package internal import ( "testing" diff --git a/receiver/otlpreceiver/metrics/otlp.go b/receiver/otlpreceiver/internal/metrics/otlp.go similarity index 100% rename from receiver/otlpreceiver/metrics/otlp.go rename to receiver/otlpreceiver/internal/metrics/otlp.go diff --git a/receiver/otlpreceiver/metrics/otlp_test.go b/receiver/otlpreceiver/internal/metrics/otlp_test.go similarity index 100% rename from receiver/otlpreceiver/metrics/otlp_test.go rename to receiver/otlpreceiver/internal/metrics/otlp_test.go diff --git a/receiver/otlpreceiver/trace/otlp.go b/receiver/otlpreceiver/internal/trace/otlp.go similarity index 100% rename from receiver/otlpreceiver/trace/otlp.go rename to receiver/otlpreceiver/internal/trace/otlp.go diff --git a/receiver/otlpreceiver/trace/otlp_test.go b/receiver/otlpreceiver/internal/trace/otlp_test.go similarity index 100% rename from receiver/otlpreceiver/trace/otlp_test.go rename to receiver/otlpreceiver/internal/trace/otlp_test.go diff --git a/receiver/otlpreceiver/otlp.go b/receiver/otlpreceiver/otlp.go index 52e9507439f..51b851a70eb 100644 --- a/receiver/otlpreceiver/otlp.go +++ b/receiver/otlpreceiver/otlp.go @@ -32,9 +32,10 @@ import ( collectorlog "go.opentelemetry.io/collector/internal/data/protogen/collector/logs/v1" collectormetrics "go.opentelemetry.io/collector/internal/data/protogen/collector/metrics/v1" collectortrace "go.opentelemetry.io/collector/internal/data/protogen/collector/trace/v1" - "go.opentelemetry.io/collector/receiver/otlpreceiver/logs" - "go.opentelemetry.io/collector/receiver/otlpreceiver/metrics" - "go.opentelemetry.io/collector/receiver/otlpreceiver/trace" + "go.opentelemetry.io/collector/receiver/otlpreceiver/internal" + "go.opentelemetry.io/collector/receiver/otlpreceiver/internal/logs" + "go.opentelemetry.io/collector/receiver/otlpreceiver/internal/metrics" + "go.opentelemetry.io/collector/receiver/otlpreceiver/internal/trace" ) // otlpReceiver is the type that exposes Trace and Metrics reception. @@ -64,7 +65,7 @@ func newOtlpReceiver(cfg *Config, logger *zap.Logger) *otlpReceiver { // Use our custom JSON marshaler instead of default Protobuf JSON marshaler. // This is needed because OTLP spec defines encoding for trace and span id // and it is only possible to do using Gogoproto-compatible JSONPb marshaler. - jsonpb := &JSONPb{ + jsonpb := &internal.JSONPb{ EmitDefaults: true, Indent: " ", OrigName: true,