[feature] Solarwinds Extension

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v0.113.1
+Adds [SolarWinds Extension](./extension/solarwindsextension). The [SolarWinds Exporter](./exporter/solarwindsexporter) is now dependent on the extension.
+
 ## v0.113.0
 Initial version of SolarWinds OpenTelemetry Collector.
 The collector provides all available components (receivers, processors, exporters, connectors, providers)

Makefile

@@ -1,6 +1,7 @@
 include Makefile.Common
 
 ALL_SRC := $(shell find . \( -name "*.go" -o -name "*.sh" \) \
+							-not -path '*generated*' \
 							-type f | sort)
 
 .PHONY: ci-check-licenses

Makefile.Common

@@ -23,3 +23,12 @@ $(TOOLS_BIN_DIR):
 
 $(TOOLS_BIN_NAMES): $(TOOLS_BIN_DIR) $(TOOLS_MOD_DIR)/go.mod
 	cd $(TOOLS_MOD_DIR) && $(GOCMD) build -o $@ -trimpath $(filter %/$(notdir $@),$(TOOLS_PKG_NAMES))
+
+.PHONY: test
+test:
+	go test ./...
+
+.PHONY: generate
+generate:
+	go generate ./...
+

README.md

@@ -12,12 +12,13 @@ The SolarWinds OpenTelemetry collector contains following components:
   - full set of [opentelemetry-collector processors](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.113.0/processor)
   - full set of [opentelemetry-collector-contrib processors](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.113.0/processor)
 - exporters
+    - [`solarwindsexporter`](./exporter/solarwindsexporter)
     - [`otlpexporter`](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.113.0/exporter/otlpexporter)
     - [`fileexporter`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.113.0/exporter/fileexporter)
-    - [`solarwindsexporter`](./exporter/solarwindsexporter)
     - [`debugexporter`](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.113.0/exporter/debugexporter)
     - [`nopexporter`](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.113.0/exporter/nopexporter)
 - extensions
+    - [`solarwindsextension`](./extension/solarwindsextension)
     - full set of [opentelemetry-collector extensions](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.113.0/extension)
     - full set of [opentelemetry-collector-contrib extensions](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.113.0/extension)
 - connectors

build/docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/library/golang:1.22.7-bookworm AS base
+FROM docker.io/library/golang:1.23.4-bookworm AS base
 
 COPY /LICENSE /LICENSE
 COPY ./ /src
@@ -8,7 +8,7 @@ FROM base AS builder
 RUN cd /src/cmd/solarwinds-otel-collector && CGO_ENABLED=0 GOEXPERIMENT=boringcrypto go build -trimpath -o /src/bin/solarwinds-otel-collector "-ldflags=-s -w"
 
 FROM builder AS tests
-WORKDIR src
+WORKDIR /src
 # run tests for go modules of all maintained components
 # image build is stopped if test failure is detected
 RUN find . -name go.mod -not -path "./cmd/solarwinds-otel-collector/*" -execdir go test ./... \; | ( ! grep FAIL )

cmd/solarwinds-otel-collector/components.go

@@ -17,6 +17,7 @@ package main
 import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/fileexporter"
 	"github.com/solarwinds/solarwinds-otel-collector/exporter/solarwindsexporter"
+	"github.com/solarwinds/solarwinds-otel-collector/extension/solarwindsextension"
 	"go.opentelemetry.io/collector/exporter/debugexporter"
 	"go.opentelemetry.io/collector/exporter/nopexporter"
 	"go.opentelemetry.io/collector/exporter/otlpexporter"
