Add autoexport to automatically configure trace exporters

exporters/autoexport/README.md

@@ -1,56 +1,22 @@
 # Automatic Exporter configuration
 
-This module provides easy access to configuring a trace exporter that can be used when configuring an OpenTelemetry Go SDK trace export pipeline.
-
-The autoexport package looks for the `OTEL_TRACES_EXPORTER` environment variable and if set, attempts to load the exporter from it's registry of exporters. The registry is always loaded with an OTLP exporter with the key `"otlp"` and additional exporters can be registered using `autoexport.RegisterSpanExporter("name", ...)`(See example below). Exporter registration uses a factory pattern to not unneccarily build exporters and use resources until they are requested.
-
-If the environment variable is not set, the fallback exporter is returned. The fallback exporter defaults to an [OTLP exporter](https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/otlp/otlptrace) and can be overriden using the `WithFallbackSpanExporter` option.
-
-### Getting an exporter
-
-Set the preferred exporter type using the `OTEL_TRACES_EXPORTER` environment variable.
-
-```shell
-export OTEL_TRACES_EXPORTER="otlp"
-```
-
-```golang
-import "go.opentelemetry.io/contrib/exporters/autoexport"
-...
+[![Go Reference][goref-image]][goref-url]
+[![Apache License][license-image]][license-url]
 
-exp, err := autoexport.NewTraceExporter(context.Background())
-```
-
-### Defining a custom fallback exporter
-
-The fallback exporter is returned if the exporter environment variable is not set.
-
-```golang
-import "go.opentelemetry.io/contrib/exporters/autoexport"
-
-fallbackExp = ...
-exp, err := autoexport.NewTraceExporter(
-    context.Background(),
-    WithFallbackSpanExporter(fallbackExp),
-)
-```
-
-### Registering a custom exporter
+This module provides easy access to configuring a trace exporter that can be used when configuring an OpenTelemetry Go SDK trace export pipeline.
 
-Set the `OTEL_TRACES_EXPORTER` environment variable to your custom exporter's name.
+## Useful links
 
-```shell
-export OTEL_TRACES_EXPORTER="my-custom-exporter"
-```
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more about OpenTelemetry Go: <https://github.com/open-telemetry/opentelemetry-go>
+- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
 
-Register your custom exporter's factory before retrieveing it.
+## License
 
-```golang
-import "go.opentelemetry.io/contrib/exporters/autoexport"
+Apache 2.0 - See [LICENSE][license-url] for more information.
 
-autoexport.RegisterSpanExporter("my-custom-exporter", func(ctx context.Context) (trace.SpanExporter, error) {
-    exp := ...
-    return exp, nil
-})
-exp, err := autoexport.NewTraceExporter(context.Background())
-```
+[license-url]: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/LICENSE
+[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
+[goref-image]: https://pkg.go.dev/badge/go.opentelemetry.io/contrib/exporters/autoexport.svg
+[goref-url]: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/autoexport
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-go/discussions

exporters/autoexport/doc.go

@@ -12,6 +12,22 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package autoexport helps build trace exporters for configuring the
-// OpenTelemetry SDK trace export pipeline.
+// This module provides easy access to configuring a trace exporter
+// that can be used when configuring an OpenTelemetry Go SDK trace export
+// pipeline.
+//
+// The autoexport package looks for the `OTEL_TRACES_EXPORTER` environment
+// variable and if set, attempts to load the exporter from it's registry of
+// exporters. The registry is always loaded with an OTLP exporter with the key
+// `"otlp"` and additional exporters can be registered using
+// [RegisterSpanExporter](https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/autoexport#RegisterSpanExporter).
+// Exporter registration uses a factory method pattern to not unneccarily build
+// exporters and use resources until they are requested.
+//
+// If the environment variable is not set, the fallback exporter is returned.
+// The fallback exporter defaults to an
+// [OTLP exporter](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace)
+// and can be overriden using the [RegisterSpanExporter](https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/autoexport#WithFallbackSpanExporter)
+// option.
+
 package autoexport // import "go.opentelemetry.io/contrib/exporters/autoexport"