Deprecate examples and redirect to contrib

CHANGELOG.md

@@ -19,6 +19,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - `FilterProcessor.Enabled` in `go.opentelemetry.io/otel/sdk/log/internal/x` now accepts `EnabledParameters` instead of `Record`. (#5791)
 - The `Record` type in `go.opentelemetry.io/otel/log` is no longer comparable. (#5847)
 
+### Deprecated
+
+- Deprecate all examples under `go.opentelemetry.io/otel/example` as they are moved to [Contrib repository](https:/open-telemetry/opentelemetry-go-contrib/tree/main/examples). (#5854)
+
 ### Fixed
 
 - The race condition for multiple `FixedSize` exemplar reservoirs identified in #5814 is resolved. (#5819)

Makefile

@@ -54,9 +54,6 @@ $(TOOLS)/stringer: PACKAGE=golang.org/x/tools/cmd/stringer
 PORTO = $(TOOLS)/porto
 $(TOOLS)/porto: PACKAGE=github.com/jcchavezs/porto/cmd/porto
 
-GOJQ = $(TOOLS)/gojq
-$(TOOLS)/gojq: PACKAGE=github.com/itchyny/gojq/cmd/gojq
-
 GOTMPL = $(TOOLS)/gotmpl
 $(GOTMPL): PACKAGE=go.opentelemetry.io/build-tools/gotmpl
 
@@ -67,7 +64,7 @@ GOVULNCHECK = $(TOOLS)/govulncheck
 $(TOOLS)/govulncheck: PACKAGE=golang.org/x/vuln/cmd/govulncheck
 
 .PHONY: tools
-tools: $(CROSSLINK) $(GOLANGCI_LINT) $(MISSPELL) $(GOCOVMERGE) $(STRINGER) $(PORTO) $(GOJQ) $(SEMCONVGEN) $(MULTIMOD) $(SEMCONVKIT) $(GOTMPL) $(GORELEASE)
+tools: $(CROSSLINK) $(GOLANGCI_LINT) $(MISSPELL) $(GOCOVMERGE) $(STRINGER) $(PORTO) $(SEMCONVGEN) $(MULTIMOD) $(SEMCONVKIT) $(GOTMPL) $(GORELEASE)
 
 # Virtualized python tools via docker
 

README.md

@@ -89,8 +89,8 @@ If you need to extend the telemetry an instrumentation library provides or want
 to build your own instrumentation for your application directly you will need
 to use the
 [Go otel](https://pkg.go.dev/go.opentelemetry.io/otel)
-package. The included [examples](./example/) are a good way to see some
-practical uses of this process.
+package. The [examples](https:/open-telemetry/opentelemetry-go-contrib/tree/main/examples)
+are a good way to see some practical uses of this process.
 
 ### Export
 

RELEASING.md

@@ -111,17 +111,6 @@ It is critical you make sure the version you push upstream is correct.
 Finally create a Release for the new `<new tag>` on GitHub.
 The release body should include all the release notes from the Changelog for this release.
 
-## Verify Examples
-
-After releasing verify that examples build outside of the repository.
-
-```
-./verify_examples.sh
-```
-
-The script copies examples into a different directory removes any `replace` declarations in `go.mod` and builds them.
-This ensures they build with the published release, not the local copy.
-
 ## Post-Release
 
 ### Contrib Repository

example/dice/go.mod

@@ -1,45 +1,4 @@
+// Deprecated: Examples are moved to https:/open-telemetry/opentelemetry-go-contrib.
 module go.opentelemetry.io/otel/example/dice
 
 go 1.22
-
-require (
- go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.55.0
- go.opentelemetry.io/otel v1.30.0
- go.opentelemetry.io/otel/exporters/stdout/stdoutlog v0.6.0
- go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v1.30.0
- go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.30.0
- go.opentelemetry.io/otel/log v0.6.0
- go.opentelemetry.io/otel/metric v1.30.0
- go.opentelemetry.io/otel/sdk v1.30.0
- go.opentelemetry.io/otel/sdk/log v0.6.0
- go.opentelemetry.io/otel/sdk/metric v1.30.0
-)
-
-require (
- github.com/felixge/httpsnoop v1.0.4 // indirect
- github.com/go-logr/logr v1.4.2 // indirect
- github.com/go-logr/stdr v1.2.2 // indirect
- github.com/google/uuid v1.6.0 // indirect
- go.opentelemetry.io/otel/trace v1.30.0 // indirect
- golang.org/x/sys v0.25.0 // indirect
-)
-
-replace go.opentelemetry.io/otel/exporters/stdout/stdouttrace => ../../exporters/stdout/stdouttrace
-
-replace go.opentelemetry.io/otel/exporters/stdout/stdoutmetric => ../../exporters/stdout/stdoutmetric
-
-replace go.opentelemetry.io/otel => ../..
-
-replace go.opentelemetry.io/otel/trace => ../../trace
-
-replace go.opentelemetry.io/otel/metric => ../../metric
-
-replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric
-
-replace go.opentelemetry.io/otel/sdk => ../../sdk
-
-replace go.opentelemetry.io/otel/exporters/stdout/stdoutlog => ../../exporters/stdout/stdoutlog
-
-replace go.opentelemetry.io/otel/log => ../../log
-
-replace go.opentelemetry.io/otel/sdk/log => ../../sdk/log

example/dice/go.sum

@@ -1,23 +0,0 @@
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg=
-github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
-github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
-github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY=
-github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
-github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
-github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
-github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
-github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
-github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
-github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
-github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
-github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.55.0 h1:ZIg3ZT/aQ7AfKqdwp7ECpOK6vHqquXXuyTjIO8ZdmPs=
-go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.55.0/go.mod h1:DQAwmETtZV00skUwgD6+0U89g80NKsJE3DCKeLLPQMI=
-golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
-golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
-gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

example/dice/main.go

@@ -1,87 +1,10 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+// Dice is the "Roll the dice" application.
+//
+// Deprecated: Examples are moved to https:/open-telemetry/opentelemetry-go-contrib.
 package main
 
-import (
- "context"
- "errors"
- "log"
- "net"
- "net/http"
- "os"
- "os/signal"
- "time"
-
- "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
-)
-
 func main() {
- if err := run(); err != nil {
- log.Fatalln(err)
- }
-}
-
-func run() (err error) {
- // Handle SIGINT (CTRL+C) gracefully.
- ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt)
- defer stop()
-
- // Set up OpenTelemetry.
- otelShutdown, err := setupOTelSDK(ctx)
- if err != nil {
- return
- }
- // Handle shutdown properly so nothing leaks.
- defer func() {
- err = errors.Join(err, otelShutdown(context.Background()))
- }()
-
- // Start HTTP server.
- srv := &http.Server{
- Addr: ":8080",
- BaseContext: func(_ net.Listener) context.Context { return ctx },
- ReadTimeout: time.Second,
- WriteTimeout: 10 * time.Second,
- Handler: newHTTPHandler(),
- }
- srvErr := make(chan error, 1)
- go func() {
- srvErr <- srv.ListenAndServe()
- }()
-
- // Wait for interruption.
- select {
- case err = <-srvErr:
- // Error when starting HTTP server.
- return
- case <-ctx.Done():
- // Wait for first CTRL+C.
- // Stop receiving signal notifications as soon as possible.
- stop()
- }
-
- // When Shutdown is called, ListenAndServe immediately returns ErrServerClosed.
- err = srv.Shutdown(context.Background())
- return
-}
-
-func newHTTPHandler() http.Handler {
- mux := http.NewServeMux()
-
- // handleFunc is a replacement for mux.HandleFunc
- // which enriches the handler's HTTP instrumentation with the pattern as the http.route.
- handleFunc := func(pattern string, handlerFunc func(http.ResponseWriter, *http.Request)) {
- // Configure the "http.route" for the HTTP instrumentation.
- handler := otelhttp.WithRouteTag(pattern, http.HandlerFunc(handlerFunc))
- mux.Handle(pattern, handler)
- }
-
- // Register handlers.
- handleFunc("/rolldice/", rolldice)
- handleFunc("/rolldice/{player}", rolldice)
-
- // Add HTTP instrumentation for the whole server.
- handler := otelhttp.NewHandler(mux, "/")
- return handler
 }