Skip to content

Commit

Permalink
[exporter/f5cloud] use generated status header (open-telemetry#22091)
Browse files Browse the repository at this point in the history
This PR updates the component to generate the status table using mdatagen.

Linked issue: open-telemetry#21213

---------

Signed-off-by: Alex Boten <aboten@lightstep.com>
  • Loading branch information
Alex Boten authored and Caleb-Hurshman committed Jul 6, 2023
1 parent f9b2523 commit fc6ffee
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 15 deletions.
21 changes: 11 additions & 10 deletions exporter/f5cloudexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# F5 Cloud Exporter

| Status | |
| ------------------------ |-----------------------|
| Stability | [beta] |
| Supported pipeline types | traces, logs, metrics |
| Distributions | [contrib], [observiq] |
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [beta]: traces, metrics, logs |
| Distributions | [contrib], [observiq] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[observiq]: https://github.com/observIQ/observiq-otel-collector
<!-- end autogenerated section -->

Exports data via HTTP to [F5 Cloud](https://portal.cloudservices.f5.com/).
Exports data via HTTP to F5 Cloud.

## Getting Started

Expand Down Expand Up @@ -42,7 +47,3 @@ configurations [here](./testdata/config.yaml).

This exporter also offers proxy support as documented
[here](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter#proxy-support).

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[observiq]: https://github.com/observIQ/observiq-otel-collector
4 changes: 3 additions & 1 deletion exporter/f5cloudexporter/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import (
"go.opentelemetry.io/collector/confmap/confmaptest"
"go.opentelemetry.io/collector/exporter/exporterhelper"
otlphttp "go.opentelemetry.io/collector/exporter/otlphttpexporter"

"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/f5cloudexporter/internal/metadata"
)

func TestLoadConfig(t *testing.T) {
Expand All @@ -25,7 +27,7 @@ func TestLoadConfig(t *testing.T) {
factory := NewFactory()
cfg := factory.CreateDefaultConfig()

sub, err := cm.Sub(component.NewIDWithName(typeStr, "allsettings").String())
sub, err := cm.Sub(component.NewIDWithName(metadata.Type, "allsettings").String())
require.NoError(t, err)
require.NoError(t, component.UnmarshalConfig(sub, cfg))

Expand Down
2 changes: 2 additions & 0 deletions exporter/f5cloudexporter/doc.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

//go:generate mdatagen metadata.yaml

// Package f5cloudexporter implements an OpenTelemetry Collector exporter that sends trace, metric, and log data to F5 Cloud.
package f5cloudexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/f5cloudexporter"
6 changes: 3 additions & 3 deletions exporter/f5cloudexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ import (
otlphttp "go.opentelemetry.io/collector/exporter/otlphttpexporter"
"golang.org/x/oauth2"
"google.golang.org/api/idtoken"
)

const typeStr = "f5cloud" // The value of "type" key in configuration.
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/f5cloudexporter/internal/metadata"
)

type TokenSourceGetter func(config *Config) (oauth2.TokenSource, error)

Expand All @@ -35,7 +35,7 @@ func NewFactoryWithTokenSourceGetter(tsg TokenSourceGetter) exporter.Factory {
}

func (f *f5cloudFactory) Type() component.Type {
return typeStr
return metadata.Type
}

func (f *f5cloudFactory) CreateMetricsExporter(
Expand Down
3 changes: 2 additions & 1 deletion exporter/f5cloudexporter/factory_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ import (
"go.opentelemetry.io/collector/exporter/exportertest"
"golang.org/x/oauth2"

"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/f5cloudexporter/internal/metadata"
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/common/testutil"
)

func TestFactory_TestType(t *testing.T) {
f := NewFactory()
assert.Equal(t, f.Type(), component.Type(typeStr))
assert.Equal(t, f.Type(), component.Type(metadata.Type))
}

func TestFactory_CreateDefaultConfig(t *testing.T) {
Expand Down
14 changes: 14 additions & 0 deletions exporter/f5cloudexporter/internal/metadata/generated_status.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions exporter/f5cloudexporter/metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
type: f5cloud

status:
class: exporter
stability:
beta: [traces, metrics, logs]
distributions: [contrib, observiq]

0 comments on commit fc6ffee

Please sign in to comment.