508 lines
16 KiB
Perl
508 lines
16 KiB
Perl
#!/usr/bin/perl
|
|
|
|
# (C) Nginx, Inc.
|
|
|
|
# Tests for OTel exporter in case HTTP/3.
|
|
|
|
###############################################################################
|
|
|
|
use warnings;
|
|
use strict;
|
|
|
|
use Test::More;
|
|
|
|
BEGIN { use FindBin; chdir($FindBin::Bin); }
|
|
|
|
use Test::Nginx;
|
|
use Test::Nginx::HTTP2;
|
|
use Test::Nginx::HTTP3;
|
|
use MIME::Base64;
|
|
|
|
###############################################################################
|
|
|
|
select STDERR; $| = 1;
|
|
select STDOUT; $| = 1;
|
|
|
|
my $t = Test::Nginx->new()->has(qw/http_v2 http_v3 rewrite mirror grpc cryptx/)
|
|
->has_daemon(qw/openssl base64/)
|
|
->write_file_expand('nginx.conf', <<'EOF');
|
|
|
|
%%TEST_GLOBALS%%
|
|
|
|
daemon off;
|
|
|
|
events {
|
|
}
|
|
|
|
http {
|
|
%%TEST_GLOBALS_HTTP%%
|
|
|
|
ssl_certificate_key localhost.key;
|
|
ssl_certificate localhost.crt;
|
|
ssl_protocols TLSv1.3;
|
|
|
|
otel_exporter {
|
|
endpoint 127.0.0.1:8082;
|
|
interval 1s;
|
|
batch_size 10;
|
|
batch_count 2;
|
|
}
|
|
|
|
otel_service_name test_server;
|
|
otel_trace on;
|
|
|
|
server {
|
|
listen 127.0.0.1:%%PORT_8980_UDP%% quic;
|
|
listen 127.0.0.1:8081;
|
|
server_name localhost;
|
|
|
|
location /trace-on {
|
|
otel_trace_context extract;
|
|
otel_span_name default_location;
|
|
otel_span_attr http.request.header.completion
|
|
$request_completion;
|
|
otel_span_attr http.response.header.content.type
|
|
$sent_http_content_type;
|
|
otel_span_attr http.request $request;
|
|
add_header "X-Otel-Trace-Id" $otel_trace_id;
|
|
add_header "X-Otel-Span-Id" $otel_span_id;
|
|
add_header "X-Otel-Parent-Id" $otel_parent_id;
|
|
add_header "X-Otel-Parent-Sampled" $otel_parent_sampled;
|
|
return 200 "TRACE-ON";
|
|
}
|
|
|
|
location /context-ignore {
|
|
otel_trace_context ignore;
|
|
otel_span_name context_ignore;
|
|
add_header "X-Otel-Parent-Id" $otel_parent_id;
|
|
proxy_pass http://127.0.0.1:8081/trace-off;
|
|
}
|
|
|
|
location /context-extract {
|
|
otel_trace_context extract;
|
|
otel_span_name context_extract;
|
|
add_header "X-Otel-Parent-Id" $otel_parent_id;
|
|
proxy_pass http://127.0.0.1:8081/trace-off;
|
|
}
|
|
|
|
location /context-inject {
|
|
otel_trace_context inject;
|
|
otel_span_name context_inject;
|
|
add_header "X-Otel-Parent-Id" $otel_parent_id;
|
|
proxy_pass http://127.0.0.1:8081/trace-off;
|
|
}
|
|
|
|
location /context-propagate {
|
|
otel_trace_context propagate;
|
|
otel_span_name context_propogate;
|
|
add_header "X-Otel-Parent-Id" $otel_parent_id;
|
|
proxy_pass http://127.0.0.1:8081/trace-off;
|
|
}
|
|
|
|
location /trace-off {
|
|
otel_trace off;
|
|
add_header "X-Otel-Traceparent" $http_traceparent;
|
|
add_header "X-Otel-Tracestate" $http_tracestate;
|
|
return 200 "TRACE-OFF";
|
|
}
|
|
}
|
|
|
|
server {
|
|
listen 127.0.0.1:8082 http2;
|
|
server_name localhost;
|
|
otel_trace off;
|
|
|
|
location / {
|
|
mirror /mirror;
|
|
grpc_pass 127.0.0.1:8083;
|
|
}
|
|
|
|
location /mirror {
|
|
internal;
|
|
grpc_pass 127.0.0.1:%%PORT_4317%%;
|
|
}
|
|
}
|
|
|
|
server {
|
|
listen 127.0.0.1:8083 http2;
|
|
server_name localhost;
|
|
otel_trace off;
|
|
|
|
location / {
|
|
add_header content-type application/grpc;
|
|
add_header grpc-status 0;
|
|
add_header grpc-message "";
|
|
return 200;
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
EOF
|
|
|
|
$t->write_file('openssl.conf', <<'EOF');
|
|
[ req ]
|
|
default_bits = 2048
|
|
encrypt_key = no
|
|
distinguished_name = req_distinguished_name
|
|
[ req_distinguished_name ]
|
|
|
|
EOF
|
|
|
|
my $d = $t->testdir();
|
|
|
|
foreach my $name ('localhost') {
|
|
system('openssl req -x509 -new '
|
|
. "-config $d/openssl.conf -subj /CN=$name/ "
|
|
. "-out $d/$name.crt -keyout $d/$name.key "
|
|
. ">>$d/openssl.out 2>&1") == 0
|
|
or die "Can't create certificate for $name: $!\n";
|
|
}
|
|
|
|
$t->try_run('no OTel module')->plan(56);
|
|
|
|
###############################################################################
|
|
|
|
my $p = port(4317);
|
|
my $f = grpc();
|
|
|
|
#do requests
|
|
(undef, my $t_off_resp) = http3_get('/trace-off');
|
|
|
|
#batch0 (10 requests)
|
|
my ($tp_headers, $tp_resp) = http3_get('/trace-on', trace_headers => 1);
|
|
my ($t_headers, $t_resp) = http3_get('/trace-on');
|
|
|
|
(my $t_headers_ignore, undef) = http3_get('/context-ignore');
|
|
(my $tp_headers_ignore, undef) = http3_get('/context-ignore',
|
|
trace_headers => 1);
|
|
(my $t_headers_extract, undef) = http3_get('/context-extract');
|
|
(my $tp_headers_extract, undef) = http3_get('/context-extract',
|
|
trace_headers => 1);
|
|
(my $t_headers_inject, undef) = http3_get('/context-inject');
|
|
(my $tp_headers_inject, undef) = http3_get('/context-inject',
|
|
trace_headers => 1);
|
|
(my $t_headers_propagate, undef) = http3_get('/context-propagate');
|
|
(my $tp_headers_propagate, undef) =
|
|
http3_get('/context-propagate', trace_headers => 1);
|
|
|
|
my ($frame) = grep { $_->{type} eq "DATA" } @{$f->{http_start}()};
|
|
my $batch0 = to_hash(decode_protobuf(substr $frame->{data}, 8));
|
|
my $spans = $$batch0{scope_spans};
|
|
|
|
#batch1 (5 reqeusts)
|
|
http3_get('/trace-on') for (1..5);
|
|
|
|
($frame) = grep { $_->{type} eq "DATA" } @{$f->{http_start}()};
|
|
my $batch1 = to_hash(decode_protobuf(substr $frame->{data}, 8));
|
|
|
|
#validate responses
|
|
like($tp_resp, qr/TRACE-ON/, 'http request1 - trace on');
|
|
like($t_resp, qr/TRACE-ON/, 'http request2 - trace on');
|
|
like($t_off_resp, qr/TRACE-OFF/, 'http request - trace off');
|
|
|
|
#validate batch size
|
|
delete $$spans{scope}; #remove 'scope' entry
|
|
is(scalar keys %{$spans}, 10, 'batch0 size - trace on');
|
|
delete $$batch1{scope_spans}{scope}; #remove 'scope' entry
|
|
is(scalar keys %{$$batch1{scope_spans}}, 5, 'batch1 size - trace on');
|
|
|
|
#validate general attributes
|
|
is(get_attr("service.name", "string_value",
|
|
$$batch0{resource}),
|
|
'test_server', 'service.name - trace on');
|
|
is($$spans{span0}{name}, '"default_location"', 'span.name - trace on');
|
|
|
|
#validate metrics
|
|
is(get_attr("http.method", "string_value", $$spans{span0}), 'GET',
|
|
'http.method metric - trace on');
|
|
is(get_attr("http.target", "string_value", $$spans{span0}), '/trace-on',
|
|
'http.target metric - trace on');
|
|
is(get_attr("http.route", "string_value", $$spans{span0}), '/trace-on',
|
|
'http.route metric - trace on');
|
|
is(get_attr("http.scheme", "string_value", $$spans{span0}), 'https',
|
|
'http.scheme metric - trace on');
|
|
is(get_attr("http.flavor", "string_value", $$spans{span0}), '3.0',
|
|
'http.flavor metric - trace on');
|
|
is(get_attr("http.user_agent", "string_value", $$spans{span0}), 'nginx-tests',
|
|
'http.user_agent metric - trace on');
|
|
is(get_attr("http.request_content_length", "int_value", $$spans{span0}), 0,
|
|
'http.request_content_length metric - trace on');
|
|
is(get_attr("http.response_content_length", "int_value", $$spans{span0}), 8,
|
|
'http.response_content_length metric - trace on');
|
|
is(get_attr("http.status_code", "int_value", $$spans{span0}), 200,
|
|
'http.status_code metric - trace on');
|
|
is(get_attr("net.host.name", "string_value", $$spans{span0}), 'localhost',
|
|
'net.host.name metric - trace on');
|
|
is(get_attr("net.host.port", "int_value", $$spans{span0}), 8980,
|
|
'net.host.port metric - trace on');
|
|
is(get_attr("net.sock.peer.addr", "string_value", $$spans{span0}), '127.0.0.1',
|
|
'net.sock.peer.addr metric - trace on');
|
|
like(get_attr("net.sock.peer.port", "int_value", $$spans{span0}), qr/\d+/,
|
|
'net.sock.peer.port metric - trace on');
|
|
|
|
#validate custom http metrics
|
|
is(${get_attr("http.request.header.completion", "array_value", $$spans{span0})}
|
|
{values}{string_value}, '"OK"',
|
|
'http.request.header.completion metric - trace on');
|
|
is(${get_attr(
|
|
"http.response.header.content.type", "array_value", $$spans{span0}
|
|
)}{values}{string_value}, '"text/plain"',
|
|
'http.response.header.content.type metric - trace on');
|
|
is(get_attr("http.request", "string_value", $$spans{span0}),
|
|
'GET /trace-on HTTP/3.0', 'http.request metric - trace on');
|
|
|
|
#extract trace info
|
|
is($$spans{span0}{parent_span_id}, 'b9c7c989f97918e1',
|
|
'traceparent - trace on');
|
|
is($$spans{span0}{trace_state}, '"congo=ucfJifl5GOE,rojo=00f067aa0ba902b7"',
|
|
'tracestate - trace on');
|
|
is($$spans{span1}{parent_span_id}, undef, 'no traceparent - trace on');
|
|
is($$spans{span1}{trace_state}, undef, 'no tracestate - trace on');
|
|
|
|
#variables
|
|
is($tp_headers->{'x-otel-trace-id'}, $$spans{span0}{trace_id},
|
|
'$otel_trace_id variable - trace on');
|
|
is($tp_headers->{'x-otel-span-id'}, $$spans{span0}{span_id},
|
|
'$otel_span_id variable - trace on');
|
|
is($tp_headers->{'x-otel-parent-id'}, $$spans{span0}{parent_span_id},
|
|
'$otel_parent_id variable - trace on');
|
|
is($tp_headers->{'x-otel-parent-sampled'}, 1,
|
|
'$otel_parent_sampled variable - trace on');
|
|
is($t_headers->{'x-otel-parent-sampled'}, 0,
|
|
'$otel_parent_sampled variable - trace on (no traceparent header)');
|
|
|
|
#trace off
|
|
is((scalar grep {
|
|
get_attr("http.target", "string_value", $$spans{$_}) eq '/trace-off'
|
|
} keys %{$spans}), 0, 'no metric in batch0 - trace off');
|
|
is((scalar grep {
|
|
get_attr("http.target", "string_value", $$spans{$_}) eq '/trace-off'
|
|
} keys %{$$batch1{scope_spans}}), 0, 'no metric in batch1 - trace off');
|
|
|
|
#trace context: ignore
|
|
is($t_headers_ignore->{'x-otel-traceparent'}, undef,
|
|
'no traceparent - trace context ignore (no trace headers)');
|
|
is($t_headers_ignore->{'x-otel-tracestate'}, undef,
|
|
'no tracestate - trace context ignore (no trace headers)');
|
|
|
|
is($tp_headers_ignore->{'x-otel-parent-id'}, undef,
|
|
'no parent span id - trace context ignore (trace headers)');
|
|
is($tp_headers_ignore->{'x-otel-traceparent'},
|
|
'00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01',
|
|
'traceparent - trace context ignore (trace headers)');
|
|
is($tp_headers_ignore->{'x-otel-tracestate'},
|
|
'congo=ucfJifl5GOE,rojo=00f067aa0ba902b7',
|
|
'tracestate - trace context ignore (trace headers)');
|
|
|
|
#trace context: extract
|
|
is($t_headers_extract->{'x-otel-traceparent'}, undef,
|
|
'no traceparent - trace context extract (no trace headers)');
|
|
is($t_headers_extract->{'x-otel-tracestate'}, undef,
|
|
'no tracestate - trace context extract (no trace headers)');
|
|
|
|
is($tp_headers_extract->{'x-otel-parent-id'}, 'b9c7c989f97918e1',
|
|
'parent span id - trace context extract (trace headers)');
|
|
is($tp_headers_extract->{'x-otel-traceparent'},
|
|
'00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01',
|
|
'traceparent - trace context extract (trace headers)');
|
|
is($tp_headers_extract->{'x-otel-tracestate'},
|
|
'congo=ucfJifl5GOE,rojo=00f067aa0ba902b7',
|
|
'tracestate - trace context extract (trace headers)');
|
|
|
|
#trace context: inject
|
|
is($t_headers_inject->{'x-otel-traceparent'},
|
|
"00-$$spans{span6}{trace_id}-$$spans{span6}{span_id}-01",
|
|
'traceparent - trace context inject (no trace headers)');
|
|
is($t_headers_inject->{'x-otel-tracestate'}, undef,
|
|
'no tracestate - trace context inject (no trace headers)');
|
|
|
|
is($tp_headers_inject->{'x-otel-parent-id'}, undef,
|
|
'no parent span id - trace context inject (trace headers)');
|
|
is($tp_headers_inject->{'x-otel-traceparent'},
|
|
"00-$$spans{span7}{trace_id}-$$spans{span7}{span_id}-01",
|
|
'traceparent - trace context inject (trace headers)');
|
|
is($tp_headers_inject->{'x-otel-tracestate'}, undef,
|
|
'no tracestate - trace context inject (trace headers)');
|
|
|
|
#trace context: propagate
|
|
is($t_headers_propagate->{'x-otel-traceparent'},
|
|
"00-$$spans{span8}{trace_id}-$$spans{span8}{span_id}-01",
|
|
'traceparent - trace context propagate (no trace headers)');
|
|
is($t_headers_propagate->{'x-otel-tracestate'}, undef,
|
|
'no tracestate - trace context propagate (no trace headers)');
|
|
|
|
is($tp_headers_propagate->{'x-otel-parent-id'}, 'b9c7c989f97918e1',
|
|
'parent id - trace context propagate (trace headers)');
|
|
is($tp_headers_propagate->{'x-otel-traceparent'},
|
|
"00-0af7651916cd43dd8448eb211c80319c-$$spans{span9}{span_id}-01",
|
|
'traceparent - trace context propagate (trace headers)');
|
|
is($tp_headers_propagate->{'x-otel-tracestate'},
|
|
'congo=ucfJifl5GOE,rojo=00f067aa0ba902b7',
|
|
'tracestate - trace context propagate (trace headers)');
|
|
|
|
SKIP: {
|
|
skip "depends on error log content", 2 unless $ENV{TEST_NGINX_UNSAFE};
|
|
|
|
$t->stop();
|
|
my $log = $t->read_file("error.log");
|
|
|
|
like($log, qr/OTel\/grpc: Error parsing metadata: error=invalid value/,
|
|
'log: error parsing metadata - no protobuf in response');
|
|
unlike($log, qr/OTel export failure: No status received/,
|
|
'log: no export failure');
|
|
|
|
}
|
|
|
|
###############################################################################
|
|
|
|
sub http3_get {
|
|
my ($path, %extra) = @_;
|
|
my ($frames, $frame);
|
|
|
|
my $s = Test::Nginx::HTTP3->new();
|
|
|
|
my $sid = $extra{trace_headers}
|
|
? $s->new_stream({ headers => [
|
|
{ name => ':method', value => 'GET' },
|
|
{ name => ':scheme', value => 'http' },
|
|
{ name => ':path', value => $path },
|
|
{ name => ':authority', value => 'localhost' },
|
|
{ name => 'user-agent', value => 'nginx-tests' },
|
|
{ name => 'traceparent',
|
|
value => '00-0af7651916cd43dd8448eb211c80319c-' .
|
|
'b9c7c989f97918e1-01'
|
|
},
|
|
{ name => 'tracestate',
|
|
value => 'congo=ucfJifl5GOE,rojo=00f067aa0ba902b7'
|
|
}]})
|
|
: $s->new_stream({ path => $path });
|
|
|
|
$frames = $s->read(all => [{ sid => $sid, fin => 1 }]);
|
|
|
|
($frame) = grep { $_->{type} eq "HEADERS" } @$frames;
|
|
my $headers = $frame->{headers};
|
|
|
|
($frame) = grep { $_->{type} eq "DATA" } @$frames;
|
|
my $data = $frame->{data};
|
|
|
|
return $headers, $data;
|
|
}
|
|
|
|
sub get_attr {
|
|
my($attr, $type, $obj) = @_;
|
|
|
|
my ($res) = grep {
|
|
$_ =~ /^attribute\d+/ && $$obj{$_}{key} eq '"' . $attr . '"'
|
|
} keys %{$obj};
|
|
|
|
if (defined $res) {
|
|
$$obj{$res}{value}{$type} =~ s/(^\")|(\"$)//g
|
|
if $type eq 'string_value';
|
|
|
|
return $$obj{$res}{value}{$type};
|
|
}
|
|
|
|
return undef;
|
|
}
|
|
|
|
sub decode_protobuf {
|
|
my ($protobuf) = @_;
|
|
|
|
local $/;
|
|
open CMD, "echo '" . encode_base64($protobuf) . "' | base64 -d | " .
|
|
'$PWD/../build/_deps/grpc-build/third_party/protobuf/protoc '.
|
|
'--decode opentelemetry.proto.trace.v1.ResourceSpans -I ' .
|
|
'$PWD/../build/_deps/otelcpp-src/third_party/opentelemetry-proto ' .
|
|
'opentelemetry/proto/collector/trace/v1/trace_service.proto |'
|
|
or die "Can't decode protobuf: $!\n";
|
|
my $out = <CMD>;
|
|
close CMD;
|
|
|
|
return $out;
|
|
}
|
|
|
|
sub decode_bytes {
|
|
my ($bytes) = @_;
|
|
|
|
my $c = sub { return chr oct(shift) };
|
|
|
|
$bytes =~ s/\\(\d{3})/$c->($1)/eg;
|
|
$bytes =~ s/(^\")|(\"$)//g;
|
|
$bytes =~ s/\\\\/\\/g;
|
|
$bytes =~ s/\\r/\r/g;
|
|
$bytes =~ s/\\n/\n/g;
|
|
$bytes =~ s/\\t/\t/g;
|
|
$bytes =~ s/\\"/\"/g;
|
|
$bytes =~ s/\\'/\'/g;
|
|
|
|
return unpack("H*", unpack("a*", $bytes));
|
|
}
|
|
|
|
sub to_hash {
|
|
my ($textdata) = @_;
|
|
|
|
my %out = ();
|
|
push my @stack, \%out;
|
|
my ($attr_count, $span_count) = (0, 0);
|
|
for my $line (split /\n/, $textdata) {
|
|
$line =~ s/(^\s+)|(\s+$)//g;
|
|
if ($line =~ /\:/) {
|
|
my ($k, $v) = split /\: /, $line;
|
|
$v = decode_bytes($v) if ($k =~ /trace_id|span_id|parent_span_id/);
|
|
$stack[$#stack]{$k} = $v;
|
|
} elsif ($line =~ /\{/) {
|
|
$line =~ s/\s\{//;
|
|
$line = 'attribute' . $attr_count++ if ($line eq 'attributes');
|
|
if ($line eq 'spans') {
|
|
$line = 'span' . $span_count++;
|
|
$attr_count = 0;
|
|
}
|
|
my %new = ();
|
|
$stack[$#stack]{$line} = \%new;
|
|
push @stack, \%new;
|
|
} elsif ($line =~ /\}/) {
|
|
pop @stack;
|
|
}
|
|
}
|
|
|
|
return \%out;
|
|
}
|
|
|
|
sub grpc {
|
|
my ($server, $client, $f, $s, $c, $sid, $csid, $uri);
|
|
|
|
$server = IO::Socket::INET->new(
|
|
Proto => 'tcp',
|
|
LocalHost => '127.0.0.1',
|
|
LocalPort => $p,
|
|
Listen => 5,
|
|
Reuse => 1
|
|
) or die "Can't create listening socket: $!\n";
|
|
|
|
$f->{http_start} = sub {
|
|
if (IO::Select->new($server)->can_read(5)) {
|
|
$client = $server->accept();
|
|
} else {
|
|
# connection could be unexpectedly reused
|
|
goto reused if $client;
|
|
return undef;
|
|
}
|
|
|
|
$client->sysread($_, 24) == 24 or return; # preface
|
|
|
|
$c = Test::Nginx::HTTP2->new(1, socket => $client,
|
|
pure => 1, preface => "") or return;
|
|
|
|
reused:
|
|
my $frames = $c->read(all => [{ fin => 1 }]);
|
|
|
|
$client->close();
|
|
|
|
return $frames;
|
|
};
|
|
|
|
return $f;
|
|
}
|
|
|
|
###############################################################################
|