Skip to content

Commit 5d991f1

Browse files
authored
[chore][receiver/awsecscontainermetrics] create metadata (open-telemetry#21845)
Created Metadata file and added stability + type changes
1 parent 4540dde commit 5d991f1

File tree

6 files changed

+38
-17
lines changed

6 files changed

+38
-17
lines changed

receiver/awsecscontainermetricsreceiver/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# AWS ECS Container Metrics Receiver
22

3-
| Status | |
4-
| ------------------------ |-----------|
5-
| Stability | [beta] |
6-
| Supported pipeline types | metrics |
7-
| Distributions | [contrib] |
3+
<!-- status autogenerated section -->
4+
| Status | |
5+
| ------------- |-----------|
6+
| Stability | [beta]: metrics |
7+
| Distributions | [contrib] |
8+
9+
[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
10+
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
11+
<!-- end autogenerated section -->
812

913
## Overview
1014

@@ -368,5 +372,3 @@ service:
368372
1. [Setup OpenTelemetry Collector on Amazon ECS](https://aws-otel.github.io/docs/setup/ecs)
369373
2. [Getting Started with ECS Container Metrics Receiver in the OpenTelemetry Collector](https://aws-otel.github.io/docs/components/ecs-metrics-receiver)
370374

371-
[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
372-
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

receiver/awsecscontainermetricsreceiver/config_test.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ import (
2323
"github.com/stretchr/testify/require"
2424
"go.opentelemetry.io/collector/component"
2525
"go.opentelemetry.io/collector/confmap/confmaptest"
26+
27+
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/awsecscontainermetricsreceiver/internal/metadata"
2628
)
2729

2830
func TestLoadConfig(t *testing.T) {
@@ -36,11 +38,11 @@ func TestLoadConfig(t *testing.T) {
3638
expected component.Config
3739
}{
3840
{
39-
id: component.NewIDWithName(typeStr, ""),
41+
id: component.NewIDWithName(metadata.Type, ""),
4042
expected: createDefaultConfig(),
4143
},
4244
{
43-
id: component.NewIDWithName(typeStr, "collection_interval_settings"),
45+
id: component.NewIDWithName(metadata.Type, "collection_interval_settings"),
4446
expected: &Config{
4547
CollectionInterval: 10 * time.Second,
4648
},

receiver/awsecscontainermetricsreceiver/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,6 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
//go:generate mdatagen metadata.yaml
16+
1517
package awsecscontainermetricsreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/awsecscontainermetricsreceiver"

receiver/awsecscontainermetricsreceiver/factory.go

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,21 @@ import (
2626

2727
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/ecsutil"
2828
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/ecsutil/endpoints"
29+
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/awsecscontainermetricsreceiver/internal/metadata"
2930
)
3031

3132
// Factory for awscontainermetrics
3233
const (
33-
// Key to invoke this receiver (awsecscontainermetrics)
34-
typeStr = "awsecscontainermetrics"
35-
36-
// Stability level of the receiver
37-
stability = component.StabilityLevelBeta
38-
3934
// Default collection interval. Every 20s the receiver will collect metrics from Amazon ECS Task Metadata Endpoint
4035
defaultCollectionInterval = 20 * time.Second
4136
)
4237

4338
// NewFactory creates a factory for AWS ECS Container Metrics receiver.
4439
func NewFactory() receiver.Factory {
4540
return receiver.NewFactory(
46-
typeStr,
41+
metadata.Type,
4742
createDefaultConfig,
48-
receiver.WithMetrics(createMetricsReceiver, stability))
43+
receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability))
4944
}
5045

5146
// createDefaultConfig returns a default config for the receiver.

receiver/awsecscontainermetricsreceiver/internal/metadata/generated_status.go

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
type: awsecscontainermetrics
2+
3+
status:
4+
class: receiver
5+
stability:
6+
beta: [metrics]
7+
distributions: [contrib]
8+

0 commit comments

Comments
 (0)