Skip to content

Commit

Permalink
[mdatagen] produce scope name with full url (#9556)
Browse files Browse the repository at this point in the history
This is part of #9494

---------

Signed-off-by: Alex Boten <aboten@lightstep.com>
  • Loading branch information
Alex Boten committed Feb 14, 2024
1 parent 1c7cebb commit aa76482
Show file tree
Hide file tree
Showing 18 changed files with 98 additions and 66 deletions.
25 changes: 25 additions & 0 deletions .chloggen/codeboten_consisten-scope-name.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: all

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: scope name for all generated Meter/Tracer funcs now includes full package name

# One or more tracking issues or pull requests related to the change
issues: [9494]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
2 changes: 1 addition & 1 deletion cmd/mdatagen/internal/metadata/generated_metrics.go

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

7 changes: 4 additions & 3 deletions cmd/mdatagen/internal/metadata/generated_status.go

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

30 changes: 11 additions & 19 deletions cmd/mdatagen/loader.go
Original file line number Diff line number Diff line change
Expand Up @@ -267,18 +267,18 @@ 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 },
var componentTypes = []string{
"connector",
"exporter",
"extension",
"processor",
"scraper",
"receiver",
}

func shortFolderName(filePath string) string {
parentFolder := filepath.Base(filepath.Dir(filePath))
for cType := range componentTypes {
for _, cType := range componentTypes {
if strings.HasSuffix(parentFolder, cType) {
return strings.TrimSuffix(parentFolder, cType)
}
Expand All @@ -287,20 +287,12 @@ func shortFolderName(filePath string) string {
}

func scopeName(filePath string) string {
sn := "otelcol"
sn := "go.opentelemetry.io/collector"
dirs := strings.Split(filepath.Dir(filePath), string(os.PathSeparator))
for _, dir := range dirs {
// skip directory names for component types
if _, ok := componentTypes[dir]; ok {
continue
}
// 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 {
for _, cType := range componentTypes {
if strings.HasSuffix(dir, cType) {
sn += "/" + normalizeFunc(dir)
sn += "/" + dir
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/mdatagen/loader_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ func Test_loadMetadata(t *testing.T) {
},
},
},
ScopeName: "otelcol",
ScopeName: "go.opentelemetry.io/collector",
ShortFolderName: ".",
},
},
Expand All @@ -223,7 +223,7 @@ func Test_loadMetadata(t *testing.T) {
want: metadata{
Type: "subcomponent",
Parent: "parentComponent",
ScopeName: "otelcol",
ScopeName: "go.opentelemetry.io/collector",
ShortFolderName: "testdata",
},
},
Expand Down
14 changes: 8 additions & 6 deletions cmd/mdatagen/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -366,19 +366,20 @@ import (
)
var (
Type = component.MustNewType("foo")
Type = component.MustNewType("foo")
scopeName = ""
)
const (
MetricsStability = component.StabilityLevelBeta
)
func Meter(settings component.TelemetrySettings) metric.Meter {
return settings.MeterProvider.Meter("")
return settings.MeterProvider.Meter(scopeName)
}
func Tracer(settings component.TelemetrySettings) trace.Tracer {
return settings.TracerProvider.Tracer("")
return settings.TracerProvider.Tracer(scopeName)
}
`,
},
Expand All @@ -403,19 +404,20 @@ import (
)
var (
Type = component.MustNewType("foo")
Type = component.MustNewType("foo")
scopeName = ""
)
const (
MetricsStability = component.StabilityLevelAlpha
)
func Meter(settings component.TelemetrySettings) metric.Meter {
return settings.MeterProvider.Meter("")
return settings.MeterProvider.Meter(scopeName)
}
func Tracer(settings component.TelemetrySettings) trace.Tracer {
return settings.TracerProvider.Tracer("")
return settings.TracerProvider.Tracer(scopeName)
}
`,
},
Expand Down
5 changes: 3 additions & 2 deletions cmd/mdatagen/templates/status.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (

var (
Type = component.MustNewType("{{ .Type }}")
scopeName = "{{ .ScopeName }}"
)

const (
Expand All @@ -21,9 +22,9 @@ const (
)

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

func Tracer(settings component.TelemetrySettings) trace.Tracer {
return settings.TracerProvider.Tracer("{{ .ScopeName }}")
return settings.TracerProvider.Tracer(scopeName)
}

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

7 changes: 4 additions & 3 deletions exporter/debugexporter/internal/metadata/generated_status.go

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

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

7 changes: 4 additions & 3 deletions exporter/otlpexporter/internal/metadata/generated_status.go

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

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

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

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

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

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

Loading

0 comments on commit aa76482

Please sign in to comment.