Evgeny
GitHub
parent
f6f2525dd7
commit
3d528bb093
5 changed files with 2029 additions and 0 deletions
403
tests/otel_collector.t
Normal file
403
tests/otel_collector.t
Normal file
|
|
@ -0,0 +1,403 @@
|
|||
#!/usr/bin/perl
|
||||
|
||||
# (C) Nginx, Inc.
|
||||
|
||||
# Tests for OTel exporter in case HTTP using otelcol.
|
||||
|
||||
###############################################################################
|
||||
|
||||
use warnings;
|
||||
use strict;
|
||||
|
||||
use Test::More;
|
||||
|
||||
BEGIN { use FindBin; chdir($FindBin::Bin); }
|
||||
|
||||
use Test::Nginx;
|
||||
|
||||
###############################################################################
|
||||
|
||||
select STDERR; $| = 1;
|
||||
select STDOUT; $| = 1;
|
||||
|
||||
plan(skip_all => "depends on logs content") unless $ENV{TEST_NGINX_UNSAFE};
|
||||
|
||||
eval { require JSON::PP; };
|
||||
plan(skip_all => "JSON::PP not installed") if $@;
|
||||
|
||||
my $t = Test::Nginx->new()->has(qw/http http_ssl rewrite/)
|
||||
->write_file_expand('nginx.conf', <<'EOF');
|
||||
|
||||
%%TEST_GLOBALS%%
|
||||
|
||||
daemon off;
|
||||
|
||||
events {
|
||||
}
|
||||
|
||||
http {
|
||||
%%TEST_GLOBALS_HTTP%%
|
||||
|
||||
ssl_certificate_key localhost.key;
|
||||
ssl_certificate localhost.crt;
|
||||
|
||||
otel_exporter {
|
||||
endpoint 127.0.0.1:%%PORT_4317%%;
|
||||
interval 1s;
|
||||
batch_size 10;
|
||||
batch_count 2;
|
||||
}
|
||||
|
||||
otel_service_name test_server;
|
||||
otel_trace on;
|
||||
|
||||
server {
|
||||
listen 127.0.0.1:8080;
|
||||
listen 127.0.0.1:8081 ssl;
|
||||
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://localhost:8080/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://localhost:8080/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://localhost:8080/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://localhost:8080/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";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
EOF
|
||||
|
||||
$t->write_file_expand('otel-config.yaml', <<EOF);
|
||||
|
||||
receivers:
|
||||
otlp:
|
||||
protocols:
|
||||
grpc:
|
||||
endpoint: 127.0.0.1:%%PORT_4317%%
|
||||
|
||||
exporters:
|
||||
logging:
|
||||
loglevel: debug
|
||||
file:
|
||||
path: ${\ $t->testdir() }/otel.json
|
||||
|
||||
service:
|
||||
pipelines:
|
||||
traces:
|
||||
receivers: [otlp]
|
||||
exporters: [logging, file]
|
||||
metrics:
|
||||
receivers: [otlp]
|
||||
exporters: [logging, file]
|
||||
|
||||
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";
|
||||
}
|
||||
|
||||
#suppress otel collector output
|
||||
open OLDERR, ">&", \*STDERR;
|
||||
open STDERR, ">>" , $^O eq 'MSWin32' ? 'nul' : '/dev/null';
|
||||
$t->run_daemon('../otelcol', '--config', $t->testdir().'/otel-config.yaml');
|
||||
open STDERR, ">&", \*OLDERR;
|
||||
$t->waitforsocket('127.0.0.1:' . port(4317)) or
|
||||
die 'No otel collector open socket';
|
||||
|
||||
$t->try_run('no OTel module')->plan(69);
|
||||
|
||||
###############################################################################
|
||||
|
||||
#do requests
|
||||
my $t_off_resp = http1_get('/trace-off');
|
||||
|
||||
#batch0 (10 requests)
|
||||
my $tp_resp = http1_get('/trace-on', trace_headers => 1);
|
||||
my $t_resp = http1_get('/trace-on', port => 8081, ssl => 1);
|
||||
|
||||
my $t_resp_ignore = http1_get('/context-ignore');
|
||||
my $tp_resp_ignore = http1_get('/context-ignore', trace_headers => 1);
|
||||
my $t_resp_extract = http1_get('/context-extract');
|
||||
my $tp_resp_extract = http1_get('/context-extract', trace_headers => 1);
|
||||
my $t_resp_inject = http1_get('/context-inject');
|
||||
my $tp_resp_inject = http1_get('/context-inject', trace_headers => 1);
|
||||
my $t_resp_propagate = http1_get('/context-propagate');
|
||||
my $tp_resp_propagate = http1_get('/context-propagate', trace_headers => 1);
|
||||
|
||||
#batch1 (5 reqeusts)
|
||||
http1_get('/trace-on') for (1..5);
|
||||
|
||||
#waiting batch1 is sent to collector for 1s
|
||||
select undef, undef, undef, 1;
|
||||
|
||||
my @batches = split /\n/, $t->read_file('otel.json');
|
||||
my $batch_json = JSON::PP::decode_json($batches[0]);
|
||||
my $spans = $$batch_json{"resourceSpans"}[0]{"scopeSpans"}[0]{"spans"};
|
||||
|
||||
#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 amount of batches
|
||||
is(scalar @batches, 2, 'amount of batches - trace on');
|
||||
|
||||
#validate batch size
|
||||
is(scalar @{$spans}, 10, 'batch0 size - trace on');
|
||||
is(scalar @{${JSON::PP::decode_json($batches[1])}{"resourceSpans"}[0]
|
||||
{"scopeSpans"}[0]{"spans"}}, 5, 'batch1 size - trace on');
|
||||
|
||||
#validate general attributes
|
||||
is(get_attr("service.name", "stringValue",
|
||||
$$batch_json{resourceSpans}[0]{resource}),
|
||||
'test_server', 'service.name - trace on');
|
||||
is($$spans[0]{name}, 'default_location', 'span.name - trace on');
|
||||
|
||||
#validate http metrics
|
||||
is(get_attr("http.method", "stringValue", $$spans[0]), 'GET',
|
||||
'http.method metric - trace on');
|
||||
is(get_attr("http.target", "stringValue", $$spans[0]), '/trace-on',
|
||||
'http.target metric - trace on');
|
||||
is(get_attr("http.route", "stringValue", $$spans[0]), '/trace-on',
|
||||
'http.route metric - trace on');
|
||||
is(get_attr("http.scheme", "stringValue", $$spans[0]), 'http',
|
||||
'http.scheme metric - trace on');
|
||||
is(get_attr("http.flavor", "stringValue", $$spans[0]), '1.0',
|
||||
'http.flavor metric - trace on');
|
||||
is(get_attr("http.user_agent", "stringValue", $$spans[0]), 'nginx-tests',
|
||||
'http.user_agent metric - trace on');
|
||||
is(get_attr("http.request_content_length", "intValue", $$spans[0]), 0,
|
||||
'http.request_content_length metric - trace on');
|
||||
is(get_attr("http.response_content_length", "intValue", $$spans[0]), 8,
|
||||
'http.response_content_length metric - trace on');
|
||||
is(get_attr("http.status_code", "intValue", $$spans[0]), 200,
|
||||
'http.status_code metric - trace on');
|
||||
is(get_attr("net.host.name", "stringValue", $$spans[0]), 'localhost',
|
||||
'net.host.name metric - trace on');
|
||||
is(get_attr("net.host.port", "intValue", $$spans[0]), 8080,
|
||||
'net.host.port metric - trace on');
|
||||
is(get_attr("net.sock.peer.addr", "stringValue", $$spans[0]), '127.0.0.1',
|
||||
'net.sock.peer.addr metric - trace on');
|
||||
like(get_attr("net.sock.peer.port", "intValue", $$spans[0]), qr/\d+/,
|
||||
'net.sock.peer.port metric - trace on');
|
||||
|
||||
#validate custom http metrics
|
||||
is(${get_attr("http.request.header.completion", "arrayValue", $$spans[0])}
|
||||
{values}[0]{stringValue}, 'OK',
|
||||
'http.request.header.completion metric - trace on');
|
||||
is(${get_attr("http.response.header.content.type", "arrayValue",$$spans[0])}
|
||||
{values}[0]{stringValue}, 'text/plain',
|
||||
'http.response.header.content.type metric - trace on');
|
||||
is(get_attr("http.request", "stringValue", $$spans[0]),
|
||||
'GET /trace-on HTTP/1.0', 'http.request metric - trace on');
|
||||
|
||||
#validate https metrics
|
||||
is(get_attr("http.method", "stringValue", $$spans[1]), 'GET',
|
||||
'http.method metric - trace on (https)');
|
||||
is(get_attr("http.target", "stringValue", $$spans[1]), '/trace-on',
|
||||
'http.target metric - trace on (https)');
|
||||
is(get_attr("http.route", "stringValue", $$spans[1]), '/trace-on',
|
||||
'http.route metric - trace on (https)');
|
||||
is(get_attr("http.scheme", "stringValue", $$spans[1]), 'https',
|
||||
'http.scheme metric - trace on (https)');
|
||||
is(get_attr("http.flavor", "stringValue", $$spans[1]), '1.0',
|
||||
'http.flavor metric - trace on (https)');
|
||||
is(get_attr("http.user_agent", "stringValue", $$spans[1]), 'nginx-tests',
|
||||
'http.user_agent metric - trace on (https)');
|
||||
is(get_attr("http.request_content_length", "intValue", $$spans[1]), 0,
|
||||
'http.request_content_length metric - trace on (https)');
|
||||
is(get_attr("http.response_content_length", "intValue", $$spans[1]), 8,
|
||||
'http.response_content_length metric - trace on (https)');
|
||||
is(get_attr("http.status_code", "intValue", $$spans[1]), 200,
|
||||
'http.status_code metric - trace on (https)');
|
||||
is(get_attr("net.host.name", "stringValue", $$spans[1]), 'localhost',
|
||||
'net.host.name metric - trace on (https)');
|
||||
is(get_attr("net.host.port", "intValue", $$spans[1]), 8081,
|
||||
'net.host.port metric - trace on (https)');
|
||||
is(get_attr("net.sock.peer.addr", "stringValue", $$spans[1]), '127.0.0.1',
|
||||
'net.sock.peer.addr metric - trace on (https)');
|
||||
like(get_attr("net.sock.peer.port", "intValue", $$spans[1]), qr/\d+/,
|
||||
'net.sock.peer.port metric - trace on (https)');
|
||||
|
||||
#extract trace info
|
||||
is($$spans[0]{parentSpanId}, 'b9c7c989f97918e1', 'traceparent - trace on');
|
||||
is($$spans[0]{traceState}, 'congo=ucfJifl5GOE,rojo=00f067aa0ba902b7',
|
||||
'tracestate - trace on');
|
||||
is($$spans[1]{parentSpanId}, '', 'no traceparent - trace on');
|
||||
is($$spans[1]{traceState}, undef, 'no tracestate - trace on');
|
||||
|
||||
#variables
|
||||
like($tp_resp, qr/X-Otel-Trace-Id: $$spans[0]{traceId}/,
|
||||
'$otel_trace_id variable - trace on');
|
||||
like($tp_resp, qr/X-Otel-Span-Id: $$spans[0]{spanId}/,
|
||||
'$otel_span_id variable - trace on');
|
||||
like($tp_resp, qr/X-Otel-Parent-Id: $$spans[0]{parentSpanId}/,
|
||||
'$otel_parent_id variable - trace on');
|
||||
like($tp_resp, qr/X-Otel-Parent-Sampled: 1/,
|
||||
'$otel_parent_sampled variable - trace on');
|
||||
like($t_resp, qr/X-Otel-Parent-Sampled: 0/,
|
||||
'$otel_parent_sampled variable - trace on (no traceparent header)');
|
||||
|
||||
#trace off
|
||||
unlike($batches[0].$batches[1],
|
||||
qr/\Q{"key":"http.target","value":{"stringValue":"\/trace-off"}}\E/,
|
||||
'no metrics - trace off');
|
||||
|
||||
#trace context: ignore
|
||||
unlike($t_resp_ignore, qr/X-Otel-Traceparent/,
|
||||
'no traceparent - trace context ignore (no trace headers)');
|
||||
unlike($t_resp_ignore, qr/X-Otel-Tracestate/,
|
||||
'no tracestate - trace context ignore (no trace headers)');
|
||||
|
||||
unlike($tp_resp_ignore, qr/X-Otel-Parent-Id/,
|
||||
'no parent span id - trace context ignore (trace headers)');
|
||||
like($tp_resp_ignore,
|
||||
qr/Traceparent: 00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01/,
|
||||
'traceparent - trace context ignore (trace headers)');
|
||||
like($tp_resp_ignore,
|
||||
qr/Tracestate: congo=ucfJifl5GOE,rojo=00f067aa0ba902b7/,
|
||||
'tracestate - trace context ignore (trace headers)');
|
||||
|
||||
#trace context: extract
|
||||
unlike($t_resp_extract, qr/X-Otel-Traceparent/,
|
||||
'no traceparent - trace context extract (no trace headers)');
|
||||
unlike($t_resp_extract, qr/X-Otel-Tracestate/,
|
||||
'no tracestate - trace context extract (no trace headers)');
|
||||
|
||||
like($tp_resp_extract, qr/X-Otel-Parent-Id: b9c7c989f97918e1/,
|
||||
'parent span id - trace context extract (trace headers)');
|
||||
like($tp_resp_extract,
|
||||
qr/Traceparent: 00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01/,
|
||||
'traceparent - trace context extract (trace headers)');
|
||||
like($tp_resp_extract,
|
||||
qr/Tracestate: congo=ucfJifl5GOE,rojo=00f067aa0ba902b7/,
|
||||
'tracestate - trace context extract (trace headers)');
|
||||
|
||||
#trace context: inject
|
||||
like($t_resp_inject,
|
||||
qr/X-Otel-Traceparent: 00-$$spans[6]{traceId}-$$spans[6]{spanId}-01/,
|
||||
'traceparent - trace context inject (no trace headers)');
|
||||
unlike($t_resp_inject, qr/X-Otel-Tracestate/,
|
||||
'no tracestate - trace context inject (no trace headers)');
|
||||
|
||||
unlike($tp_resp_inject, qr/X-Otel-Parent-Id/,
|
||||
'no parent span id - trace context inject (trace headers)');
|
||||
like($tp_resp_inject,
|
||||
qr/Traceparent: 00-$$spans[7]{traceId}-$$spans[7]{spanId}-01/,
|
||||
'traceparent - trace context inject (trace headers)');
|
||||
unlike($tp_resp_inject, qr/Tracestate:/,
|
||||
'no tracestate - trace context inject (trace headers)');
|
||||
|
||||
#trace context: propagate
|
||||
like($t_resp_propagate,
|
||||
qr/X-Otel-Traceparent: 00-$$spans[8]{traceId}-$$spans[8]{spanId}-01/,
|
||||
'traceparent - trace context propagate (no trace headers)');
|
||||
unlike($t_resp_propagate, qr/X-Otel-Tracestate/,
|
||||
'no tracestate - trace context propagate (no trace headers)');
|
||||
|
||||
like($tp_resp_propagate, qr/X-Otel-Parent-Id: b9c7c989f97918e1/,
|
||||
'parent id - trace context propagate (trace headers)');
|
||||
like($tp_resp_propagate,
|
||||
qr/Traceparent: 00-0af7651916cd43dd8448eb211c80319c-$$spans[9]{spanId}-01/,
|
||||
'traceparent - trace context propagate (trace headers)');
|
||||
like($tp_resp_propagate,
|
||||
qr/Tracestate: congo=ucfJifl5GOE,rojo=00f067aa0ba902b7/,
|
||||
'tracestate - trace context propagate (trace headers)');
|
||||
|
||||
$t->stop();
|
||||
my $log = $t->read_file("error.log");
|
||||
|
||||
unlike($log, qr/OTel\/grpc: Error parsing metadata: error=invalid value/,
|
||||
'log: no error parsing metadata');
|
||||
unlike($log, qr/OTel export failure: No status received/,
|
||||
'log: no export failure');
|
||||
|
||||
###############################################################################
|
||||
|
||||
sub http1_get {
|
||||
my ($path, %extra) = @_;
|
||||
|
||||
my $port = $extra{port} || 8080;
|
||||
|
||||
my $r = <<EOF;
|
||||
GET $path HTTP/1.0
|
||||
Host: localhost
|
||||
User-agent: nginx-tests
|
||||
EOF
|
||||
|
||||
$r .= <<EOF if $extra{trace_headers};
|
||||
Traceparent: 00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01
|
||||
Tracestate: congo=ucfJifl5GOE,rojo=00f067aa0ba902b7
|
||||
EOF
|
||||
|
||||
return http($r . "\n", PeerAddr => '127.0.0.1:' . port($port),
|
||||
SSL => $extra{ssl});
|
||||
}
|
||||
|
||||
sub get_attr {
|
||||
my($attr, $type, $obj) = @_;
|
||||
|
||||
my ($res) = grep { $$_{"key"} eq $attr } @{$$obj{"attributes"}};
|
||||
|
||||
return defined $res ? $res->{"value"}{$type} : undef;
|
||||
}
|
||||
|
||||
###############################################################################
|
||||
Loading…
Add table
Add a link
Reference in a new issue