Switch Metrics::Any to strict mode

jjatria · Nov 26, 2023 · b2b7b72 · b2b7b72
1 parent aa6384d
commit b2b7b72
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 25 deletions.
diff --git a/Changes b/Changes
@@ -3,6 +3,16 @@ Revision history for OpenTelemetry-Exporter-OTLP
 {{$NEXT}}
 
     * Fix key name of parent span ID in JSON encoding
+    * Switch Metrics::Any client to strict mode, to allow for automatic
+      metric name generation. This means the metrics can be exported
+      with adapters that don't allow periods (eg. Prometheus). This
+      means some metrics had to be renamed:
+      - otel.otlp_exporter.failure -> otel.exporter.otlp.failure
+      - otel.otlp_exporter.message.compressed_size -> otel.exporter.otlp.message.compressed.size
+      - otel.otlp_exporter.message.uncompressed_size -> otel.exporter.otlp.message.uncompressed.size
+      - otel.otlp_exporter.request_duration -> otel.exporter.otlp.request.duration
+      Also: the `otel.exporter.otlp.success` metric was added for
+      consistency.
 
 0.014     2023-11-23 19:32:20+00:00 Europe/London
 

diff --git a/lib/OpenTelemetry/Exporter/OTLP.pm b/lib/OpenTelemetry/Exporter/OTLP.pm
@@ -34,9 +34,40 @@ class OpenTelemetry::Exporter::OTLP :does(OpenTelemetry::Exporter) {
         'gzip';
     } // 'none';
 
-    use Metrics::Any '$metrics', strict => 0;
     my $logger = OpenTelemetry->logger;
 
+    use Metrics::Any '$metrics', strict => 1,
+        name_prefix => [qw( otel exporter otlp )];
+
+    $metrics->make_counter( 'success',
+        name        => [qw( success )],
+        description => 'Number of times the export process succeeded',
+    );
+
+    $metrics->make_counter( 'failure',
+        name        => [qw( failure )],
+        description => 'Number of times the export process failed',
+        labels      => [qw( reason )],
+    );
+
+    $metrics->make_distribution( 'uncompressed',
+        name        => [qw( message uncompressed size )],
+        description => 'Size of exporter payload before compression',
+        units       => 'bytes',
+    );
+
+    $metrics->make_distribution( 'compressed',
+        name        => [qw( message compressed size )],
+        description => 'Size of exporter payload after compression',
+        units       => 'bytes',
+    );
+
+    $metrics->make_timer( 'request',
+        name        => [qw( request duration )],
+        description => 'Duration of the export request',
+        labels      => [qw( status )],
+    );
+
     field $stopped;
     field $ua;
     field $endpoint;
@@ -149,10 +180,7 @@ class OpenTelemetry::Exporter::OTLP :does(OpenTelemetry::Exporter) {
     }
 
     method $maybe_backoff ( $count, $reason, $after = 0 ) {
-        $metrics->inc_counter(
-            'otel.otlp_exporter.failure',
-            { reason => $reason },
-        );
+        $metrics->inc_counter( failure => [ reason => $reason ] );
 
         return if $count > $max_retries;
 
@@ -176,8 +204,7 @@ class OpenTelemetry::Exporter::OTLP :does(OpenTelemetry::Exporter) {
         my %request = ( content => $data );
 
         $metrics->report_distribution(
-            'otel.otlp_exporter.message.uncompressed_size',
-            length $request{content},
+            uncompressed => length $request{content},
         );
 
         if ( $compression eq 'gzip' ) {
@@ -190,16 +217,14 @@ class OpenTelemetry::Exporter::OTLP :does(OpenTelemetry::Exporter) {
                 );
 
                 $metrics->inc_counter(
-                    'otel.otlp_exporter.failure',
-                    { reason => 'zlib_error' },
+                    failure => [ reason => 'zlib_error' ],
                 );
 
                 return TRACE_EXPORT_FAILURE;
             }
 
             $metrics->report_distribution(
-                'otel.otlp_exporter.message.compressed_size',
-                length $request{content},
+                compressed => length $request{content},
             );
         }
 
@@ -220,13 +245,15 @@ class OpenTelemetry::Exporter::OTLP :does(OpenTelemetry::Exporter) {
             my $res = $ua->post( $endpoint, \%request );
             my $request_end = timeout_timestamp;
 
-            $metrics->set_gauge_to(
-                'otel.otlp_exporter.request_duration',
-                $request_end - $request_start,
-                { status => $res->{status} },
+            $metrics->report_timer(
+                request => $request_end - $request_start,
+                [ status => $res->{status} ],
             );
 
-            return TRACE_EXPORT_SUCCESS if $res->{success};
+            if ( $res->{success} ) {
+                $metrics->inc_counter('success');
+                return TRACE_EXPORT_SUCCESS;
+            }
 
             match ( $res->{status} : =~ ) {
                 case( m/^ 599 $/x ) {
@@ -243,12 +270,13 @@ class OpenTelemetry::Exporter::OTLP :does(OpenTelemetry::Exporter) {
                             case(m/^Cannot parse/)             { 'parse_error' }
                             default {
                                 $metrics->inc_counter(
-                                    'otel.otlp_exporter.failure',
-                                    { reason => $res->{status} },
+                                    failure => [ reason => $res->{status} ],
                                 );
+
                                 OpenTelemetry->handle_error(
                                     message => "Unhandled error sending OTLP request: $res->{content}",
                                 );
+
                                 return TRACE_EXPORT_FAILURE;
                             }
                         }
@@ -258,8 +286,7 @@ class OpenTelemetry::Exporter::OTLP :does(OpenTelemetry::Exporter) {
                 }
                 case( m/^(?: 4 | 5 ) \d{2} $/ax ) {
                     $metrics->inc_counter(
-                        'otel.otlp_exporter.failure',
-                        { reason => $res->{status} },
+                        failure => [ reason => $res->{status} ],
                     );
 
                     if ( $CAN_USE_PROTOBUF ) {

diff --git a/lib/OpenTelemetry/Exporter/OTLP.pod b/lib/OpenTelemetry/Exporter/OTLP.pod
@@ -194,9 +194,10 @@ L<is being discussed|https://github.com/open-telemetry/semantic-conventions/issu
 
 =over
 
-=item C<otel.otlp_exporter.failure>
+=item C<otel.exporter.otlp.failure>
 
-Incremented every time an error is encountered during export.
+Incremented every time an error is encountered during export. This may be a
+recoverable error that disappears after a retry.
 
 Reported with the following attributes:
 
@@ -240,18 +241,22 @@ be set to the non-successful numeric status code received from the server.
 
 =back
 
+=item C<otel.exporter.otlp.success>
+
+Incremented every time an export operation completes successfully.
+
 =back
 
-=item C<otel.otlp_exporter.message.compressed_size>
+=item C<otel.exporter.otlp.message.compressed.size>
 
 Set to the size of the request content after compression is done. This is
 not sent if no compression is done.
 
-=item C<otel.otlp_exporter.message.uncompressed_size>
+=item C<otel.exporter.otlp.message.uncompressed.size>
 
 Set to the size of the request content before compression is done.
 
-=item C<otel.otlp_exporter.request_duration>
+=item C<otel.exporter.otlp.request.duration>
 
 Set to the number of seconds, as a fraction, that the request took to
 complete. It is set with the following attributes: