Rename plugins directory to instrumentation (#47)

* Rename plugins director to instrumentation

As per open-telemetry/opentelemetry-specification#539

* Update package names

* Plugin -> instrumentation

CONTRIBUTING.md

@@ -91,18 +91,18 @@ merge**.
 
 ## Adding a new Contrib package
 
-To add a new contrib package follow an existing one. An empty Sample plugin
+To add a new contrib package follow an existing one. An empty Sample instrumentation
 provides base structure with an example and a test. Each contrib package 
 should be its own module. A contrib package may contain more than one go package.
 
 ### Folder Structure
-- plugins/\<plugin-package>  (**Common**)
-- plugins/\<plugin-package>/trace (**specific to trace**)
-- plugins/\<plugin-package>/metrics (**specific to metrics**)
+- instrumentation/\<instrumentation-package>  (**Common**)
+- instrumentation/\<instrumentation-package>/trace (**specific to trace**)
+- instrumentation/\<instrumentation-package>/metrics (**specific to metrics**)
 
 #### Example
-- plugins/gorm/trace
-- plugins/kafka/metrics
+- instrumentation/gorm/trace
+- instrumentation/kafka/metrics
 
 ## Approvers and Maintainers
 

doc.go

@@ -1,6 +1,6 @@
 // This package provides all of its functionality through its
 // submodules. The submodules in the exporters directory provide
 // implementations for trace and metric exporters for third-party
-// collectors, and submodules in the plugins directory provide the
+// collectors, and submodules in the instrumentation directory provide the
 // instrumentation for the popular go libraries.
 package contrib

plugins/gin-gonic/gin/doc.go → instrumentation/gin-gonic/gin/doc.go

@@ -19,4 +19,4 @@
 // instrumenting the routing of a received message (the Middleware
 // function) and instrumenting the response generation through
 // template evaluation (the HTML function).
-package gin // import "go.opentelemetry.io/contrib/plugins/gin-gonic/gin"
+package gin // import "go.opentelemetry.io/contrib/instrumentation/gin-gonic/gin"

plugins/gin-gonic/gin/example/Dockerfile → instrumentation/gin-gonic/gin/example/Dockerfile

@@ -13,7 +13,7 @@
 # limitations under the License.
 FROM golang:alpine AS base
 COPY . /src/
-WORKDIR /src/plugins/gin-gonic/gin
+WORKDIR /src/instrumentation/gin-gonic/gin
 
 FROM base AS gin-server
 RUN go install ./example/server.go

plugins/gin-gonic/gin/example/server.go → instrumentation/gin-gonic/gin/example/server.go

@@ -22,7 +22,7 @@ import (
 
 	"github.com/gin-gonic/gin"
 
-	gintrace "go.opentelemetry.io/contrib/plugins/gin-gonic/gin"
+	gintrace "go.opentelemetry.io/contrib/instrumentation/gin-gonic/gin"
 	otelglobal "go.opentelemetry.io/otel/api/global"
 	"go.opentelemetry.io/otel/api/kv"
 	oteltrace "go.opentelemetry.io/otel/api/trace"

plugins/gin-gonic/gin/gintrace.go → instrumentation/gin-gonic/gin/gintrace.go

@@ -31,7 +31,7 @@ import (
 
 const (
 	tracerKey  = "otel-go-contrib-tracer"
-	tracerName = "go.opentelemetry.io/contrib/plugins/gin-gonic/gin"
+	tracerName = "go.opentelemetry.io/contrib/instrumentation/gin-gonic/gin"
 )
 
 // Middleware returns middleware that will trace incoming requests.

plugins/gin-gonic/gin/gintrace_test.go → instrumentation/gin-gonic/gin/gintrace_test.go

@@ -52,7 +52,7 @@ func TestChildSpanFromGlobalTracer(t *testing.T) {
 		spanTracer := span.Tracer()
 		mockTracer, ok := spanTracer.(*mocktrace.Tracer)
 		require.True(t, ok)
-		assert.Equal(t, "go.opentelemetry.io/contrib/plugins/gin-gonic/gin", mockTracer.Name)
+		assert.Equal(t, "go.opentelemetry.io/contrib/instrumentation/gin-gonic/gin", mockTracer.Name)
 	})
 
 	r := httptest.NewRequest("GET", "/user/123", nil)

plugins/gin-gonic/gin/go.mod → instrumentation/gin-gonic/gin/go.mod

@@ -1,4 +1,4 @@
-module go.opentelemetry.io/contrib/plugins/gin-gonic/gin
+module go.opentelemetry.io/contrib/instrumentation/gin-gonic/gin
 
 go 1.14
 

plugins/gin-gonic/gin/option.go → instrumentation/gin-gonic/gin/option.go

@@ -31,7 +31,7 @@ type Option func(*Config)
 
 // WithTracer specifies a tracer to use for creating spans. If none is
 // specified, a tracer named
-// "go.opentelemetry.io/contrib/plugins/gin-gonic/gin" from the global
+// "go.opentelemetry.io/contrib/instrumentation/gin-gonic/gin" from the global
 // provider is used.
 func WithTracer(tracer oteltrace.Tracer) Option {
 	return func(cfg *Config) {

plugins/go.mongodb.org/mongo-driver/config.go → instrumentation/go.mongodb.org/mongo-driver/config.go

@@ -20,7 +20,7 @@ import (
 )
 
 const (
-	defaultTracerName = "go.opentelemetry.io/contrib/plugins/go.mongodb.org/mongo-driver"
+	defaultTracerName = "go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver"
 )
 
 // Config is used to configure the mongo tracer.
@@ -45,7 +45,7 @@ type Option func(*Config)
 
 // WithTracer specifies a tracer to use for creating spans. If none is
 // specified, a tracer named
-// "go.opentelemetry.io/contrib/plugins/go.mongodb.org/mongo-driver"
+// "go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver"
 // from the global provider is used.
 func WithTracer(tracer trace.Tracer) Option {
 	return func(cfg *Config) {

plugins/go.mongodb.org/mongo-driver/doc.go → instrumentation/go.mongodb.org/mongo-driver/doc.go

@@ -22,4 +22,4 @@
 // This code was originally based on the following:
 // - https://github.com/DataDog/dd-trace-go/tree/02f0449efa3cb382d499fadc873957385dcb2192/contrib/go.mongodb.org/mongo-driver/mongo
 // - https://github.com/DataDog/dd-trace-go/tree/v1.23.3/ddtrace/ext
-package mongo // import "go.opentelemetry.io/contrib/plugins/go.mongodb.org/mongo-driver"
+package mongo // import "go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver"

plugins/go.mongodb.org/mongo-driver/example_test.go → instrumentation/go.mongodb.org/mongo-driver/example_test.go

@@ -21,7 +21,7 @@ import (
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 
-	mongotrace "go.opentelemetry.io/contrib/plugins/go.mongodb.org/mongo-driver"
+	mongotrace "go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver"
 )
 
 func Example() {

plugins/go.mongodb.org/mongo-driver/go.mod → instrumentation/go.mongodb.org/mongo-driver/go.mod

@@ -1,4 +1,4 @@
-module go.opentelemetry.io/contrib/plugins/go.mongodb.org/mongo-driver
+module go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver
 
 go 1.13
 

plugins/gorilla/mux/config.go → instrumentation/gorilla/mux/config.go

@@ -30,7 +30,7 @@ type Option func(*Config)
 
 // WithTracer specifies a tracer to use for creating spans. If none is
 // specified, a tracer named
-// "go.opentelemetry.io/contrib/plugins/gorilla/mux" from the global
+// "go.opentelemetry.io/contrib/instrumentation/gorilla/mux" from the global
 // provider is used.
 func WithTracer(tracer oteltrace.Tracer) Option {
 	return func(cfg *Config) {

plugins/gorilla/mux/doc.go → instrumentation/gorilla/mux/doc.go

@@ -17,4 +17,4 @@
 //
 // Currently only the routing of a received message can be
 // instrumented. To do it, use the Middleware function.
-package mux // import "go.opentelemetry.io/contrib/plugins/gorilla/mux"
+package mux // import "go.opentelemetry.io/contrib/instrumentation/gorilla/mux"

plugins/gorilla/mux/example/Dockerfile → instrumentation/gorilla/mux/example/Dockerfile

@@ -13,7 +13,7 @@
 # limitations under the License.
 FROM golang:alpine AS base
 COPY . /src/
-WORKDIR /src/plugins/gorilla/mux
+WORKDIR /src/instrumentation/gorilla/mux
 
 FROM base AS mux-server
 RUN go install ./example/server.go

plugins/gorilla/mux/example/server.go → instrumentation/gorilla/mux/example/server.go

@@ -22,7 +22,7 @@ import (
 
 	"github.com/gorilla/mux"
 
-	muxtrace "go.opentelemetry.io/contrib/plugins/gorilla/mux"
+	muxtrace "go.opentelemetry.io/contrib/instrumentation/gorilla/mux"
 	otelglobal "go.opentelemetry.io/otel/api/global"
 	otelkv "go.opentelemetry.io/otel/api/kv"
 	oteltrace "go.opentelemetry.io/otel/api/trace"

plugins/gorilla/mux/go.mod → instrumentation/gorilla/mux/go.mod

@@ -1,4 +1,4 @@
-module go.opentelemetry.io/contrib/plugins/gorilla/mux
+module go.opentelemetry.io/contrib/instrumentation/gorilla/mux
 
 go 1.14
 

plugins/gorilla/mux/mux.go → instrumentation/gorilla/mux/mux.go

@@ -28,7 +28,7 @@ import (
 )
 
 const (
-	tracerName = "go.opentelemetry.io/contrib/plugins/gorilla/mux"
+	tracerName = "go.opentelemetry.io/contrib/instrumentation/gorilla/mux"
 )
 
 // Middleware sets up a handler to start tracing the incoming

plugins/gorilla/mux/mux_test.go → instrumentation/gorilla/mux/mux_test.go

@@ -43,7 +43,7 @@ func TestChildSpanFromGlobalTracer(t *testing.T) {
 		spanTracer := span.Tracer()
 		mockTracer, ok := spanTracer.(*mocktrace.Tracer)
 		require.True(t, ok)
-		assert.Equal(t, "go.opentelemetry.io/contrib/plugins/gorilla/mux", mockTracer.Name)
+		assert.Equal(t, "go.opentelemetry.io/contrib/instrumentation/gorilla/mux", mockTracer.Name)
 		w.WriteHeader(http.StatusOK)
 	}))
 

plugins/labstack/echo/config.go → instrumentation/labstack/echo/config.go

@@ -30,7 +30,7 @@ type Option func(*Config)
 
 // WithTracer specifies a tracer to use for creating spans. If none is
 // specified, a tracer named
-// "go.opentelemetry.io/contrib/plugins/labstack/echo" from the global
+// "go.opentelemetry.io/contrib/instrumentation/labstack/echo" from the global
 // provider is used.
 func WithTracer(tracer oteltrace.Tracer) Option {
 	return func(cfg *Config) {

plugins/labstack/echo/echo.go → instrumentation/labstack/echo/echo.go

@@ -28,7 +28,7 @@ import (
 
 const (
 	tracerKey  = "otel-go-contrib-tracer-labstack-echo"
-	tracerName = "go.opentelemetry.io/contrib/plugins/labstack/echo"
+	tracerName = "go.opentelemetry.io/contrib/instrumentation/labstack/echo"
 )
 
 // Middleware returns echo middleware which will trace incoming requests.

plugins/labstack/echo/echo_test.go → instrumentation/labstack/echo/echo_test.go

@@ -48,7 +48,7 @@ func TestChildSpanFromGlobalTracer(t *testing.T) {
 		spanTracer := span.Tracer()
 		mockTracer, ok := spanTracer.(*mocktrace.Tracer)
 		require.True(t, ok)
-		assert.Equal(t, "go.opentelemetry.io/contrib/plugins/labstack/echo", mockTracer.Name)
+		assert.Equal(t, "go.opentelemetry.io/contrib/instrumentation/labstack/echo", mockTracer.Name)
 		return c.NoContent(200)
 	})
 

plugins/labstack/echo/example/Dockerfile → instrumentation/labstack/echo/example/Dockerfile

@@ -13,7 +13,7 @@
 # limitations under the License.
 FROM golang:alpine AS base
 COPY . /src/
-WORKDIR /src/plugins/labstack/echo
+WORKDIR /src/instrumentation/labstack/echo
 
 FROM base AS echo-server
 RUN go install ./example/server.go

plugins/labstack/echo/example/server.go → instrumentation/labstack/echo/example/server.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/labstack/echo/v4"
 
-	echotrace "go.opentelemetry.io/contrib/plugins/labstack/echo"
+	echotrace "go.opentelemetry.io/contrib/instrumentation/labstack/echo"
 	otelglobal "go.opentelemetry.io/otel/api/global"
 	"go.opentelemetry.io/otel/api/kv"
 	oteltrace "go.opentelemetry.io/otel/api/trace"

plugins/labstack/echo/go.mod → instrumentation/labstack/echo/go.mod

@@ -1,4 +1,4 @@
-module go.opentelemetry.io/contrib/plugins/labstack/echo
+module go.opentelemetry.io/contrib/instrumentation/labstack/echo
 
 go 1.14
 

plugins/macaron/config.go → instrumentation/macaron/config.go

@@ -30,7 +30,7 @@ type Option func(*Config)
 
 // WithTracer specifies a tracer to use for creating spans. If none is
 // specified, a tracer named
-// "go.opentelemetry.io/contrib/plugins/macaron" from the global
+// "go.opentelemetry.io/contrib/instrumentation/macaron" from the global
 // provider is used.
 func WithTracer(tracer trace.Tracer) Option {
 	return func(cfg *Config) {

plugins/macaron/doc.go → instrumentation/macaron/doc.go

@@ -17,4 +17,4 @@
 //
 // Currently only the routing of a received message can be
 // instrumented. To do it, use the Middleware function.
-package macaron // import "go.opentelemetry.io/contrib/plugins/macaron"
+package macaron // import "go.opentelemetry.io/contrib/instrumentation/macaron"

plugins/macaron/example/Dockerfile → instrumentation/macaron/example/Dockerfile

@@ -13,7 +13,7 @@
 # limitations under the License.
 FROM golang:alpine AS base
 COPY . /src/
-WORKDIR /src/plugins/macaron
+WORKDIR /src/instrumentation/macaron
 
 FROM base AS macaron-server
 RUN go install ./example/server.go

plugins/macaron/example/server.go → instrumentation/macaron/example/server.go

@@ -20,7 +20,7 @@ import (
 
 	"gopkg.in/macaron.v1"
 
-	macarontrace "go.opentelemetry.io/contrib/plugins/macaron"
+	macarontrace "go.opentelemetry.io/contrib/instrumentation/macaron"
 
 	otelglobal "go.opentelemetry.io/otel/api/global"
 	otelkv "go.opentelemetry.io/otel/api/kv"

plugins/macaron/go.mod → instrumentation/macaron/go.mod

@@ -1,4 +1,4 @@
-module go.opentelemetry.io/contrib/plugins/macaron
+module go.opentelemetry.io/contrib/instrumentation/macaron
 
 go 1.14
 

plugins/macaron/macaron.go → instrumentation/macaron/macaron.go

@@ -27,7 +27,7 @@ import (
 )
 
 const (
-	tracerName = "go.opentelemetry.io/contrib/plugins/macaron"
+	tracerName = "go.opentelemetry.io/contrib/instrumentation/macaron"
 )
 
 // Middleware returns a macaron Handler to trace requests to the server.

plugins/macaron/macaron_test.go → instrumentation/macaron/macaron_test.go

@@ -43,7 +43,7 @@ func TestChildSpanFromGlobalTracer(t *testing.T) {
 		spanTracer := span.Tracer()
 		mockTracer, ok := spanTracer.(*mocktrace.Tracer)
 		require.True(t, ok)
-		assert.Equal(t, "go.opentelemetry.io/contrib/plugins/macaron", mockTracer.Name)
+		assert.Equal(t, "go.opentelemetry.io/contrib/instrumentation/macaron", mockTracer.Name)
 		ctx.Resp.WriteHeader(http.StatusOK)
 	})
 

plugins/runtime/example/main.go → instrumentation/runtime/example/main.go

@@ -25,7 +25,7 @@ import (
 	metricstdout "go.opentelemetry.io/otel/exporters/metric/stdout"
 	"go.opentelemetry.io/otel/sdk/metric/controller/push"
 
-	"go.opentelemetry.io/contrib/plugins/runtime"
+	"go.opentelemetry.io/contrib/instrumentation/runtime"
 )
 
 func initMeter() *push.Controller {

plugins/runtime/go.mod → instrumentation/runtime/go.mod

@@ -1,4 +1,4 @@
-module go.opentelemetry.io/contrib/plugins/runtime
+module go.opentelemetry.io/contrib/instrumentation/runtime
 
 go 1.14
 

plugins/runtime/runtime.go → instrumentation/runtime/runtime.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package runtime // import "go.opentelemetry.io/contrib/plugins/runtime"
+package runtime // import "go.opentelemetry.io/contrib/instrumentation/runtime"
 
 import (
 	"context"

plugins/runtime/runtime_test.go → instrumentation/runtime/runtime_test.go

@@ -20,7 +20,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"go.opentelemetry.io/contrib/plugins/runtime"
+	"go.opentelemetry.io/contrib/instrumentation/runtime"
 
 	"go.opentelemetry.io/otel/api/global"
 )