Skip to content

Commit 9c7af75

Browse files
mathetakemathetake
authored
refactor: removes deprecated metricsRequestHeaderLabels (#1587)
**Description** metricsRequestHeaderLabels marked deprecated in v0.4 and users are advised to use metricsRequestHeaderAttributes instead. Signed-off-by: Takeshi Yoneda <[email protected]>
1 parent 52793c7 commit 9c7af75

File tree

6 files changed

+2
-71
lines changed

6 files changed

+2
-71
lines changed

‎cmd/controller/main.go‎

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ type flags struct {
4848
tlsKeyName string
4949
caBundleName string
5050
metricsRequestHeaderAttributes string
51-
metricsRequestHeaderLabels string // DEPRECATED: use metricsRequestHeaderAttributes instead.
5251
spanRequestHeaderAttributes string
5352
endpointPrefixes string
5453
rootPrefix string
@@ -145,11 +144,6 @@ func parseAndValidateFlags(args []string) (flags, error) {
145144
"",
146145
"Comma-separated key-value pairs for mapping HTTP request headers to Otel metric attributes. Format: x-team-id:team.id,x-user-id:user.id.",
147146
)
148-
metricsRequestHeaderLabels := fs.String(
149-
"metricsRequestHeaderLabels",
150-
"",
151-
"DEPRECATED: Use --metricsRequestHeaderAttributes instead. This flag will be removed in a future release.",
152-
)
153147
spanRequestHeaderAttributes := fs.String(
154148
"spanRequestHeaderAttributes",
155149
"",
@@ -208,11 +202,6 @@ func parseAndValidateFlags(args []string) (flags, error) {
208202
return flags{}, err
209203
}
210204

211-
// Handle deprecated flag: fall back to metricsRequestHeaderLabels if metricsRequestHeaderAttributes is not set.
212-
if *metricsRequestHeaderAttributes == "" && *metricsRequestHeaderLabels != "" {
213-
*metricsRequestHeaderAttributes = *metricsRequestHeaderLabels
214-
}
215-
216205
var slogLevel slog.Level
217206
if err := slogLevel.UnmarshalText([]byte(*extProcLogLevelPtr)); err != nil {
218207
err = fmt.Errorf("invalid external processor log level: %q", *extProcLogLevelPtr)
@@ -281,7 +270,6 @@ func parseAndValidateFlags(args []string) (flags, error) {
281270
tlsKeyName: *tlsKeyName,
282271
caBundleName: *caBundleName,
283272
metricsRequestHeaderAttributes: *metricsRequestHeaderAttributes,
284-
metricsRequestHeaderLabels: *metricsRequestHeaderLabels,
285273
spanRequestHeaderAttributes: *spanRequestHeaderAttributes,
286274
endpointPrefixes: *endpointPrefixes,
287275
rootPrefix: *rootPrefix,
@@ -304,11 +292,6 @@ func main() {
304292
os.Exit(1)
305293
}
306294

307-
// Warn if deprecated flag is being used.
308-
if parsedFlags.metricsRequestHeaderLabels != "" {
309-
setupLog.Info("The --metricsRequestHeaderLabels flag is deprecated and will be removed in a future release. Please use --metricsRequestHeaderAttributes instead.")
310-
}
311-
312295
ctrl.SetLogger(zap.New(zap.UseFlagOptions(&zap.Options{Development: true, Level: parsedFlags.logLevel})))
313296
k8sConfig := ctrl.GetConfigOrDie()
314297

‎cmd/controller/main_test.go‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -75,28 +75,6 @@ func Test_parseAndValidateFlags(t *testing.T) {
7575
}
7676
})
7777

78-
t.Run("deprecated metricsRequestHeaderLabels flag", func(t *testing.T) {
79-
args := []string{
80-
"--metricsRequestHeaderLabels=x-team-id:team.id",
81-
}
82-
f, err := parseAndValidateFlags(args)
83-
require.NoError(t, err)
84-
// Verify the deprecated flag value is used for metricsRequestHeaderAttributes
85-
require.Equal(t, "x-team-id:team.id", f.metricsRequestHeaderAttributes)
86-
require.Equal(t, "x-team-id:team.id", f.metricsRequestHeaderLabels)
87-
})
88-
89-
t.Run("new flag takes precedence over deprecated flag", func(t *testing.T) {
90-
args := []string{
91-
"--metricsRequestHeaderLabels=x-old:old.value",
92-
"--metricsRequestHeaderAttributes=x-new:new.value",
93-
}
94-
f, err := parseAndValidateFlags(args)
95-
require.NoError(t, err)
96-
// Verify the new flag takes precedence
97-
require.Equal(t, "x-new:new.value", f.metricsRequestHeaderAttributes)
98-
})
99-
10078
t.Run("invalid flags", func(t *testing.T) {
10179
for _, tc := range []struct {
10280
name string

‎cmd/extproc/mainlib/main.go‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ type extProcFlags struct {
4141
logLevel slog.Level // log level for the external processor.
4242
adminPort int // HTTP port for the admin server (metrics and health).
4343
metricsRequestHeaderAttributes string // comma-separated key-value pairs for mapping HTTP request headers to otel metric attributes.
44-
metricsRequestHeaderLabels string // DEPRECATED: use metricsRequestHeaderAttributes instead.
4544
spanRequestHeaderAttributes string // comma-separated key-value pairs for mapping HTTP request headers to otel span attributes.
4645
mcpAddr string // address for the MCP proxy server which can be either tcp or unix domain socket.
4746
mcpSessionEncryptionSeed string // Seed for deriving the key for encrypting MCP sessions.
@@ -84,11 +83,6 @@ func parseAndValidateFlags(args []string) (extProcFlags, error) {
8483
"",
8584
"Comma-separated key-value pairs for mapping HTTP request headers to otel metric attributes. Format: x-team-id:team.id,x-user-id:user.id.",
8685
)
87-
fs.StringVar(&flags.metricsRequestHeaderLabels,
88-
"metricsRequestHeaderLabels",
89-
"",
90-
"DEPRECATED: Use -metricsRequestHeaderAttributes instead. This flag will be removed in a future release.",
91-
)
9286
fs.StringVar(&flags.spanRequestHeaderAttributes,
9387
"spanRequestHeaderAttributes",
9488
"",
@@ -124,11 +118,6 @@ func parseAndValidateFlags(args []string) (extProcFlags, error) {
124118
return extProcFlags{}, fmt.Errorf("failed to parse extProcFlags: %w", err)
125119
}
126120

127-
// Handle deprecated flag: fall back to metricsRequestHeaderLabels if metricsRequestHeaderAttributes is not set.
128-
if flags.metricsRequestHeaderAttributes == "" && flags.metricsRequestHeaderLabels != "" {
129-
flags.metricsRequestHeaderAttributes = flags.metricsRequestHeaderLabels
130-
}
131-
132121
if flags.configPath == "" {
133122
errs = append(errs, fmt.Errorf("configPath must be provided"))
134123
}
@@ -172,11 +161,6 @@ func Main(ctx context.Context, args []string, stderr io.Writer) (err error) {
172161

173162
l := slog.New(slog.NewTextHandler(stderr, &slog.HandlerOptions{Level: flags.logLevel}))
174163

175-
// Warn if deprecated flag is being used.
176-
if flags.metricsRequestHeaderLabels != "" {
177-
l.Warn("The -metricsRequestHeaderLabels flag is deprecated and will be removed in a future release. Please use -metricsRequestHeaderAttributes instead.")
178-
}
179-
180164
l.Info("starting external processor",
181165
slog.String("version", version.Parse()),
182166
slog.String("address", flags.extProcAddr),

‎cmd/extproc/mainlib/main_test.go‎

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -124,17 +124,6 @@ func Test_parseAndValidateFlags(t *testing.T) {
124124
addr: ":1063",
125125
logLevel: slog.LevelInfo,
126126
},
127-
{
128-
name: "with deprecated metricsRequestHeaderLabels flag",
129-
args: []string{
130-
"-configPath", "/path/to/config.yaml",
131-
"-metricsRequestHeaderLabels", "x-team-id:team.id",
132-
},
133-
configPath: "/path/to/config.yaml",
134-
rootPrefix: "/",
135-
addr: ":1063",
136-
logLevel: slog.LevelInfo,
137-
},
138127
} {
139128
t.Run(tc.name, func(t *testing.T) {
140129
flags, err := parseAndValidateFlags(tc.args)

‎manifests/charts/ai-gateway-helm/templates/deployment.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ spec:
4949
{{- if .Values.extProc.imagePullSecrets }}
5050
- --extProcImagePullSecrets={{ include "ai-gateway-helm.extProc.imagePullSecretsString" . }}
5151
{{- end }}
52-
{{- if or .Values.controller.metricsRequestHeaderAttributes .Values.controller.metricsRequestHeaderLabels }}
53-
- --metricsRequestHeaderAttributes={{ .Values.controller.metricsRequestHeaderAttributes | default .Values.controller.metricsRequestHeaderLabels }}
52+
{{- if .Values.controller.metricsRequestHeaderAttributes }}
53+
- --metricsRequestHeaderAttributes={{ .Values.controller.metricsRequestHeaderAttributes }}
5454
{{- end }}
5555
{{- if .Values.controller.spanRequestHeaderAttributes }}
5656
- --spanRequestHeaderAttributes={{ .Values.controller.spanRequestHeaderAttributes }}

‎manifests/charts/ai-gateway-helm/values.yaml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,6 @@ controller:
5454
nameOverride: ""
5555
fullnameOverride: "ai-gateway-controller"
5656

57-
# DEPRECATED: metricsRequestHeaderLabels will be removed after v0.4. Use metricsRequestHeaderAttributes instead.
58-
metricsRequestHeaderLabels: ""
59-
6057
# Comma-separated key-value pairs for mapping HTTP request headers to Otel metric attributes.
6158
# Format: "header1:label1,header2:label2"
6259
# Example: "x-team-id:team.id,x-user-id:user.id"

0 commit comments

Comments
 (0)