[OneCollectorExporter] Failed transmission callback

src/OpenTelemetry.Exporter.OneCollector/.publicApi/net462/PublicAPI.Unshipped.txt

@@ -0,0 +1,2 @@
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporter<T>.RegisterPayloadTransmittedCallback(OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackAction! callback, bool includeFailures) -> System.IDisposable?
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackArguments.Succeeded.get -> bool

src/OpenTelemetry.Exporter.OneCollector/.publicApi/net6.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,2 @@
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporter<T>.RegisterPayloadTransmittedCallback(OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackAction! callback, bool includeFailures) -> System.IDisposable?
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackArguments.Succeeded.get -> bool

src/OpenTelemetry.Exporter.OneCollector/.publicApi/net7.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,2 @@
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporter<T>.RegisterPayloadTransmittedCallback(OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackAction! callback, bool includeFailures) -> System.IDisposable?
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackArguments.Succeeded.get -> bool

src/OpenTelemetry.Exporter.OneCollector/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,2 @@
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporter<T>.RegisterPayloadTransmittedCallback(OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackAction! callback, bool includeFailures) -> System.IDisposable?
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackArguments.Succeeded.get -> bool

src/OpenTelemetry.Exporter.OneCollector/.publicApi/netstandard2.1/PublicAPI.Unshipped.txt

@@ -0,0 +1,2 @@
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporter<T>.RegisterPayloadTransmittedCallback(OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackAction! callback, bool includeFailures) -> System.IDisposable?
+OpenTelemetry.Exporter.OneCollector.OneCollectorExporterPayloadTransmittedCallbackArguments.Succeeded.get -> bool

src/OpenTelemetry.Exporter.OneCollector/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+* Added support for receiving tranmission failures via the
+ `RegisterPayloadTransmittedCallback` API.
+ ([#1309](https:/open-telemetry/opentelemetry-dotnet-contrib/pull/1309))
+
 ## 1.5.1
 
 Released 2023-Aug-07

src/OpenTelemetry.Exporter.OneCollector/Internal/Transports/HttpJsonPostTransport.cs

@@ -27,7 +27,8 @@ internal sealed class HttpJsonPostTransport : ITransport, IDisposable
  private static readonly string SdkVersion = $"OTel-{Environment.OSVersion.Platform}-.net-{typeof(OneCollectorExporter<>).Assembly.GetName()?.Version?.ToString() ?? "0.0.0"}";
  private static readonly string UserAgent = $".NET/{Environment.Version} HttpClient";
 
- private readonly CallbackManager<OneCollectorExporterPayloadTransmittedCallbackAction> payloadTransmittedCallbacks = new();
+ private readonly CallbackManager<OneCollectorExporterPayloadTransmittedCallbackAction> payloadTransmittedSuccessCallbacks = new();
+ private readonly CallbackManager<OneCollectorExporterPayloadTransmittedCallbackAction> payloadTransmittedFailureCallbacks = new();
  private readonly Uri endpoint;
  private readonly string instrumentationKey;
  private readonly OneCollectorExporterHttpTransportCompressionType compressionType;
@@ -56,15 +57,25 @@ public HttpJsonPostTransport(
 
  public void Dispose()
  {
- this.payloadTransmittedCallbacks.Dispose();
+ this.payloadTransmittedSuccessCallbacks.Dispose();
+ this.payloadTransmittedFailureCallbacks.Dispose();
  this.buffer?.Dispose();
  }
 
- public IDisposable RegisterPayloadTransmittedCallback(OneCollectorExporterPayloadTransmittedCallbackAction callback)
+ public IDisposable RegisterPayloadTransmittedCallback(OneCollectorExporterPayloadTransmittedCallbackAction callback, bool includeFailures)
  {
  Guard.ThrowIfNull(callback);
 
- return this.payloadTransmittedCallbacks.Add(callback);
+ var successRegistration = this.payloadTransmittedSuccessCallbacks.Add(callback);
+
+ if (!includeFailures)
+ {
+ return successRegistration;
+ }
+
+ var failureRegistration = this.payloadTransmittedFailureCallbacks.Add(callback);
+
+ return new TranmissionCallbackWrapper(successRegistration, failureRegistration);
  }
 
  public bool Send(in TransportSendRequest sendRequest)
@@ -112,13 +123,14 @@ public bool Send(in TransportSendRequest sendRequest)
 
  OneCollectorExporterEventSource.Log.WriteTransportDataSentEventIfEnabled(sendRequest.ItemType, sendRequest.NumberOfItems, this.Description);
 
- var root = this.payloadTransmittedCallbacks.Root;
+ var root = this.payloadTransmittedSuccessCallbacks.Root;
  if (root != null)
  {
  this.InvokePayloadTransmittedCallbacks(
  root,
  streamStartingPosition,
- in sendRequest);
+ in sendRequest,
+ succeeded: true);
  }
 
  return true;
@@ -135,13 +147,33 @@ public bool Send(in TransportSendRequest sendRequest)
  collectorErrors,
  errorDetails);
 
+ var root = this.payloadTransmittedFailureCallbacks.Root;
+ if (root != null)
+ {
+ this.InvokePayloadTransmittedCallbacks(
+ root,
+ streamStartingPosition,
+ in sendRequest,
+ succeeded: false);
+ }
+
  return false;
  }
  }
  catch (Exception ex)
  {
  OneCollectorExporterEventSource.Log.WriteTransportExceptionThrownEventIfEnabled(this.Description, ex);
 
+ var root = this.payloadTransmittedFailureCallbacks.Root;
+ if (root != null)
+ {
+ this.InvokePayloadTransmittedCallbacks(
+ root,
+ streamStartingPosition,
+ in sendRequest,
+ succeeded: false);
+ }
+
  return false;
  }
  }
