Skip to content

Commit

Permalink
Change to private unnecessary exported types and funcs (#1499)
Browse files Browse the repository at this point in the history
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
  • Loading branch information
bogdandrutu authored Aug 5, 2020
1 parent c79f50b commit 8589eee
Show file tree
Hide file tree
Showing 28 changed files with 178 additions and 279 deletions.
6 changes: 3 additions & 3 deletions exporter/fileexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ func createLogsExporter(
return createExporter(cfg)
}

func createExporter(config configmodels.Exporter) (*Exporter, error) {
func createExporter(config configmodels.Exporter) (*fileExporter, error) {
cfg := config.(*Config)

// There must be one exporter for metrics, traces, and logs. We maintain a
Expand All @@ -85,7 +85,7 @@ func createExporter(config configmodels.Exporter) (*Exporter, error) {
if err != nil {
return nil, err
}
exporter = &Exporter{file: file}
exporter = &fileExporter{file: file}

// Remember the receiver in the map
exporters[cfg] = exporter
Expand All @@ -97,4 +97,4 @@ func createExporter(config configmodels.Exporter) (*Exporter, error) {
// We maintain this map because the Factory is asked trace and metric receivers separately
// when it gets CreateTraceReceiver() and CreateMetricsReceiver() but they must not
// create separate objects, they must use one Receiver object per configuration.
var exporters = map[*Config]*Exporter{}
var exporters = map[*Config]*fileExporter{}
14 changes: 7 additions & 7 deletions exporter/fileexporter/file_exporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,14 @@ func exportResourceAndNode(writer *jsonWriter, node *commonpb.Node, resource *re
return nil
}

// Exporter is the implementation of file exporter that writes telemetry data to a file
// fileExporter is the implementation of file exporter that writes telemetry data to a file
// in Protobuf-JSON format.
type Exporter struct {
type fileExporter struct {
file io.WriteCloser
mutex sync.Mutex
}

func (e *Exporter) ConsumeTraces(_ context.Context, td pdata.Traces) error {
func (e *fileExporter) ConsumeTraces(_ context.Context, td pdata.Traces) error {
octds := internaldata.TraceDataToOC(td)
for _, octd := range octds {
// Ensure only one write operation happens at a time.
Expand Down Expand Up @@ -175,7 +175,7 @@ func (e *Exporter) ConsumeTraces(_ context.Context, td pdata.Traces) error {
return nil
}

func (e *Exporter) ConsumeMetrics(_ context.Context, md pdata.Metrics) error {
func (e *fileExporter) ConsumeMetrics(_ context.Context, md pdata.Metrics) error {
ocmds := pdatautil.MetricsToMetricsData(md)
for _, ocmd := range ocmds {
// Ensure only one write operation happens at a time.
Expand Down Expand Up @@ -209,7 +209,7 @@ func (e *Exporter) ConsumeMetrics(_ context.Context, md pdata.Metrics) error {
return nil
}

func (e *Exporter) ConsumeLogs(_ context.Context, ld pdata.Logs) error {
func (e *fileExporter) ConsumeLogs(_ context.Context, ld pdata.Logs) error {
// Ensure only one write operation happens at a time.
e.mutex.Lock()
defer e.mutex.Unlock()
Expand Down Expand Up @@ -249,11 +249,11 @@ func (e *Exporter) ConsumeLogs(_ context.Context, ld pdata.Logs) error {
return nil
}

func (e *Exporter) Start(ctx context.Context, host component.Host) error {
func (e *fileExporter) Start(ctx context.Context, host component.Host) error {
return nil
}

// Shutdown stops the exporter and is invoked during shutdown.
func (e *Exporter) Shutdown(context.Context) error {
func (e *fileExporter) Shutdown(context.Context) error {
return e.file.Close()
}
8 changes: 4 additions & 4 deletions exporter/fileexporter/file_exporter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import (

func TestFileTraceExporterNoErrors(t *testing.T) {
mf := &testutil.LimitedWriter{}
lte := &Exporter{file: mf}
lte := &fileExporter{file: mf}
require.NotNil(t, lte)

td := consumerdata.TraceData{
Expand Down Expand Up @@ -98,7 +98,7 @@ func TestFileTraceExporterNoErrors(t *testing.T) {

func TestFileMetricsExporterNoErrors(t *testing.T) {
mf := &testutil.LimitedWriter{}
lme := &Exporter{file: mf}
lme := &fileExporter{file: mf}
require.NotNil(t, lme)

md := pdatautil.MetricsFromMetricsData([]consumerdata.MetricsData{
Expand Down Expand Up @@ -160,7 +160,7 @@ func TestFileMetricsExporterNoErrors(t *testing.T) {

func TestFileLogsExporterNoErrors(t *testing.T) {
mf := &testutil.LimitedWriter{}
exporter := &Exporter{file: mf}
exporter := &fileExporter{file: mf}
require.NotNil(t, exporter)

now := time.Now()
Expand Down Expand Up @@ -342,7 +342,7 @@ func TestFileLogsExporterErrors(t *testing.T) {
mf := &testutil.LimitedWriter{
MaxLen: maxLen,
}
exporter := &Exporter{file: mf}
exporter := &fileExporter{file: mf}
require.NotNil(t, exporter)

assert.Error(t, exporter.ConsumeLogs(context.Background(), pdata.LogsFromOtlp(ld)))
Expand Down
18 changes: 3 additions & 15 deletions exporter/loggingexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,7 @@ func createTraceExporter(_ context.Context, _ component.ExporterCreateParams, co
return nil, err
}

lexp, err := NewTraceExporter(config, cfg.LogLevel, exporterLogger)
if err != nil {
return nil, err
}
return lexp, nil
return newTraceExporter(config, cfg.LogLevel, exporterLogger)
}

func createMetricsExporter(_ context.Context, _ component.ExporterCreateParams, config configmodels.Exporter) (component.MetricsExporter, error) {
Expand All @@ -77,11 +73,7 @@ func createMetricsExporter(_ context.Context, _ component.ExporterCreateParams,
return nil, err
}

lexp, err := NewMetricsExporter(config, cfg.LogLevel, exporterLogger)
if err != nil {
return nil, err
}
return lexp, nil
return newMetricsExporter(config, cfg.LogLevel, exporterLogger)
}

func createLogsExporter(_ context.Context, _ component.ExporterCreateParams, config configmodels.Exporter) (component.LogsExporter, error) {
Expand All @@ -92,11 +84,7 @@ func createLogsExporter(_ context.Context, _ component.ExporterCreateParams, con
return nil, err
}

lexp, err := NewLogsExporter(config, cfg.LogLevel, exporterLogger)
if err != nil {
return nil, err
}
return lexp, nil
return newLogsExporter(config, cfg.LogLevel, exporterLogger)
}

func createLogger(cfg *Config) (*zap.Logger, error) {
Expand Down
12 changes: 6 additions & 6 deletions exporter/loggingexporter/logging_exporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -360,9 +360,9 @@ func (s *loggingExporter) pushMetricsData(
return 0, nil
}

// NewTraceExporter creates an exporter.TraceExporter that just drops the
// newTraceExporter creates an exporter.TraceExporter that just drops the
// received data and logs debugging messages.
func NewTraceExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.TraceExporter, error) {
func newTraceExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.TraceExporter, error) {
s := &loggingExporter{
debug: level == "debug",
logger: logger,
Expand All @@ -379,9 +379,9 @@ func NewTraceExporter(config configmodels.Exporter, level string, logger *zap.Lo
)
}

// NewMetricsExporter creates an exporter.MetricsExporter that just drops the
// newMetricsExporter creates an exporter.MetricsExporter that just drops the
// received data and logs debugging messages.
func NewMetricsExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.MetricsExporter, error) {
func newMetricsExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.MetricsExporter, error) {
s := &loggingExporter{
debug: level == "debug",
logger: logger,
Expand All @@ -398,9 +398,9 @@ func NewMetricsExporter(config configmodels.Exporter, level string, logger *zap.
)
}

// NewLogsExporter creates an exporter.LogsExporter that just drops the
// newLogsExporter creates an exporter.LogsExporter that just drops the
// received data and logs debugging messages.
func NewLogsExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.LogsExporter, error) {
func newLogsExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.LogsExporter, error) {
s := &loggingExporter{
debug: level == "debug",
logger: logger,
Expand Down
6 changes: 3 additions & 3 deletions exporter/loggingexporter/logging_exporter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import (
)

func TestLoggingTraceExporterNoErrors(t *testing.T) {
lte, err := NewTraceExporter(&configmodels.ExporterSettings{}, "debug", zap.NewNop())
lte, err := newTraceExporter(&configmodels.ExporterSettings{}, "debug", zap.NewNop())
require.NotNil(t, lte)
assert.NoError(t, err)

Expand All @@ -41,7 +41,7 @@ func TestLoggingTraceExporterNoErrors(t *testing.T) {
}

func TestLoggingMetricsExporterNoErrors(t *testing.T) {
lme, err := NewMetricsExporter(&configmodels.ExporterSettings{}, "debug", zap.NewNop())
lme, err := newMetricsExporter(&configmodels.ExporterSettings{}, "debug", zap.NewNop())
require.NotNil(t, lme)
assert.NoError(t, err)

Expand All @@ -59,7 +59,7 @@ func TestLoggingMetricsExporterNoErrors(t *testing.T) {
}

func TestLoggingLogsExporterNoErrors(t *testing.T) {
lle, err := NewLogsExporter(&configmodels.ExporterSettings{}, "debug", zap.NewNop())
lle, err := newLogsExporter(&configmodels.ExporterSettings{}, "debug", zap.NewNop())
require.NotNil(t, lle)
assert.NoError(t, err)

Expand Down
4 changes: 2 additions & 2 deletions exporter/zipkinexporter/zipkin.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ func newTraceExporter(config *Config) (component.TraceExporter, error) {
if err != nil {
return nil, err
}
zexp, err := exporterhelper.NewTraceExporter(config, ze.PushTraceData)
zexp, err := exporterhelper.NewTraceExporter(config, ze.pushTraceData)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -83,7 +83,7 @@ func createZipkinExporter(cfg *Config) (*zipkinExporter, error) {
return ze, nil
}

func (ze *zipkinExporter) PushTraceData(ctx context.Context, td pdata.Traces) (int, error) {
func (ze *zipkinExporter) pushTraceData(ctx context.Context, td pdata.Traces) (int, error) {
numSpans := td.SpanCount()
octds := internaldata.TraceDataToOC(td)

Expand Down
File renamed without changes.
15 changes: 15 additions & 0 deletions receiver/empty_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Copyright OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package receiver
97 changes: 0 additions & 97 deletions receiver/end_to_end_test.go

This file was deleted.

2 changes: 1 addition & 1 deletion receiver/fluentforwardreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ func createLogsReceiver(
) (component.LogsReceiver, error) {

rCfg := cfg.(*Config)
return New(ctx, params.Logger, rCfg, consumer)
return newFluentReceiver(ctx, params.Logger, rCfg, consumer)
}
10 changes: 5 additions & 5 deletions receiver/fluentforwardreceiver/receiver.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import (
// FluentBit and increase throughput.
const eventChannelLength = 100

type Receiver struct {
type fluentReceiver struct {
collector *Collector
listener net.Listener
conf *Config
Expand All @@ -38,22 +38,22 @@ type Receiver struct {
cancel context.CancelFunc
}

func New(ctx context.Context, logger *zap.Logger, conf *Config, next consumer.LogsConsumer) (component.LogsReceiver, error) {
func newFluentReceiver(ctx context.Context, logger *zap.Logger, conf *Config, next consumer.LogsConsumer) (component.LogsReceiver, error) {
eventCh := make(chan Event, eventChannelLength)

collector := newCollector(eventCh, next, logger)

server := newServer(eventCh, logger)

return &Receiver{
return &fluentReceiver{
collector: collector,
server: server,
conf: conf,
logger: logger,
}, nil
}

func (r *Receiver) Start(ctx context.Context, _ component.Host) error {
func (r *fluentReceiver) Start(ctx context.Context, _ component.Host) error {
receiverCtx, cancel := context.WithCancel(ctx)
r.cancel = cancel

Expand Down Expand Up @@ -88,7 +88,7 @@ func (r *Receiver) Start(ctx context.Context, _ component.Host) error {
return nil
}

func (r *Receiver) Shutdown(ctx context.Context) error {
func (r *fluentReceiver) Shutdown(ctx context.Context) error {
r.cancel()
return nil
}
Loading

0 comments on commit 8589eee

Please sign in to comment.