[chore][receiver/jaeger] create metadata (open-telemetry#21820)

fluxninja · May 11, 2023 · fd438b6 · fd438b6
1 parent b00fac6
commit fd438b6
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 22 deletions.
diff --git a/receiver/jaegerreceiver/README.md b/receiver/jaegerreceiver/README.md
@@ -1,10 +1,15 @@
 # Jaeger Receiver
 
-| Status | |
-| ------------------------ |-------------------|
-| Stability | [beta] |
-| Supported pipeline types | traces |
-| Distributions | [core], [contrib] |
+<!-- status autogenerated section -->
+| Status | |
+| ------------- |-----------|
+| Stability | [beta]: traces |
+| Distributions | [core], [contrib] |
+
+[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
+[core]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
+<!-- end autogenerated section -->
 
 Receives trace data in [Jaeger](https://www.jaegertracing.io/) format.
 
@@ -64,6 +69,3 @@ Several helper files are leveraged to provide additional capabilities automatica
 
 Since version [v0.61.0](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/v0.61.0), remote sampling is no longer supported by the jaeger receiver. Since version [v0.59.0](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/v0.59.0), the [jaegerremotesapmpling](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.61.0/extension/jaegerremotesampling/README.md) extension is available that can be used instead.
 
-[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
-[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
-[core]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
diff --git a/receiver/jaegerreceiver/config_test.go b/receiver/jaegerreceiver/config_test.go
@@ -27,6 +27,8 @@ import (
  "go.opentelemetry.io/collector/config/confignet"
  "go.opentelemetry.io/collector/config/configtls"
  "go.opentelemetry.io/collector/confmap/confmaptest"
+
+ "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/jaegerreceiver/internal/metadata"
 )
 
 func TestLoadConfig(t *testing.T) {
@@ -40,7 +42,7 @@ func TestLoadConfig(t *testing.T) {
  expected component.Config
  }{
  {
- id: component.NewIDWithName(typeStr, "customname"),
+ id: component.NewIDWithName(metadata.Type, "customname"),
  expected: &Config{
  Protocols: Protocols{
  GRPC: &configgrpc.GRPCServerSettings{
@@ -82,7 +84,7 @@ func TestLoadConfig(t *testing.T) {
  },
  },
  {
- id: component.NewIDWithName(typeStr, "defaults"),
+ id: component.NewIDWithName(metadata.Type, "defaults"),
  expected: &Config{
  Protocols: Protocols{
  GRPC: &configgrpc.GRPCServerSettings{
@@ -106,7 +108,7 @@ func TestLoadConfig(t *testing.T) {
  },
  },
  {
- id: component.NewIDWithName(typeStr, "mixed"),
+ id: component.NewIDWithName(metadata.Type, "mixed"),
  expected: &Config{
  Protocols: Protocols{
  GRPC: &configgrpc.GRPCServerSettings{
@@ -123,7 +125,7 @@ func TestLoadConfig(t *testing.T) {
  },
  },
  {
- id: component.NewIDWithName(typeStr, "tls"),
+ id: component.NewIDWithName(metadata.Type, "tls"),
  expected: &Config{
  Protocols: Protocols{
  GRPC: &configgrpc.GRPCServerSettings{
@@ -167,17 +169,17 @@ func TestFailedLoadConfig(t *testing.T) {
  factory := NewFactory()
  cfg := factory.CreateDefaultConfig()
 
- sub, err := cm.Sub(component.NewIDWithName(typeStr, "typo_default_proto_config").String())
+ sub, err := cm.Sub(component.NewIDWithName(metadata.Type, "typo_default_proto_config").String())
  require.NoError(t, err)
  err = component.UnmarshalConfig(sub, cfg)
  assert.EqualError(t, err, "1 error(s) decoding:\n\n* 'protocols' has invalid keys: thrift_htttp")
 
- sub, err = cm.Sub(component.NewIDWithName(typeStr, "bad_proto_config").String())
+ sub, err = cm.Sub(component.NewIDWithName(metadata.Type, "bad_proto_config").String())
  require.NoError(t, err)
  err = component.UnmarshalConfig(sub, cfg)
  assert.EqualError(t, err, "1 error(s) decoding:\n\n* 'protocols' has invalid keys: thrift_htttp")
 
- sub, err = cm.Sub(component.NewIDWithName(typeStr, "empty").String())
+ sub, err = cm.Sub(component.NewIDWithName(metadata.Type, "empty").String())
  require.NoError(t, err)
  err = component.UnmarshalConfig(sub, cfg)
  assert.EqualError(t, err, "empty config for Jaeger receiver")

diff --git a/receiver/jaegerreceiver/doc.go b/receiver/jaegerreceiver/doc.go
@@ -12,5 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//go:generate mdatagen metadata.yaml
+
 // Package jaegerreceiver receives Jaeger traces.
 package jaegerreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/jaegerreceiver"
diff --git a/receiver/jaegerreceiver/factory.go b/receiver/jaegerreceiver/factory.go
@@ -25,12 +25,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/jaegerreceiver/internal/metadata"
 )
 
 const (
- typeStr = "jaeger"
- stability = component.StabilityLevelBeta
-
  // Protocol values.
  protoGRPC = "grpc"
  protoThriftHTTP = "thrift_http"
@@ -47,9 +46,9 @@ const (
 // NewFactory creates a new Jaeger 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 Jaeger receiver.

diff --git a/receiver/jaegerreceiver/factory_test.go b/receiver/jaegerreceiver/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/jaegerreceiver/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/jaegerreceiver/internal/metadata/generated_status.go b/receiver/jaegerreceiver/internal/metadata/generated_status.go
diff --git a/receiver/jaegerreceiver/jaeger_agent_test.go b/receiver/jaegerreceiver/jaeger_agent_test.go
@@ -41,9 +41,10 @@ import (
 
  "github.com/open-telemetry/opentelemetry-collector-contrib/internal/common/testutil"
  "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/jaeger"
+ "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/jaegerreceiver/internal/metadata"
 )
 
-var jaegerAgent = component.NewIDWithName(typeStr, "agent_test")
+var jaegerAgent = component.NewIDWithName(metadata.Type, "agent_test")
 
 func TestJaegerAgentUDP_ThriftCompact(t *testing.T) {
  addr := testutil.GetAvailableLocalAddress(t)

diff --git a/receiver/jaegerreceiver/metadata.yaml b/receiver/jaegerreceiver/metadata.yaml
@@ -0,0 +1,8 @@
+type: jaeger
+
+status:
+ class: receiver
+ stability:
+ beta: [traces]
+ distributions: [core, contrib]
+