@@ -185,7 +217,8 @@ private HttpContent BuildRequestContent(Stream stream)
  private void InvokePayloadTransmittedCallbacks(
  OneCollectorExporterPayloadTransmittedCallbackAction callback,
  long streamStartingPosition,
- in TransportSendRequest sendRequest)
+ in TransportSendRequest sendRequest,
+ bool succeeded)
  {
  var stream = sendRequest.ItemStream;
 
@@ -200,7 +233,8 @@ private void InvokePayloadTransmittedCallbacks(
  sendRequest.ItemSerializationFormat,
  stream,
  OneCollectorExporterTransportProtocolType.HttpJsonPost,
- this.endpoint));
+ this.endpoint,
+ succeeded));
  }
  catch (Exception ex)
  {
@@ -212,6 +246,26 @@ private void InvokePayloadTransmittedCallbacks(
  }
  }
 
+ private sealed class TranmissionCallbackWrapper : IDisposable
+ {
+ private readonly IDisposable successRegistration;
+ private readonly IDisposable failureRegistration;
+
+ public TranmissionCallbackWrapper(
+ IDisposable successRegistration,
+ IDisposable failureRegistration)
+ {
+ this.successRegistration = successRegistration;
+ this.failureRegistration = failureRegistration;
+ }
+
+ public void Dispose()
+ {
+ this.successRegistration.Dispose();
+ this.failureRegistration.Dispose();
+ }
+ }
+
  private sealed class NonDisposingStreamContent : HttpContent
  {
 #pragma warning disable CA2213 // Disposable fields should be disposed

src/OpenTelemetry.Exporter.OneCollector/Internal/Transports/ITransport.cs

@@ -22,5 +22,7 @@ internal interface ITransport
 
  bool Send(in TransportSendRequest sendRequest);
 
- IDisposable RegisterPayloadTransmittedCallback(OneCollectorExporterPayloadTransmittedCallbackAction callback);
+ IDisposable RegisterPayloadTransmittedCallback(
+ OneCollectorExporterPayloadTransmittedCallbackAction callback,
+ bool includeFailures);
 }

src/OpenTelemetry.Exporter.OneCollector/OneCollectorExporter.cs

@@ -66,16 +66,41 @@ public sealed override ExportResult Export(in Batch<T> batch)
 
  /// <summary>
  /// Register a callback action that will be triggered any time a payload is
- /// transmitted by the exporter.
+ /// successfully transmitted by the exporter.
  /// </summary>
