Add a LightStep exporter. (#136)

Co-Authored-By: Paulo Janotti <[email protected]>

Author: austinlparker

cmd/otelcontribcol/components.go

@@ -27,6 +27,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/carbonexporter"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/honeycombexporter"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/kinesisexporter"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/lightstepexporter"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/sapmexporter"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/stackdriverexporter"
@@ -71,6 +72,7 @@ func components() (config.Factories, error) {
 		&awsxrayexporter.Factory{},
 		&carbonexporter.Factory{},
 		&honeycombexporter.Factory{},
+		&lightstepexporter.Factory{},
 	}
 	for _, exp := range factories.Exporters {
 		exporters = append(exporters, exp)

exporter/lightstepexporter/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

exporter/lightstepexporter/README.md

@@ -0,0 +1,21 @@
+# LightStep Exporter
+
+This exporter supports sending trace data to [LightStep](https://www.lightstep.com)
+
+The following configuration options are supported:
+
+* `access_token` (Required): The access token for your LightStep project.
+* `satellite_host` (Optional): Your LightStep Satellite Pool URL. Defaults to `https://ingest.lightstep.com`.
+* `satellite_port` (Optional): Your LightStep Satellite Pool Port. Defaults to `443`.
+* `service_name` (Optional): The service name for spans reported by this collector. Defaults to `opentelemetry-collector`. 
+
+Example:
+
+```yaml
+exporters:
+    lightstep:
+        access_token: "abcdef12345"
+        satellite_host: "https://my.satellite.pool.coolcat.com"
+        satellite_port: 8000
+        service_name: "myService"
+```

exporter/lightstepexporter/config.go

@@ -0,0 +1,30 @@
+// Copyright 2020 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 lightstepexporter
+
+import "github.com/open-telemetry/opentelemetry-collector/config/configmodels"
+
+// Config defines configuration options for the LightStep exporter.
+type Config struct {
+	configmodels.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
+	// AccessToken is your project access token in LightStep.
+	AccessToken string `mapstructure:"access_token"`
+	// SatelliteHost is the satellite pool URL.
+	SatelliteHost string `mapstructure:"satellite_host"`
+	// SatellitePort is the satellite pool port.
+	SatellitePort int `mapstructure:"satellite_port"`
+	// ServiceName is the LightStep service name for your spans.
+	ServiceName string `mapstructure:"service_name"`
+}

exporter/lightstepexporter/config_test.go

@@ -0,0 +1,53 @@
+// Copyright 2020 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 lightstepexporter
+
+import (
+	"path"
+	"testing"
+
+	"github.com/open-telemetry/opentelemetry-collector/config"
+	"github.com/open-telemetry/opentelemetry-collector/config/configmodels"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestLoadConfig(t *testing.T) {
+	factories, err := config.ExampleComponents()
+	assert.Nil(t, err)
+
+	factory := &Factory{}
+	factories.Exporters[typeStr] = factory
+	cfg, err := config.LoadConfigFile(
+		t, path.Join(".", "testdata", "config.yaml"), factories,
+	)
+
+	require.NoError(t, err)
+	require.NotNil(t, cfg)
+
+	assert.Equal(t, len(cfg.Exporters), 2)
+
+	r0 := cfg.Exporters["lightstep"]
+	assert.Equal(t, r0, factory.CreateDefaultConfig())
+
+	r1 := cfg.Exporters["lightstep/customname"].(*Config)
+	assert.Equal(t, r1, &Config{
+		ExporterSettings: configmodels.ExporterSettings{TypeVal: typeStr, NameVal: "lightstep/customname"},
+		AccessToken:      "abcdef12345",
+		SatelliteHost:    "https://custom.lightstep.com",
+		SatellitePort:    8000,
+		ServiceName:      "myService",
+	})
+}

exporter/lightstepexporter/factory.go

@@ -0,0 +1,60 @@
+// Copyright 2020 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 lightstepexporter
+
+import (
+	"github.com/open-telemetry/opentelemetry-collector/config/configerror"
+	"github.com/open-telemetry/opentelemetry-collector/config/configmodels"
+	"github.com/open-telemetry/opentelemetry-collector/exporter"
+	"go.uber.org/zap"
+)
+
+const (
+	typeStr = "lightstep"
+)
+
+// Factory is the factory for the LightStep exporter.
+type Factory struct {
+}
+
+// Type gets the type of the exporter configuration created by this factory.
+func (f *Factory) Type() string {
+	return typeStr
+}
+
+// CreateDefaultConfig creates a default configuration for this exporter.
+func (f *Factory) CreateDefaultConfig() configmodels.Exporter {
+	return &Config{
+		ExporterSettings: configmodels.ExporterSettings{
+			TypeVal: typeStr,
+			NameVal: typeStr,
+		},
+		AccessToken:   "",
+		SatelliteHost: "https://ingest.lightstep.com",
+		SatellitePort: 443,
+		ServiceName:   "opentelemetry-collector",
+	}
+}
+
+// CreateTraceExporter creates a LightStep trace exporter for this configuration.
+func (f *Factory) CreateTraceExporter(logger *zap.Logger, cfg configmodels.Exporter) (exporter.TraceExporter, error) {
+	lsConfig := cfg.(*Config)
+	return newLightStepTraceExporter(lsConfig)
+}
+
+// CreateMetricsExporter returns nil.
+func (f *Factory) CreateMetricsExporter(logger *zap.Logger, cfg configmodels.Exporter) (exporter.MetricsExporter, error) {
+	return nil, configerror.ErrDataTypeIsNotSupported
+}

exporter/lightstepexporter/factory_test.go

@@ -0,0 +1,67 @@
+// Copyright 2020 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 lightstepexporter
+
+import (
+	"path"
+	"testing"
+
+	"github.com/open-telemetry/opentelemetry-collector/config"
+	"github.com/open-telemetry/opentelemetry-collector/config/configcheck"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.uber.org/zap"
+)
+
+func TestCreateDefaultConfig(t *testing.T) {
+	factory := Factory{}
+	cfg := factory.CreateDefaultConfig()
+	assert.NotNil(t, cfg, "failed to create default config")
+	assert.NoError(t, configcheck.ValidateConfig(cfg))
+}
+
+func TestCreateTraceExporter(t *testing.T) {
+	logger := zap.NewNop()
+
+	factories, err := config.ExampleComponents()
+	require.NoError(t, err)
+	factory := Factory{}
+	factories.Exporters[typeStr] = &factory
+	cfg, err := config.LoadConfigFile(
+		t, path.Join(".", "testdata", "config.yaml"), factories,
+	)
+	require.NoError(t, err)
+
+	exporter, err := factory.CreateTraceExporter(logger, cfg.Exporters["lightstep/customname"])
+	assert.Nil(t, err)
+	assert.NotNil(t, exporter)
+}
+
+func TestCreateMetricsExporter(t *testing.T) {
+	logger := zap.NewNop()
+
+	factories, err := config.ExampleComponents()
+	require.NoError(t, err)
+	factory := Factory{}
+	factories.Exporters[typeStr] = &factory
+	cfg, err := config.LoadConfigFile(
+		t, path.Join(".", "testdata", "config.yaml"), factories,
+	)
+	require.NoError(t, err)
+
+	exporter, err := factory.CreateMetricsExporter(logger, cfg.Exporters["lightstep/customname"])
+	assert.NotNil(t, err)
+	assert.Nil(t, exporter)
+}

exporter/lightstepexporter/go.mod

@@ -0,0 +1,13 @@
+module github.com/open-telemetry/opentelemetry-collector-contrib/exporter/lightstepexporter
+
+go 1.12
+
+require (
+    github.com/lightstep/opentelemetry-exporter-go v0.1.5
+ 	github.com/open-telemetry/opentelemetry-collector v0.2.6
+ 	github.com/stretchr/testify v1.4.0
+ 	go.opentelemetry.io/otel v0.2.3
+ 	go.uber.org/zap v1.14.0
+ )
+
+ replace github.com/apache/thrift => github.com/apache/thrift v0.0.0-20161221203622-b2a4d4ae21c7