Skip to content

Implement normalised http routes #4101

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

Draft
estringana wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Implement normalised http routes #4101

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
7 changes: 6 additions & 1 deletion src/DDTrace/Integrations/CakePHP/CakePHPIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,12 @@ public static function init(): int

$rootSpan = \DDTrace\root_span();
if ($rootSpan !== null) {
$rootSpan->meta[Tag::HTTP_ROUTE] = $app->template;
$template = $app->template;
$rootSpan->meta[Tag::HTTP_ROUTE] = $template;
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromCakePHP($template);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
}
};

Expand Down
12 changes: 12 additions & 0 deletions src/DDTrace/Integrations/CodeIgniter/V2/CodeIgniterIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,10 @@ private static function setHttpRoute($router, $rootSpan) {
if (isset($router->routes[$uri]))
{
$rootSpan->meta[Tag::HTTP_ROUTE] = $uri;
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromCodeIgniter($uri);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
return;
}

Expand All @@ -244,12 +248,20 @@ private static function setHttpRoute($router, $rootSpan) {
if (preg_match('#^'.$key.'$#', $uri))
{
$rootSpan->meta[Tag::HTTP_ROUTE] = $origKey;
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromCodeIgniter($origKey);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
return;
}
}

// If we got this far it means we didn't encounter a
// matching route so we'll set the site default route
$rootSpan->meta[Tag::HTTP_ROUTE] = $uri;
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromCodeIgniter($uri);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
}
}
5 changes: 5 additions & 0 deletions src/DDTrace/Integrations/Laminas/LaminasIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,11 @@ static function (SpanData $span) use ($controller, $action) {
$httpRoute = LaminasIntegration::httpRouteTemplateFromNamedRouteStack($this, (string) $routeName);
if ($httpRoute !== null && $httpRoute !== '') {
$rootSpan->meta[Tag::HTTP_ROUTE] = $httpRoute;
$allParams = method_exists($routeMatch, 'getParams') ? ($routeMatch->getParams() ?? []) : [];
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromLaminas($httpRoute, $allParams);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
}
}

Expand Down
8 changes: 7 additions & 1 deletion src/DDTrace/Integrations/Laravel/LaravelIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,13 @@ static function ($This, $scope, $args, $route) {
$rootSpan->meta[Tag::HTTP_URL] = \DDTrace\Util\Normalizer::urlSanitize($request->fullUrl());
}
if (\method_exists($route, 'uri')) {
$rootSpan->meta[Tag::HTTP_ROUTE] = $route->uri();
$httpRoute = $route->uri();
$rootSpan->meta[Tag::HTTP_ROUTE] = $httpRoute;
$matchedParams = \method_exists($route, 'parameters') ? ($route->parameters() ?? []) : [];
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromLaravel($httpRoute, $matchedParams);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
}
if (\method_exists($route, 'parameters') && function_exists('\datadog\appsec\push_addresses')) {
$parameters = $route->parameters();
Expand Down
26 changes: 23 additions & 3 deletions src/DDTrace/Integrations/Slim/SlimIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,16 @@ static function ($errorMiddleware, $self, $args) use ($rootSpan, $integration) {
null,
static function ($router, $scope, $args, $return) use ($rootSpan) {
/** @var \Slim\Interfaces\RouteInterface $return */
$rootSpan->meta[Tag::HTTP_ROUTE] = $return->getPattern();
$pattern = $return->getPattern();
$rootSpan->meta[Tag::HTTP_ROUTE] = $pattern;
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromSlim($pattern);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}

if (dd_trace_env_config("DD_HTTP_SERVER_ROUTE_BASED_NAMING")) {
$rootSpan->resource =
$_SERVER['REQUEST_METHOD'] . ' ' . ($return->getName() ?: $return->getPattern());
$_SERVER['REQUEST_METHOD'] . ' ' . ($return->getName() ?: $pattern);
}
}
);
Expand All @@ -92,7 +97,13 @@ static function ($router, $scope, $args, $return) use ($rootSpan) {
static function ($router, $scope, $args, $return) use ($rootSpan) {
/** @var \Slim\Interfaces\RouteInterface $route */
$route = $return;
$rootSpan->meta[Tag::HTTP_ROUTE] = $route->getPattern();
$pattern = $route->getPattern();
$rootSpan->meta[Tag::HTTP_ROUTE] = $pattern;
// Normalized route will be refined in traceControllers once matched params are available
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromSlim($pattern);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
}
);
}
Expand Down Expand Up @@ -131,6 +142,15 @@ static function ($router, $scope, $args, $return) use ($rootSpan) {
$span->meta['slim.route.name'] = $routeName;
$rootSpan->meta['slim.route.name'] = $routeName;
}
// Refine normalized route now that matched params are available
$matchedParams = method_exists($route, 'getArguments') ? ($route->getArguments() ?? []) : [];
$pattern = isset($rootSpan->meta[Tag::HTTP_ROUTE]) ? $rootSpan->meta[Tag::HTTP_ROUTE] : '';
if ($pattern !== '') {
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromSlim($pattern, $matchedParams);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
}
}
} else {
$rootSpan->meta['slim.route.controller'] = $callableName;
Expand Down
4 changes: 4 additions & 0 deletions src/DDTrace/Integrations/Symfony/SymfonyIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,10 @@ static function() {

if ($path !== null) {
$rootSpan->meta[Tag::HTTP_ROUTE] = $path;
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromSymfony($path);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
}
};
} else {
Expand Down
7 changes: 6 additions & 1 deletion src/DDTrace/Integrations/WordPress/WordPressIntegrationLoader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,7 +732,12 @@ static function (HookData $hook) use (
function_exists('is_404') && is_404() === false) {
$rootSpan = \DDTrace\root_span();
if (\property_exists($This, 'matched_rule')) {
$rootSpan->meta[Tag::HTTP_ROUTE] = $This->matched_rule;
$matchedRule = $This->matched_rule;
$rootSpan->meta[Tag::HTTP_ROUTE] = $matchedRule;
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromWordPress($matchedRule);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}
}
}
});
Expand Down
4 changes: 4 additions & 0 deletions src/DDTrace/Integrations/Yii/YiiIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ function (SpanData $span, $args) use (&$firstController) {

$rootSpan->meta['app.route.path'] = $routePath;
$rootSpan->meta[Tag::HTTP_ROUTE] = $routePath;
$normalizedRoute = \DDTrace\Util\RouteNormalizer::normalizeFromYii($routePath);
if ($normalizedRoute !== null) {
$rootSpan->meta[Tag::APPSEC_NORMALIZED_ROUTE] = $normalizedRoute;
}

if (dd_trace_env_config("DD_HTTP_SERVER_ROUTE_BASED_NAMING")) {
$resourceName = \str_replace(
Expand Down
Loading
Loading