Skip to content

Commit

Permalink
[config] prepare package for release
Browse files Browse the repository at this point in the history
This PR does the following:

- adds a section to versions.yaml, please review that the new section makes sense, it didn't seem to fit in any of the other groups.
- adds doc.go
- adds example

Signed-off-by: Alex Boten <aboten@lightstep.com>
  • Loading branch information
Alex Boten committed Nov 9, 2023
1 parent fe68fe9 commit 3e4eee5
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 1 deletion.
7 changes: 7 additions & 0 deletions config/doc.go
@@ -0,0 +1,7 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

// Package config can be used to parse a configuration file
// that follows the JSON Schema defined by the OpenTelemetry
// Configuration schema.
package config // import "go.opentelemetry.io/contrib/config"
34 changes: 34 additions & 0 deletions config/example_test.go
@@ -0,0 +1,34 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package config_test

import (
"context"

"go.opentelemetry.io/contrib/config"
"go.opentelemetry.io/otel"
)

func ExampleNewSDK() {
// NewSDK returns a configured SDK as configured
// per the options and any error that occurred during
// the initialization process.
configuredSDK, err := config.NewSDK(
config.WithContext(context.Background()),
config.WithOpenTelemetryConfiguration(config.OpenTelemetryConfiguration{
TracerProvider: &config.TracerProvider{},
MeterProvider: &config.MeterProvider{},
}),
)

if err != nil {
// Handle error appropriately.
panic(err)
}

// This SDK can then be used to get a TracerProvider and
// MeterProvider
otel.SetTracerProvider(configuredSDK.TracerProvider())
otel.SetMeterProvider(configuredSDK.MeterProvider())
}
5 changes: 4 additions & 1 deletion versions.yaml
Expand Up @@ -83,8 +83,11 @@ module-sets:
- go.opentelemetry.io/contrib/samplers/jaegerremote
- go.opentelemetry.io/contrib/samplers/jaegerremote/example
- go.opentelemetry.io/contrib/samplers/probability/consistent
experimental-config:
version: v0.1.0
modules:
- go.opentelemetry.io/contrib/config
excluded-modules:
- go.opentelemetry.io/contrib/config
- go.opentelemetry.io/contrib/instrgen
- go.opentelemetry.io/contrib/instrgen/driver
- go.opentelemetry.io/contrib/instrgen/testdata/interface

0 comments on commit 3e4eee5

Please sign in to comment.