8000 Rename micrometer tags to follow recommended naming convention by seonghyeoklee · Pull Request #4085 · spring-cloud/spring-cloud-gateway · GitHub
[go: up one dir, main page]
Skip to content

Rename micrometer tags to follow recommended naming convention #4085

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

Open
seonghyeoklee wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −22
Open

Rename micrometer tags to follow recommended naming convention #4085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .../java/org/springframework/cloud/gateway/support/tagsprovider/GatewayHttpTagsProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public Tags apply(ServerWebExchange exchange) {
}
}

return Tags.of("outcome", outcome, "status", status, "httpStatusCode", httpStatusCodeStr, "httpMethod",
return Tags.of("outcome", outcome, "status", status, "http.status.code", httpStatusCodeStr, "http.method",
httpMethod);
}

Expand Down
2 changes: 1 addition & 1 deletion ...java/org/springframework/cloud/gateway/support/tagsprovider/GatewayRouteTagsProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public Tags apply(ServerWebExchange exchange) {
Route route = exchange.getAttribute(GATEWAY_ROUTE_ATTR);

if (route != null) {
return Tags.of("routeId", route.getId(), "routeUri", route.getUri().toString());
return Tags.of("route.id", route.getId(), "route.uri", route.getUri().toString());
}

return Tags.empty();
Expand Down
8 changes: 4 additions & 4 deletions ...st/java/org/springframework/cloud/gateway/filter/GatewayMetricsFilterCustomTagsTests.java
View file
Open in desktop
E880
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ void gatewayRequestsMeterFilterHasCustomTags() {
// default tags
assertMetricsContainsTag("outcome", HttpStatus.Series.SUCCESSFUL.name());
assertMetricsContainsTag("status", HttpStatus.OK.name());
assertMetricsContainsTag("httpStatusCode", String.valueOf(HttpStatus.OK.value()));
assertMetricsContainsTag("httpMethod", HttpMethod.GET.toString());
assertMetricsContainsTag("routeId", "default_path_to_httpbin");
assertMetricsContainsTag("routeUri", testUri);
assertMetricsContainsTag("http.status.code", String.valueOf(HttpStatus.OK.value()));
assertMetricsContainsTag("http.method", HttpMethod.GET.toString());
assertMetricsContainsTag("route.id", "default_path_to_httpbin");
assertMetricsContainsTag("route.uri", testUri);

// custom tags
assertMetricsContainsTag("custom1", "tag1");
Expand Down
24 changes: 12 additions & 12 deletions ...lux/src/test/java/org/springframework/cloud/gateway/filter/GatewayMetricsFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,21 @@ public void gatewayRequestsMeterFilterHasTags() {
testClient.get().uri("/headers").exchange().expectStatus().isOk();
assertMetricsContainsTag("outcome", HttpStatus.Series.SUCCESSFUL.name());
assertMetricsContainsTag("status", HttpStatus.OK.name());
assertMetricsContainsTag("httpStatusCode", String.valueOf(HttpStatus.OK.value()));
assertMetricsContainsTag("httpMethod", HttpMethod.GET.toString());
assertMetricsContainsTag("routeId", "default_path_to_httpbin");
assertMetricsContainsTag("routeUri", testUri);
assertMetricsContainsTag("http.status.code", String.valueOf(HttpStatus.OK.value()));
assertMetricsContainsTag("http.method", HttpMethod.GET.toString());
assertMetricsContainsTag("route.id", "default_path_to_httpbin");
assertMetricsContainsTag("route.uri", testUri);
}

@Test
public void gatewayRequestsMeterFilterHasTagsForBadTargetUri() {
testClient.get().uri("/badtargeturi").exchange().expectStatus().is5xxServerError();
assertMetricsContainsTag("outcome", HttpStatus.Series.SERVER_ERROR.name());
assertMetricsContainsTag("status", HttpStatus.INTERNAL_SERVER_ERROR.name());
assertMetricsContainsTag("httpStatusCode", String.valueOf(HttpStatus.INTERNAL_SERVER_ERROR.value()));
assertMetricsContainsTag("httpMethod", HttpMethod.GET.toString());
assertMetricsContainsTag("routeId", "default_path_to_httpbin");
assertMetricsContainsTag("routeUri", testUri);
assertMetricsContainsTag("http.status.code", String.valueOf(HttpStatus.INTERNAL_SERVER_ERROR.value()));
assertMetricsContainsTag("http.method", HttpMethod.GET.toString());
assertMetricsContainsTag("route.id", "default_path_to_httpbin");
assertMetricsContainsTag("route.uri", testUri);
}

@Test
Expand All @@ -87,10 +87,10 @@ public void hasMetricsForSetStatusFilter() {
assertThat(response.getStatusCode().value()).isEqualTo(432);
assertMetricsContainsTag("outcome", "CUSTOM");
assertMetricsContainsTag("status", "432");
assertMetricsContainsTag("routeId", "test_custom_http_status_metrics");
assertMetricsContainsTag("routeUri", testUri);
assertMetricsContainsTag("httpStatusCode", "432");
assertMetricsContainsTag("httpMethod", HttpMethod.POST.toString());
assertMetricsContainsTag("route.id", "test_custom_http_status_metrics");
assertMetricsContainsTag("route.uri", testUri);
assertMetricsContainsTag("http.status.code", "432");
assertMetricsContainsTag("http.method", HttpMethod.POST.toString());
}

private void assertMetricsContainsTag(String tagKey, String tagValue) {
Expand Down
6 changes: 3 additions & 3 deletions .../org/springframework/cloud/gateway/support/tagsprovider/GatewayHttpTagsProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public class GatewayHttpTagsProviderTests {
private static final String ROUTE_URI = "http://gatewaytagsprovider.org:80";

private static final Tags DEFAULT_TAGS = Tags.of("outcome", OK.series().name(), "status", OK.name(),
"httpStatusCode", String.valueOf(OK.value()), "httpMethod", "GET");
"http.status.code", String.valueOf(OK.value()), "http.method", "GET");

@Test
public void httpTags() {
Expand All @@ -59,7 +59,7 @@ public void nonStandardStatusCode() {

Tags tags = tagsProvider.apply(exchange);
assertThat(tags)
.isEqualTo(Tags.of("outcome", "CUSTOM", "status", "499", "httpMethod", "GET", "httpStatusCode", "499"));
.isEqualTo(Tags.of("outcome", "CUSTOM", "status", "499", "http.method", "GET", "http.status.code", "499"));
}

@Test
Expand All @@ -68,7 +68,7 @@ public void statusNotChanged() {

Tags tags = tagsProvider.apply(exchange);
assertThat(tags)
.isEqualTo(Tags.of("outcome", "CUSTOM", "status", "CUSTOM", "httpStatusCode", "NA", "httpMethod", "GET"));
.isEqualTo(Tags.of("outcome", "CUSTOM", "status", "CUSTOM", "http.status.code", "NA", "http.method", "GET"));
}

@Test
Expand Down
2 changes: 1 addition & 1 deletion ...org/springframework/cloud/gateway/support/tagsprovider/GatewayRouteTagsProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class GatewayRouteTagsProviderTests {

private static final Route ROUTE = Route.async().id(ROUTE_ID).uri(ROUTE_URI).predicate(swe -> true).build();

private static final Tags DEFAULT_TAGS = Tags.of("routeId", ROUTE_ID, "routeUri", ROUTE_URI);
private static final Tags DEFAULT_TAGS = Tags.of("route.id", ROUTE_ID, "route.uri", ROUTE_URI);

@Test
public void routeTags() {
Expand Down
0