Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[mdatagen] add Meter/Tracer func to simplify instrumenting code #29927

Merged
merged 5 commits into from
Dec 18, 2023
Merged

[mdatagen] add Meter/Tracer func to simplify instrumenting code #29927

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dc707ab
[chore] refactor mdatagen loader code
Dec 15, 2023
96a07f3
[mdatagen] add Meter func to simplify getting a Meter
Dec 15, 2023
de9a797
add Tracer method as well
Dec 15, 2023
0041166
tidy
Dec 15, 2023
9d1e90a
add changelog
Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions cmd/mdatagen/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ require (
go.opentelemetry.io/collector/pdata v1.0.0
go.opentelemetry.io/collector/receiver v0.91.0
go.opentelemetry.io/collector/semconv v0.91.0
go.opentelemetry.io/otel/metric v1.21.0
go.opentelemetry.io/otel/trace v1.21.0
go.uber.org/multierr v1.11.0
go.uber.org/zap v1.26.0
golang.org/x/text v0.14.0
Expand All @@ -34,8 +36,6 @@ require (
go.opentelemetry.io/collector/consumer v0.91.0 // indirect
go.opentelemetry.io/collector/featuregate v1.0.0 // indirect
go.opentelemetry.io/otel v1.21.0 // indirect
go.opentelemetry.io/otel/metric v1.21.0 // indirect
go.opentelemetry.io/otel/trace v1.21.0 // indirect
golang.org/x/net v0.18.0 // indirect
golang.org/x/sys v0.15.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20230822172742-b8732ec3820d // indirect
Expand Down
10 changes: 10 additions & 0 deletions cmd/mdatagen/internal/metadata/generated_status.go
View file
Open in desktop

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

42 changes: 24 additions & 18 deletions cmd/mdatagen/loader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,22 +267,21 @@ func loadMetadata(filePath string) (metadata, error) {
return md, nil
}

var componentTypes = map[string]func(string) string{
"connector": func(in string) string { return strings.TrimSuffix(in, "connector") },
"exporter": func(in string) string { return strings.TrimSuffix(in, "exporter") },
"extension": func(in string) string { return strings.TrimSuffix(in, "extension") },
"processor": func(in string) string { return strings.TrimSuffix(in, "processor") },
"scraper": func(in string) string { return strings.TrimSuffix(in, "scraper") },
"receiver": func(in string) string { return in },
}

func shortFolderName(filePath string) string {
parentFolder := filepath.Base(filepath.Dir(filePath))
if strings.HasSuffix(parentFolder, "connector") {
return strings.TrimSuffix(parentFolder, "connector")
}
if strings.HasSuffix(parentFolder, "exporter") {
return strings.TrimSuffix(parentFolder, "exporter")
}
if strings.HasSuffix(parentFolder, "extension") {
return strings.TrimSuffix(parentFolder, "extension")
}
if strings.HasSuffix(parentFolder, "processor") {
return strings.TrimSuffix(parentFolder, "processor")
}
if strings.HasSuffix(parentFolder, "receiver") {
return strings.TrimSuffix(parentFolder, "receiver")
for cType := range componentTypes {
if strings.HasSuffix(parentFolder, cType) {
return strings.TrimSuffix(parentFolder, cType)
}
}
return parentFolder
}
Expand All @@ -291,11 +290,18 @@ func scopeName(filePath string) string {
sn := "otelcol"
dirs := strings.Split(filepath.Dir(filePath), string(os.PathSeparator))
for _, dir := range dirs {
if dir != "receiver" && strings.HasSuffix(dir, "receiver") {
sn += "/" + dir
// skip directory names for component types
if _, ok := componentTypes[dir]; ok {
continue
}
if dir != "scraper" && strings.HasSuffix(dir, "scraper") {
sn += "/" + strings.TrimSuffix(dir, "scraper")
// note here that the only component that receives a different
// treatment is receivers. this is to prevent breaking backwards
// compatibility for anyone that's using the generated metrics w/
// scope names today.
for cType, normalizeFunc := range componentTypes {
if strings.HasSuffix(dir, cType) {
sn += "/" + normalizeFunc(dir)
}
}
}
return sn
Expand Down
20 changes: 20 additions & 0 deletions cmd/mdatagen/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,12 +324,22 @@ package metadata

import (
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/trace"
)

const (
Type = "foo"
MetricsStability = component.StabilityLevelBeta
)

func Meter(settings component.TelemetrySettings) metric.Meter {
return settings.MeterProvider.Meter("")
}

func Tracer(settings component.TelemetrySettings) trace.Tracer {
return settings.TracerProvider.Tracer("")
}
`,
},
{
Expand All @@ -348,12 +358,22 @@ package metadata

import (
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/trace"
)

const (
Type = "foo"
MetricsStability = component.StabilityLevelAlpha
)

func Meter(settings component.TelemetrySettings) metric.Meter {
return settings.MeterProvider.Meter("")
}

func Tracer(settings component.TelemetrySettings) trace.Tracer {
return settings.TracerProvider.Tracer("")
}
`,
},
}
Expand Down
14 changes: 11 additions & 3 deletions cmd/mdatagen/templates/status.go.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

package {{ .Package }}

{{- if .Status.Stability }}
import (
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/trace"
)
{{- end }}

const (
Type = "{{ .Type }}"
Expand All @@ -15,4 +15,12 @@ const (
{{ toCamelCase $signal }}Stability = component.StabilityLevel{{ casesTitle $stability }}
{{- end }}
{{- end }}
)
)

func Meter(settings component.TelemetrySettings) metric.Meter {
return settings.MeterProvider.Meter("{{ .ScopeName }}")
}

func Tracer(settings component.TelemetrySettings) trace.Tracer {
return settings.TracerProvider.Tracer("{{ .ScopeName }}")
}
4 changes: 2 additions & 2 deletions connector/countconnector/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ require (
go.opentelemetry.io/collector/connector v0.91.0
go.opentelemetry.io/collector/consumer v0.91.0
go.opentelemetry.io/collector/pdata v1.0.0
go.opentelemetry.io/otel/metric v1.21.0
go.opentelemetry.io/otel/trace v1.21.0
go.uber.org/zap v1.26.0
)

Expand Down Expand Up @@ -43,8 +45,6 @@ require (
go.opentelemetry.io/collector/config/configtelemetry v0.91.0 // indirect
go.opentelemetry.io/collector/featuregate v1.0.0 // indirect
go.opentelemetry.io/otel v1.21.0 // indirect
go.opentelemetry.io/otel/metric v1.21.0 // indirect
go.opentelemetry.io/otel/trace v1.21.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/exp v0.0.0-20231206192017-f3f8817b8deb // indirect
golang.org/x/net v0.18.0 // indirect
Expand Down
10 changes: 10 additions & 0 deletions connector/countconnector/internal/metadata/generated_status.go
View file
Open in desktop

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

4 changes: 2 additions & 2 deletions connector/datadogconnector/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ require (
go.opentelemetry.io/collector/connector v0.91.0
go.opentelemetry.io/collector/consumer v0.91.0
go.opentelemetry.io/collector/pdata v1.0.0
go.opentelemetry.io/otel/metric v1.21.0
go.opentelemetry.io/otel/trace v1.21.0
go.uber.org/zap v1.26.0
)

Expand Down Expand Up @@ -74,8 +76,6 @@ require (
go.opentelemetry.io/collector/featuregate v1.0.0 // indirect
go.opentelemetry.io/collector/semconv v0.91.0 // indirect
go.opentelemetry.io/otel v1.21.0 // indirect
go.opentelemetry.io/otel/metric v1.21.0 // indirect
go.opentelemetry.io/otel/trace v1.21.0 // indirect
go.uber.org/atomic v1.11.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/exp v0.0.0-20230711023510-fffb14384f22 // indirect
Expand Down
10 changes: 10 additions & 0 deletions connector/datadogconnector/internal/metadata/generated_status.go
View file
Open in desktop

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

4 changes: 2 additions & 2 deletions connector/exceptionsconnector/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ require (
go.opentelemetry.io/collector/consumer v0.91.0
go.opentelemetry.io/collector/pdata v1.0.0
go.opentelemetry.io/collector/semconv v0.91.0
go.opentelemetry.io/otel/metric v1.21.0
go.opentelemetry.io/otel/trace v1.21.0
go.uber.org/zap v1.26.0
google.golang.org/grpc v1.60.0
)
Expand All @@ -38,8 +40,6 @@ require (
go.opentelemetry.io/collector/config/configtelemetry v0.91.0 // indirect
go.opentelemetry.io/collector/featuregate v1.0.0 // indirect
go.opentelemetry.io/otel v1.21.0 // indirect
go.opentelemetry.io/otel/metric v1.21.0 // indirect
go.opentelemetry.io/otel/trace v1.21.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/net v0.18.0 // indirect
golang.org/x/sys v0.15.0 // indirect
Expand Down
10 changes: 10 additions & 0 deletions connector/exceptionsconnector/internal/metadata/generated_status.go
View file
Open in desktop

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

4 changes: 2 additions & 2 deletions connector/failoverconnector/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ require (
go.opentelemetry.io/collector/connector v0.91.0
go.opentelemetry.io/collector/consumer v0.91.0
go.opentelemetry.io/collector/pdata v1.0.0
go.opentelemetry.io/otel/metric v1.21.0
go.opentelemetry.io/otel/trace v1.21.0
go.uber.org/zap v1.26.0
)

Expand All @@ -31,8 +33,6 @@ require (
go.opentelemetry.io/collector/config/configtelemetry v0.91.0 // indirect
go.opentelemetry.io/collector/featuregate v1.0.0 // indirect
go.opentelemetry.io/otel v1.21.0 // indirect
go.opentelemetry.io/otel/metric v1.21.0 // indirect
go.opentelemetry.io/otel/trace v1.21.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/net v0.18.0 // indirect
golang.org/x/sys v0.15.0 // indirect
Expand Down
10 changes: 10 additions & 0 deletions connector/failoverconnector/internal/metadata/generated_status.go
View file
Open in desktop

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

4 changes: 2 additions & 2 deletions connector/routingconnector/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ require (
go.opentelemetry.io/collector/connector v0.91.0
go.opentelemetry.io/collector/consumer v0.91.0
go.opentelemetry.io/collector/pdata v1.0.0
go.opentelemetry.io/otel/metric v1.21.0
go.opentelemetry.io/otel/trace v1.21.0
go.uber.org/zap v1.26.0
)

Expand Down Expand Up @@ -37,8 +39,6 @@ require (
go.opentelemetry.io/collector/config/configtelemetry v0.91.0 // indirect
go.opentelemetry.io/collector/featuregate v1.0.0 // indirect
go.opentelemetry.io/otel v1.21.0 // indirect
go.opentelemetry.io/otel/metric v1.21.0 // indirect
go.opentelemetry.io/otel/trace v1.21.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/exp v0.0.0-20231206192017-f3f8817b8deb // indirect
golang.org/x/net v0.18.0 // indirect
Expand Down
10 changes: 10 additions & 0 deletions connector/routingconnector/internal/metadata/generated_status.go
View file
Open in desktop

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

4 changes: 2 additions & 2 deletions connector/servicegraphconnector/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ require (
go.opentelemetry.io/collector/component v0.91.0
go.opentelemetry.io/collector/connector v0.91.0
go.opentelemetry.io/collector/consumer v0.91.0
go.opentelemetry.io/otel/metric v1.21.0
go.opentelemetry.io/otel/trace v1.21.0
)

require (
Expand Down Expand Up @@ -35,8 +37,6 @@ require (
go.opentelemetry.io/collector/processor v0.91.0 // indirect
go.opentelemetry.io/collector/semconv v0.91.0 // indirect
go.opentelemetry.io/otel v1.21.0 // indirect
go.opentelemetry.io/otel/metric v1.21.0 // indirect
go.opentelemetry.io/otel/trace v1.21.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.26.0 // indirect
golang.org/x/net v0.19.0 // indirect
Expand Down
Loading
Loading