@@ -219,6 +220,7 @@ func components() (otelcol.Factories, error) {
 		sigv4authextension.NewFactory(),
 		solarwindsapmsettingsextension.NewFactory(),
 		sumologicextension.NewFactory(),
+		solarwindsextension.NewFactory(),
 	)
 
 	if err != nil {

cmd/solarwinds-otel-collector/go.mod

@@ -1,8 +1,6 @@
 module github.com/solarwinds/solarwinds-otel-collector
 
-go 1.22.7
-
-toolchain go1.22.9
+go 1.23.4
 
 require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/confmap/provider/aesprovider v0.113.0
@@ -161,8 +159,9 @@ require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/zipkinreceiver v0.113.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/zookeeperreceiver v0.113.0
 	github.com/solarwinds/solarwinds-otel-collector/exporter/solarwindsexporter v0.113.0
+	github.com/solarwinds/solarwinds-otel-collector/extension/solarwindsextension v0.113.0
 	go.opentelemetry.io/collector/component v0.113.0
-	go.opentelemetry.io/collector/confmap v1.19.0
+	go.opentelemetry.io/collector/confmap v1.21.0
 	go.opentelemetry.io/collector/confmap/provider/envprovider v1.19.0
 	go.opentelemetry.io/collector/confmap/provider/fileprovider v1.19.0
 	go.opentelemetry.io/collector/confmap/provider/httpprovider v1.19.0
@@ -712,3 +711,7 @@ require (
 )
 
 replace github.com/solarwinds/solarwinds-otel-collector/exporter/solarwindsexporter => ../../exporter/solarwindsexporter
+
+replace github.com/solarwinds/solarwinds-otel-collector/extension/solarwindsextension => ../../extension/solarwindsextension
+
+replace github.com/solarwinds/solarwinds-otel-collector/pkg/testutil => ../../pkg/testutil

cmd/solarwinds-otel-collector/go.sum

@@ -2542,8 +2542,8 @@ go.opentelemetry.io/collector/config/configtls v1.19.0 h1:GQ/cF1hgNqHVBq2oSSrOFX
 go.opentelemetry.io/collector/config/configtls v1.19.0/go.mod h1:1hyqnYB3JqEUlk1ME/s9HYz4oCRcxQCRxsJitFFT/cA=
 go.opentelemetry.io/collector/config/internal v0.114.0 h1:uWSDWTJb8T6xRjKD9/XmEARakXnxgYVYKUeId78hErc=
 go.opentelemetry.io/collector/config/internal v0.114.0/go.mod h1:yC7E4h1Uj0SubxcFImh6OvBHFTjMh99+A5PuyIgDWqc=
-go.opentelemetry.io/collector/confmap v1.19.0 h1:TQ0lZpAKqgsE0EKk+u4JA+uBbPYeFRmWP3GH43w40CY=
-go.opentelemetry.io/collector/confmap v1.19.0/go.mod h1:GgNu1ElPGmLn9govqIfjaopvdspw4PJ9KeDtWC4E2Q4=
+go.opentelemetry.io/collector/confmap v1.21.0 h1:1tIcx2/Suwg8VhuPmQw87ba0ludPmumpFCFRZZa6RXA=
+go.opentelemetry.io/collector/confmap v1.21.0/go.mod h1:Rrhs+MWoaP6AswZp+ReQ2VO9dfOfcUjdjiSHBsG+nec=
 go.opentelemetry.io/collector/confmap/provider/envprovider v1.19.0 h1:f8O/I5pVRN86Gx5mHekNx92S6fGdOS4VcooRJKWe6Bs=
 go.opentelemetry.io/collector/confmap/provider/envprovider v1.19.0/go.mod h1:AiaW5YW1LD0/WlZuc8eZuZPBH6PA9QqsiAYRX1iC6T0=
 go.opentelemetry.io/collector/confmap/provider/fileprovider v1.19.0 h1:TYwyk4ea3U+5MYcEjrzZAaonBcLlabQu8CZeB7ekAYY=

cmd/solarwinds-otel-collector/main.go

@@ -16,6 +16,8 @@
 package main
 
 import (
+	"log"
+
 	"github.com/open-telemetry/opentelemetry-collector-contrib/confmap/provider/aesprovider"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/confmap/provider/s3provider"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/confmap/provider/secretsmanagerprovider"
@@ -27,7 +29,6 @@ import (
 	"go.opentelemetry.io/collector/confmap/provider/httpsprovider"
 	"go.opentelemetry.io/collector/confmap/provider/yamlprovider"
 	"go.opentelemetry.io/collector/otelcol"
-	"log"
 )
 
 func main() {

exporter/solarwindsexporter/Makefile

@@ -1,7 +1 @@
-.PHONY: test
-test:
-	go test ./...
-
-.PHONY: generate
-generate:
-	go generate ./...
+include ../../Makefile.Common

exporter/solarwindsexporter/README.md

@@ -13,25 +13,24 @@ SolarWinds Exporter is a convenience wrapper around [OTLP gRPC Exporter](https:/
 
 ## Getting Started
 
-You just need to include the SolarWinds Exporter in your exporter definitions and provide the following minimal configuration:
+You just need to include the SolarWinds Exporter in your exporter definitions and no additional configuration is needed. It always needs to be used together with the [Solarwinds Extension](../../extension/solarwindsextension).
 
 ```yaml
 exporters:
   solarwinds:
-    token: "YOUR-INGESTION-TOKEN"
+extensions:
+  solarwinds:
+    token: "TOKEN"
     data_center: "na-01"
 ```
-- `token` (mandatory) - You can generate your token in your SolarWinds Observability SaaS account under _Settings / API Tokens / Create API Token_. The type is "Ingestion". You can find the complete documentation [here](https://documentation.solarwinds.com/en/success_center/observability/content/settings/api-tokens.htm).
-- `data_center` (mandatory) - Data center is the region you picked during the sign-up process. You can easily see in URLs after logging in to SolarWinds Observability SaaS - it's either `na-01`, `na-02` or `eu-01`. Please refer to the [documentation](https://documentation.solarwinds.com/en/success_center/observability/content/system_requirements/endpoints.htm#Find) for details.
 
 ## Full configuration
 
 ### Example with Defaults
 ```yaml
 exporters:
   solarwinds:
-    token: "YOUR-INGESTION-TOKEN" # No default (mandatory field).
-    data_center: "na-01" # No default (mandatory field).
+    extension: "solarwinds"
     timeout: "10s"
     sending_queue:
       enabled: true
@@ -44,14 +43,43 @@ exporters:
       multiplier: 1.5
       max_interval: "30s"
       max_elapsed_time: "300s"
+extensions:
+  solarwinds:
+    token: "TOKEN"
+    data_center: "na-01"
 ```
-- `timeout` (optional) - Timeout for each attempt to send data to the SaaS service. A timeout of zero disables the timeout. The **default** is `5s`.
+> [!TIP]  
+> You can omit `extension` from the Solarwinds Exporter configuration above if there's only a single instance of the Solarwinds Extension.
+
+- `extension` (optional) - This name identifies an instance of the [Solarwinds Extension](../../extension/solarwindsextension) to be used by this exporter to obtain its configuration. 
+   If there is only a single instance of the extension, the configuration value is optional. The format mimics the identifier as it occurs in the collector configuration - 
+   `type/name`, e.g `solarwinds` or `solarwinds/1` for multiple instances of the extension. You would use multiple instances for publishing your telemetry to 
+   multiple **SolarWinds Observability SaaS** organizations.
+- `timeout` (optional) - Timeout for each attempt to send data to the SaaS service. A timeout of zero disables the timeout. The **default** is `10s`.
 - `retry_on_failure` (optional) - These options configure the retry behavior. Please refer to the [Exporter Helper documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md).
 - `sending_queue` (optional) - These are the options to set queuing in the exporter. A full descriptions can be similarly found in [Exporter Helper documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md).
 
 > [!NOTE]  
 > The format of all durations above follow the [time.ParseDuration](https://pkg.go.dev/time#ParseDuration) format of "Duration" strings.
 
+### Example with Multiple Solarwinds Extensions
+```yaml
+exporters:
+  solarwinds:
+    extension: "solarwinds/1"
+extensions:
+  solarwinds/1:
+    token: YOUR-INGESTION-TOKEN1"
+    data_center: "na-01"
+  solarwinds/2:
+    token: YOUR-INGESTION-TOKEN2"
+    data_center: "na-02"
+```
+> [!WARNING]
+> The `extension` configuration value cannot be omitted in the example above. 
+> There are multiple instances of the Solarwinds Extension and you need to
+> configure which instance to use to obtain configuration for the exporter.
+
 ## Development
 - **Tests** can be executed with `make test`.
 - After changes to `metadata.yaml` generated files need to be re-generated with `make generate`. The [mdatagen](http://go.opentelemetry.io/collector/cmd/mdatagen) tool has to be in the `PATH`.

exporter/solarwindsexporter/config.go

@@ -15,9 +15,7 @@
 package solarwindsexporter
 
 import (
-	"errors"
 	"fmt"
-	"strings"
 	"time"
 
 	"go.opentelemetry.io/collector/component"
@@ -29,37 +27,11 @@ import (
 	"go.opentelemetry.io/collector/exporter/otlpexporter"
 )
 
-// dataCenterToURLMapping maps a data center ID to
-// to its corresponding OTLP endpoint URL.
-var dataCenterToURLMapping = map[string]string{
-	"na-01": "otel.collector.na-01.cloud.solarwinds.com:443",
-	"na-02": "otel.collector.na-02.cloud.solarwinds.com:443",
-	"eu-01": "otel.collector.eu-01.cloud.solarwinds.com:443",
-}
-
-// lookupDataCenterURL returns the OTLP endpoint URL
-// for a `dc` data center ID. Matching is case-insensitive.
-// It fails with an error if `dc` doesn't identify a data center.
-func lookupDataCenterURL(dc string) (string, error) {
-	dcLowercase := strings.ToLower(dc)
-
-	url, ok := dataCenterToURLMapping[dcLowercase]
-	if !ok {
-		return "", fmt.Errorf("unknown data center ID: %s", dc)
-	}
-
-	return url, nil
-}
-
 // Config represents a Solarwinds Exporter configuration.
 type Config struct {
-	// DataCenter ID (e.g. na-01).
-	DataCenter string `mapstructure:"data_center"`
-	// EndpointURLOverride sets OTLP endpoint directly.
-	// Warning: Intended for testing use only, use `DataCenter` instead.
-	EndpointURLOverride string `mapstructure:"endpoint_url_override"`
-	// IngestionToken is your secret generated SWO ingestion token.
-	IngestionToken configopaque.String `mapstructure:"token"`
+	// Extension identifies a Solarwinds Extension to
+	// use for obtaining connection credentials in this exporter.
+	Extension string `mapstructure:"extension"`
 	// BackoffSettings configures retry behavior of the exporter.
 	// See [configretry.BackOffConfig] documentation.
 	BackoffSettings configretry.BackOffConfig `mapstructure:"retry_on_failure"`
@@ -68,12 +40,33 @@ type Config struct {
 	QueueSettings exporterhelper.QueueConfig `mapstructure:"sending_queue"`
 	// Timeout configures timeout in the underlying OTLP exporter.
 	Timeout exporterhelper.TimeoutConfig `mapstructure:"timeout,squash"`
+
+	// ingestionToken stores the token provided by the Solarwinds Extension.
+	ingestionToken configopaque.String `mapstructure:"-"`
+	// endpointURL stores the URL provided by the Solarwinds Extension.
+	endpointURL string `mapstructure:"-"`
+	// insecure stores the option to disable TLS provided
+	// by the Solarwinds Extension.
+	insecure bool `mapstructure:"-"`
 }
 
-// NewDefaultConfig creates a new default configuration.
+// extensionAsComponent tries to parse `extension` value of the form 'type/name'
+// or 'type' from the configuration to [component.ID]. If the `extension value is empty,
+// it returns `nil` with a `nil` error.
 //
-// Warning: it doesn't define mandatory `Token` and `DataCenter`
-// fields that need to be explicitly provided.
+// It uses [component.ID.UnmarshalText] and behaves accordingly.
+func (cfg *Config) extensionAsComponent() (*component.ID, error) {
+	if cfg.Extension == "" {
+		return nil, nil
+	}
+
+	parsedID := &component.ID{}
+	err := parsedID.UnmarshalText([]byte(cfg.Extension))
+
+	return parsedID, err
+}
+
+// NewDefaultConfig creates a new default configuration.
 func NewDefaultConfig() component.Config {
 	// Using a higher default than OTLP Exporter does (5s)
 	// based on previous experience with unnecessary timeouts.
@@ -90,16 +83,14 @@ func NewDefaultConfig() component.Config {
 
 // Validate checks the configuration for its validity.
 func (cfg *Config) Validate() error {
-	if cfg.DataCenter == "" && cfg.EndpointURLOverride == "" {
-		return errors.New("invalid configuration: data center must be provided")
-	}
-
-	if _, err := lookupDataCenterURL(cfg.DataCenter); err != nil {
-		return fmt.Errorf("invalid data center ID: %w", err)
-	}
-
-	if cfg.IngestionToken == "" {
-		return errors.New("invalid configuration: token must be set")
+	if len(cfg.Extension) != 0 {
+		_, err := cfg.extensionAsComponent()
+		if err != nil {
+			return fmt.Errorf(
+				"invalid configuration: %q is not a correct value for 'extension'",
+				cfg.Extension,
+			)
+		}
 	}
 
 	return nil
@@ -111,15 +102,8 @@ func (cfg *Config) OTLPConfig() (*otlpexporter.Config, error) {
 		return nil, err
 	}
 
-	// Use overridden URL if provided.
-	endpointURL := cfg.EndpointURLOverride
-	if endpointURL == "" {
-		// Error doesn't need to be checked, it's been validated above.
-		endpointURL, _ = lookupDataCenterURL(cfg.DataCenter)
-	}
-
 	// Headers - set bearer auth.
-	bearer := fmt.Sprintf("Bearer %s", string(cfg.IngestionToken))
+	bearer := fmt.Sprintf("Bearer %s", string(cfg.ingestionToken))
 	headers := map[string]configopaque.String{
 		"Authorization": configopaque.String(bearer),
 	}
@@ -130,7 +114,7 @@ func (cfg *Config) OTLPConfig() (*otlpexporter.Config, error) {
 		Keepalive:    configgrpc.NewDefaultKeepaliveClientConfig(),
 		BalancerName: configgrpc.BalancerName(),
 		Headers:      headers,
-		Endpoint:     endpointURL,
+		Endpoint:     cfg.endpointURL,
 	}
 
 	otlpConfig := &otlpexporter.Config{
@@ -140,6 +124,9 @@ func (cfg *Config) OTLPConfig() (*otlpexporter.Config, error) {
 		ClientConfig:  clientCfg,
 	}
 
+	// Disable TLS for testing.
+	otlpConfig.ClientConfig.TLSSetting.Insecure = cfg.insecure
+
 	if err := otlpConfig.Validate(); err != nil {
 		return nil, err
 	}