Skip to content
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

WIP: Add support for logs #6

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

WIP: Add support for logs #6

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
1 change: 1 addition & 0 deletions Changes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Revision history for OpenTelemetry-SDK

* Clarify meaning of OTEL_BSP_EXPORT_TIMEOUT in POD
* Minor correction in Resource POD
* EXPERIMENTAL: Add support for logs

0.020 2023-11-26 16:18:52+00:00 Europe/London

Expand Down
67 changes: 48 additions & 19 deletions META.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"OpenTelemetry::Exporter::OTLP" : "0"
},
"requires" : {
"Const::Fast" : "0",
"Feature::Compat::Try" : "0",
"Future::AsyncAwait" : "0.38",
"IO::Async::Loop" : "0",
Expand Down Expand Up @@ -72,73 +73,101 @@
}
},
"provides" : {
"OpenTelemetry::Processor::Batch" : {
"file" : "lib/OpenTelemetry/Processor/Batch.pm",
"version" : "0.025"
},
"OpenTelemetry::Processor::Simple" : {
"file" : "lib/OpenTelemetry/Processor/Simple.pm",
"version" : "0.025"
},
"OpenTelemetry::SDK" : {
"file" : "lib/OpenTelemetry/SDK.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Exporter::Console" : {
"file" : "lib/OpenTelemetry/SDK/Exporter/Console.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::InstrumentationScope" : {
"file" : "lib/OpenTelemetry/SDK/InstrumentationScope.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Logs::LogRecord" : {
"file" : "lib/OpenTelemetry/SDK/Logs/LogRecord.pm",
"version" : "0.025"
},
"OpenTelemetry::SDK::Logs::LogRecord::Processor::Batch" : {
"file" : "lib/OpenTelemetry/SDK/Logs/LogRecord/Processor/Batch.pm",
"version" : "0.025"
},
"OpenTelemetry::SDK::Logs::LogRecord::Processor::Simple" : {
"file" : "lib/OpenTelemetry/SDK/Logs/LogRecord/Processor/Simple.pm",
"version" : "0.025"
},
"OpenTelemetry::SDK::Logs::Logger" : {
"file" : "lib/OpenTelemetry/SDK/Logs/Logger.pm",
"version" : "0.025"
},
"OpenTelemetry::SDK::Logs::LoggerProvider" : {
"file" : "lib/OpenTelemetry/SDK/Logs/LoggerProvider.pm",
"version" : "0.025"
},
"OpenTelemetry::SDK::Resource" : {
"file" : "lib/OpenTelemetry/SDK/Resource.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Sampler" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Sampler.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Sampler::AlwaysOff" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Sampler/AlwaysOff.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Sampler::AlwaysOn" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Sampler/AlwaysOn.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Sampler::ParentBased" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Sampler/ParentBased.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Sampler::Result" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Sampler/Result.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Sampler::TraceIDRatioBased" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Sampler/TraceIDRatioBased.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Span" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Span.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Span::Processor::Batch" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Span/Processor/Batch.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Span::Processor::Simple" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Span/Processor/Simple.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Span::Readable" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Span/Readable.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::SpanLimits" : {
"file" : "lib/OpenTelemetry/SDK/Trace/SpanLimits.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::Tracer" : {
"file" : "lib/OpenTelemetry/SDK/Trace/Tracer.pm",
"version" : "0.024"
"version" : "0.025"
},
"OpenTelemetry::SDK::Trace::TracerProvider" : {
"file" : "lib/OpenTelemetry/SDK/Trace/TracerProvider.pm",
"version" : "0.024"
"version" : "0.025"
}
},
"release_status" : "stable",
Expand All @@ -152,7 +181,7 @@
"web" : "https://github.com/jjatria/perl-opentelemetry-sdk"
}
},
"version" : "0.024",
"version" : "0.025",
"x_Dist_Zilla" : {
"perl" : {
"version" : "5.040000"
Expand Down Expand Up @@ -382,7 +411,7 @@
"branch" : null,
"changelog" : "Changes",
"signed" : 0,
"tag" : "0.024",
"tag" : "0.025",
"tag_format" : "%v",
"tag_message" : ""
},
Expand Down
1 change: 1 addition & 0 deletions cpanfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
requires 'Const::Fast';
requires 'Feature::Compat::Try';
requires 'Future::AsyncAwait', '0.38'; # Object::Pad compatibility
requires 'IO::Async::Loop';
Expand Down
195 changes: 195 additions & 0 deletions lib/OpenTelemetry/Processor/Batch.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
use Object::Pad ':experimental(init_expr)';
# ABSTRACT: A batched OpenTelemetry processor

package OpenTelemetry::Processor::Batch;

our $VERSION = '0.014';

# TODO: If we move the different base implementations of processors
# to the top-level, that still leaves the specific implementations
# for Traces / Metrics / Logs to exist somewhere else.
# This works, although we need to be careful about clarifying what
# the expectations are for classes in each namespace, and the what
# are the interfaces they expose.
# In all honesty, this separation ended up looking a lot better than
# expected.
class OpenTelemetry::Processor::Batch :does(OpenTelemetry::Processor) {
use Feature::Compat::Defer;
use Feature::Compat::Try;
use Future::AsyncAwait;
use IO::Async::Function;
use IO::Async::Loop;
use Mutex;
use OpenTelemetry::Common qw( config timeout_timestamp maybe_timeout );
use OpenTelemetry::Constants -export;
use OpenTelemetry::X;
use OpenTelemetry;

use Log::Any;
my $logger = Log::Any->get_logger( category => 'OpenTelemetry' );

use Metrics::Any '$metrics', strict => 1,
name_prefix => [qw( otel processor batch )];

$metrics->make_gauge( 'buffer_use',
name => [qw( buffer use )],
description => 'Ratio between maximum queue size and the size of the queue at export time',
);

field $batch_size :param //= config('BSP_MAX_EXPORT_BATCH_SIZE') // 512;
field $exporter_timeout :param //= config('BSP_EXPORT_TIMEOUT') // 30_000;
field $max_queue_size :param //= config('BSP_MAX_QUEUE_SIZE') // 2_048;
field $schedule_delay :param //= config('BSP_SCHEDULE_DELAY') // 5_000;
field $exporter :param;

field $lock = Mutex->new;

field $done :reader;
field $function;
field @queue;

ADJUST {
die OpenTelemetry::X->create(
Invalid => "Exporter must implement the OpenTelemetry::Exporter interface: " . ( ref $exporter || $exporter )
) unless $exporter && $exporter->DOES('OpenTelemetry::Exporter');

if ( $batch_size > $max_queue_size ) {
$logger->warn(
'Max export batch size cannot be greater than maximum queue size when instantiating batch processor',
{
batch_size => $batch_size,
queue_size => $max_queue_size,
},
);
$batch_size = $max_queue_size;
}

# This is a non-standard variable, so we make it Perl-specific
my $max_workers = $ENV{OTEL_PERL_BSP_MAX_WORKERS};

$function = IO::Async::Function->new(
$max_workers ? ( max_workers => $max_workers ) : (),

code => sub ( $exporter, $batch, $timeout ) {
$exporter->export( $batch, $timeout );
},
);

IO::Async::Loop->new->add($function);
}

method process ( @items ) {
try {
my $batch = $lock->enter(
sub {
my $overflow = @queue + @items - $max_queue_size;
if ( $overflow > 0 ) {
# If the buffer is full, we drop old spans first
# The queue is always FIFO, even for dropped spans
# This behaviour is not in the spec, but is
# consistent with the Ruby implementation.
# For context, the Go implementation instead
# blocks until there is room in the buffer.
splice @queue, 0, $overflow;
$self->report_dropped( 'buffer-full', $overflow );
}

push @queue, @items;

return [] if @queue < $batch_size;

$metrics->set_gauge_to(
buffer_use => @queue / $max_queue_size
) if @queue;

[ splice @queue, 0, $batch_size ];
}
);

return unless @$batch;

$function->call(
args => [ $exporter, $batch, $exporter_timeout ],
on_result => sub ( $type, $result ) {
my $count = scalar @$batch;

return $self->report_result( EXPORT_RESULT_FAILURE, $count )
unless $type eq 'return';

$self->report_result( $result, $count );
},
);
}
catch($e) {
warn $e;
}

return;
}

method report_dropped ( $reason, $count ) { $self }

method report_result ( $result, $count ) { $result }

async method shutdown ( $timeout = undef ) {
return EXPORT_RESULT_SUCCESS if $done;

$done = 1;

my $start = timeout_timestamp;

# TODO: The Ruby implementation ignores whether the force_flush
# times out. Is this correct?
await $self->force_flush( maybe_timeout $timeout, $start );

$self->report_dropped( 'terminating', scalar @queue ) if @queue;
@queue = ();

await $function->stop if $function->workers;

await $exporter->shutdown( maybe_timeout $timeout, $start );
}

async method force_flush ( $timeout = undef ) {
return EXPORT_RESULT_SUCCESS if $done;

my $start = timeout_timestamp;

my @stack = $lock->enter( sub { splice @queue, 0, @queue } );

defer {
# If we still have any spans left it has to be because we
# timed out and couldn't export them. In that case, we drop
# them and report
$self->report_dropped( 'force-flush', scalar @stack ) if @stack;
}

while ( @stack ) {
my $remaining = maybe_timeout $timeout, $start;
return EXPORT_RESULT_TIMEOUT if $timeout and !$remaining;

my $batch = [ splice @stack, 0, $batch_size ];

my $count = scalar @$batch;
try {
my $result = await $function->call(
args => [ $exporter, $batch, $remaining ],
);

$self->report_result( $result, $count );

return $result unless $result == EXPORT_RESULT_SUCCESS;
}
catch ($e) {
return $self->report_result( EXPORT_RESULT_FAILURE, $count);
}
}

await $exporter->force_flush( maybe_timeout $timeout, $start );
}

method DESTROY {
try { $function->stop->get }
catch ($e) { }
}
}
39 changes: 39 additions & 0 deletions lib/OpenTelemetry/Processor/Simple.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
use Object::Pad ':experimental(init_expr)';
# ABSTRACT: A basic OpenTelemetry span processor

package OpenTelemetry::Processor::Simple;

our $VERSION = '0.014';

class OpenTelemetry::Processor::Simple :does(OpenTelemetry::Processor) {
use Feature::Compat::Try;
use Future::AsyncAwait;
use OpenTelemetry::X;

field $exporter :param;

ADJUST {
die OpenTelemetry::X->create(
Invalid => "Exporter must implement the OpenTelemetry::Exporter interface: " . ( ref $exporter || $exporter )
) unless $exporter && $exporter->DOES('OpenTelemetry::Exporter');
}

method process ( @items ) {
try {
$exporter->export(\@items);
}
catch ($e) {
warn $e;
}

return;
}

async method shutdown ( $timeout = undef ) {
await $exporter->shutdown( $timeout );
}

async method force_flush ( $timeout = undef ) {
await $exporter->force_flush( $timeout );
}
}
Loading
Loading