+ /// <remarks>
+ /// Success or failure of a transmission depends on the transport being
+ /// used. In the case of HTTP transport, success is driven by the HTTP
+ /// response status code (anything in the 200-range indicates success) and
+ /// any other result (connection failure, timeout, non-200 response code,
+ /// etc.) is considered a failure.
+ /// </remarks>
  /// <param name="callback"><see
  /// cref="OneCollectorExporterPayloadTransmittedCallbackAction"/>.</param>
  /// <returns><see langword="null"/> if no transport is tied to the exporter
  /// or an <see cref="IDisposable"/> representing the registered callback.
  /// Call <see cref="IDisposable.Dispose"/> on the returned instance to
  /// cancel the registration.</returns>
  public IDisposable? RegisterPayloadTransmittedCallback(OneCollectorExporterPayloadTransmittedCallbackAction callback)
- => this.sink.Transport?.RegisterPayloadTransmittedCallback(callback);
+ => this.RegisterPayloadTransmittedCallback(callback, includeFailures: false);
+
+ /// <summary>
+ /// Register a callback action that will be triggered any time a payload is
+ /// transmitted by the exporter.
+ /// </summary>
+ /// <remarks><inheritdoc cref="RegisterPayloadTransmittedCallback(OneCollectorExporterPayloadTransmittedCallbackAction)" path="/remarks"/></remarks>
+ /// <param name="callback"><see
+ /// cref="OneCollectorExporterPayloadTransmittedCallbackAction"/>.</param>
+ /// <param name="includeFailures">Specify <see langword="true"/> to receive
+ /// callbacks when transmission fails. See <see
+ /// cref="OneCollectorExporterPayloadTransmittedCallbackArguments.Succeeded"/>
+ /// for details about how a success or failure is determined.</param>
+ /// <returns><see langword="null"/> if no transport is tied to the exporter
+ /// or an <see cref="IDisposable"/> representing the registered callback.
+ /// Call <see cref="IDisposable.Dispose"/> on the returned instance to
+ /// cancel the registration.</returns>
+ public IDisposable? RegisterPayloadTransmittedCallback(OneCollectorExporterPayloadTransmittedCallbackAction callback, bool includeFailures)
+ => this.sink.Transport?.RegisterPayloadTransmittedCallback(callback, includeFailures);
 
  /// <inheritdoc/>
  protected override void Dispose(bool disposing)

src/OpenTelemetry.Exporter.OneCollector/OneCollectorExporterPayloadTransmittedCallbackArguments.cs

@@ -39,7 +39,8 @@ internal OneCollectorExporterPayloadTransmittedCallbackArguments(
  OneCollectorExporterSerializationFormatType payloadSerializationFormat,
  Stream payloadStream,
  OneCollectorExporterTransportProtocolType transportProtocol,
- Uri transportEndpoint)
+ Uri transportEndpoint,
+ bool succeeded)
  {
  Debug.Assert(payloadStream != null, "payload stream was null");
  Debug.Assert(payloadStream!.CanSeek, "payload stream was not seekable");
@@ -49,6 +50,7 @@ internal OneCollectorExporterPayloadTransmittedCallbackArguments(
  this.payloadStream = payloadStream;
  this.TransportProtocol = transportProtocol;
  this.TransportEndpoint = transportEndpoint!;
+ this.Succeeded = succeeded;
  }
 
  /// <summary>
@@ -61,6 +63,28 @@ internal OneCollectorExporterPayloadTransmittedCallbackArguments(
  /// </summary>
  public Uri TransportEndpoint { get; }
 
+ /// <summary>
+ /// Gets a value indicating whether or not the payload transmission was successful.
+ /// </summary>
+ /// <remarks>
+ /// Notes:
+ /// <list type="bullet">
+ /// <item>
+ /// A <see langword="true"/> value indicates a request was fully transmitted
+ /// and acknowledged.
+ /// </item>
+ /// <item>
+ /// A <see langword="false"/> value indicates a request did NOT fully
+ /// transmit or an acknowledgement was NOT received. Data may have been
+ /// partially or fully transmitted in this case.
+ /// </item>
+ /// <item>
+ /// <inheritdoc cref="OneCollectorExporter{T}.RegisterPayloadTransmittedCallback(OneCollectorExporterPayloadTransmittedCallbackAction)" path="/remarks"/>
+ /// </item>
+ /// </list>
+ /// </remarks>
+ public bool Succeeded { get; }
+
  /// <summary>
  /// Gets the payload serialization format.
  /// </summary>