[chore][receiver/skywalking] create metadata (open-telemetry#21712)

sakulali · May 12, 2023 · c9361df · c9361df
1 parent 984698a
commit c9361df
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 16 deletions.
diff --git a/receiver/skywalkingreceiver/README.md b/receiver/skywalkingreceiver/README.md
@@ -1,10 +1,14 @@
 # Skywalking Receiver
 
-| Status | |
-| ------------------------ |---------------|
-| Stability | [beta] |
-| Supported pipeline types | traces |
-| Distributions | [contrib] |
+<!-- status autogenerated section -->
+| Status | |
+| ------------- |-----------|
+| Stability | [beta]: traces |
+| Distributions | [contrib] |
+
+[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
+<!-- end autogenerated section -->
 
 Receives trace data in [Skywalking](https://skywalking.apache.org/) format.
 
@@ -35,5 +39,3 @@ service:
  receivers: [skywalking]
 ```
 
-[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
-[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
diff --git a/receiver/skywalkingreceiver/config_test.go b/receiver/skywalkingreceiver/config_test.go
@@ -25,6 +25,8 @@ import (
  "go.opentelemetry.io/collector/config/confighttp"
  "go.opentelemetry.io/collector/config/confignet"
  "go.opentelemetry.io/collector/confmap/confmaptest"
+
+ "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/skywalkingreceiver/internal/metadata"
 )
 
 func TestLoadConfig(t *testing.T) {
@@ -38,11 +40,11 @@ func TestLoadConfig(t *testing.T) {
  expected component.Config
  }{
  {
- id: component.NewIDWithName(typeStr, ""),
+ id: component.NewIDWithName(metadata.Type, ""),
  expected: createDefaultConfig(),
  },
  {
- id: component.NewIDWithName(typeStr, "customname"),
+ id: component.NewIDWithName(metadata.Type, "customname"),
  expected: &Config{
  Protocols: Protocols{
  HTTP: &confighttp.HTTPServerSettings{
@@ -52,7 +54,7 @@ func TestLoadConfig(t *testing.T) {
  },
  },
  {
- id: component.NewIDWithName(typeStr, "defaults"),
+ id: component.NewIDWithName(metadata.Type, "defaults"),
  expected: &Config{
  Protocols: Protocols{
  GRPC: &configgrpc.GRPCServerSettings{

diff --git a/receiver/skywalkingreceiver/doc.go b/receiver/skywalkingreceiver/doc.go
@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http:https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//go:generate mdatagen metadata.yaml
+
+package skywalkingreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/skywalkingreceiver"
diff --git a/receiver/skywalkingreceiver/factory.go b/receiver/skywalkingreceiver/factory.go
@@ -28,12 +28,11 @@ import (
  "go.opentelemetry.io/collector/config/confignet"
  "go.opentelemetry.io/collector/consumer"
  "go.opentelemetry.io/collector/receiver"
+
+ "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/skywalkingreceiver/internal/metadata"
 )
 
 const (
- typeStr = "skywalking"
- stability = component.StabilityLevelBeta
-
  // Protocol values.
  protoGRPC = "grpc"
  protoHTTP = "http"
@@ -46,9 +45,9 @@ const (
 // NewFactory creates a new Skywalking receiver factory.
 func NewFactory() receiver.Factory {
  return receiver.NewFactory(
- typeStr,
+ metadata.Type,
  createDefaultConfig,
- receiver.WithTraces(createTracesReceiver, stability))
+ receiver.WithTraces(createTracesReceiver, metadata.TracesStability))
 }
 
 // CreateDefaultConfig creates the default configuration for Skywalking receiver.

diff --git a/receiver/skywalkingreceiver/factory_test.go b/receiver/skywalkingreceiver/factory_test.go
@@ -29,6 +29,8 @@ import (
  "go.opentelemetry.io/collector/config/configtls"
  "go.opentelemetry.io/collector/confmap/confmaptest"
  "go.opentelemetry.io/collector/receiver/receivertest"
+
+ "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/skywalkingreceiver/internal/metadata"
 )
 
 func TestTypeStr(t *testing.T) {
@@ -70,7 +72,7 @@ func TestCreateReceiverGeneralConfig(t *testing.T) {
  factory := NewFactory()
  cfg := factory.CreateDefaultConfig()
 
- sub, err := cm.Sub(component.NewIDWithName(typeStr, "customname").String())
+ sub, err := cm.Sub(component.NewIDWithName(metadata.Type, "customname").String())
  require.NoError(t, err)
  require.NoError(t, component.UnmarshalConfig(sub, cfg))
 

diff --git a/receiver/skywalkingreceiver/internal/metadata/generated_status.go b/receiver/skywalkingreceiver/internal/metadata/generated_status.go
diff --git a/receiver/skywalkingreceiver/metadata.yaml b/receiver/skywalkingreceiver/metadata.yaml
@@ -0,0 +1,8 @@
+type: skywalking
+
+status:
+ class: receiver
+ stability:
+ beta: [traces]
+ distributions: [contrib]
+