Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 0 additions & 1 deletion docs/trace/building-your-own-processor/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

using System.Diagnostics;
using OpenTelemetry;
using OpenTelemetry.Trace;

public class Program
{
Expand Down
2 changes: 0 additions & 2 deletions examples/Console/TestConsoleExporter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@

using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using OpenTelemetry;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
// </copyright>
using System;

using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
Expand Down
2 changes: 0 additions & 2 deletions src/OpenTelemetry/Trace/ActivityExporterSync.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;

namespace OpenTelemetry.Trace
{
Expand Down
125 changes: 125 additions & 0 deletions src/OpenTelemetry/Trace/BatchExportActivityProcessor.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
// <copyright file="BatchExportActivityProcessor.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// </copyright>

using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using OpenTelemetry.Internal;

namespace OpenTelemetry.Trace
{
/// <summary>
/// Implements processor that batches activities before calling exporter.
/// </summary>
public class BatchExportActivityProcessor : ActivityProcessor
{
private readonly ActivityExporterSync exporter;
private readonly int maxQueueSize;
private readonly TimeSpan scheduledDelay;
private readonly TimeSpan exporterTimeout;
private readonly int maxExportBatchSize;
private bool disposed;

/// <summary>
/// Initializes a new instance of the <see cref="BatchExportActivityProcessor"/> class with custom settings.
/// </summary>
/// <param name="exporter">Exporter instance.</param>
/// <param name="maxQueueSize">The maximum queue size. After the size is reached data are dropped. The default value is 2048.</param>
/// <param name="scheduledDelayMillis">The delay interval in milliseconds between two consecutive exports. The default value is 5000.</param>
/// <param name="exporterTimeoutMillis">How long the export can run before it is cancelled. The default value is 30000.</param>
/// <param name="maxExportBatchSize">The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.</param>
public BatchExportActivityProcessor(
ActivityExporterSync exporter,
int maxQueueSize = 2048,
int scheduledDelayMillis = 5000,
int exporterTimeoutMillis = 30000,
int maxExportBatchSize = 512)
{
if (maxQueueSize <= 0)
{
throw new ArgumentOutOfRangeException(nameof(maxQueueSize));
}

if (maxExportBatchSize <= 0 || maxExportBatchSize > maxQueueSize)
{
throw new ArgumentOutOfRangeException(nameof(maxExportBatchSize));
}

if (scheduledDelayMillis <= 0)
{
throw new ArgumentOutOfRangeException(nameof(scheduledDelayMillis));
}

if (exporterTimeoutMillis < 0)
{
throw new ArgumentOutOfRangeException(nameof(exporterTimeoutMillis));
}

this.exporter = exporter ?? throw new ArgumentNullException(nameof(exporter));
this.maxQueueSize = maxQueueSize;
this.scheduledDelay = TimeSpan.FromMilliseconds(scheduledDelayMillis);
this.exporterTimeout = TimeSpan.FromMilliseconds(exporterTimeoutMillis);
this.maxExportBatchSize = maxExportBatchSize;
}

/// <inheritdoc/>
public override void OnEnd(Activity activity)
{
// TODO
throw new NotImplementedException();
}

/// <inheritdoc/>
/// <exception cref="OperationCanceledException">If the <paramref name="cancellationToken"/> is canceled.</exception>
public override Task ForceFlushAsync(CancellationToken cancellationToken)
{
// TODO
throw new NotImplementedException();
}

/// <inheritdoc/>
/// <exception cref="OperationCanceledException">If the <paramref name="cancellationToken"/> is canceled.</exception>
public override Task ShutdownAsync(CancellationToken cancellationToken)
{
// TODO
throw new NotImplementedException();
}

/// <summary>
/// Releases the unmanaged resources used by this class and optionally releases the managed resources.
/// </summary>
/// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);

if (disposing && !this.disposed)
{
try
{
this.exporter.Dispose();
}
catch (Exception ex)
{
OpenTelemetrySdkEventSource.Log.SpanProcessorException(nameof(this.Dispose), ex);
}

this.disposed = true;
}
}
}
}
93 changes: 93 additions & 0 deletions src/OpenTelemetry/Trace/SimpleExportActivityProcessor.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
// <copyright file="SimpleExportActivityProcessor.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// </copyright>

using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using OpenTelemetry.Internal;

namespace OpenTelemetry.Trace
{
/// <summary>
/// Implements simple activity processor that exports activities in OnEnd call without batching.
/// </summary>
public class SimpleExportActivityProcessor : ActivityProcessor
{
private readonly ActivityExporterSync exporter;
private bool stopped;

/// <summary>
/// Initializes a new instance of the <see cref="SimpleExportActivityProcessor"/> class.
/// </summary>
/// <param name="exporter">Activity exporter instance.</param>
public SimpleExportActivityProcessor(ActivityExporterSync exporter)
{
this.exporter = exporter ?? throw new ArgumentNullException(nameof(exporter));
}

/// <inheritdoc />
public override void OnEnd(Activity activity)
{
try
{
// TODO: avoid heap allocation
_ = this.exporter.Export(new[] { activity });
}
catch (Exception ex)
{
OpenTelemetrySdkEventSource.Log.SpanProcessorException(nameof(this.OnEnd), ex);
}
}

/// <inheritdoc />
public override Task ShutdownAsync(CancellationToken cancellationToken)
{
if (!this.stopped)
{
this.exporter.Shutdown();
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for try/catch here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reyang I merged to unblock you, but probably need try/catch in a future PR?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need to get feedback here.

The spec is saying that exporter should not throw.

I had similar struggle here, whether should I trust the other processors won't throw, or I should make the composite one bullet proof.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the higher order question is, how much do we trust / rely on the other components (whether processors/exporters that we own / in this repo, or we don't own / in other repos) to follow the spec / be a good citizen.

Copy link
Copy Markdown
Member Author

@reyang reyang Aug 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is my take while I was a C/C++ runtime library dev:

  1. If a developer calls free on a buffer (allocated by malloc) that is already freed, we want to fail him instead of keep silent. In this way we are actually helping that developer to discover his bug, instead of hiding it since his bug could potentially has other implications (e.g. data loss, corruption, logical flaw).
  2. If the heap manager observed any sign of an incorrect heap (e.g. via integrity check on sentry bytes), it should crash the app ASAP instead of trying to hide the mistake (since the app might run on dangling pointers which writes dirty data to a database/file).

However, here I'm struggling as I believe we have another design principle - a telemetry SDK, once initialized, should not punish the users by killing their applications.

Copy link
Copy Markdown
Member Author

@reyang reyang Aug 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is mainly from the responsibility and dev experience perspective (no perf concern here).

For example if some bad guy developed a broken exporter that throws (against the spec law) and we swallowed the exception for him, it seems like we are contributing to a crime instead of reporting to the cops.

And if a good guy is developing an exporter where he made subtle mistake, by throwing error directly we helped him to fix his bug. Otherwise he will have to look at the self diagnostic logs.

Anyways, I'm struggling here which means I don't have strong preference (and as you can see, I do have strong preference that we should catch Dispose exception and I put that catch statement 😄). So I'm happy to change either way (or even have a global flag to turn on/off such behavior) if @alanwest @CodeBlanch or anyone in the community has a strong preference.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As usual, @reyang raises good points! I'm good with letting it throw. But I will say this... that doesn't necessarily guarantee anyone will pay attention! I have seen a lot of code get to prod where ops immediately starts complaining things won't shut down. Launch the app in dev, it is easily reproducable. How does this get by the devs? Because they use the "stop" button in VS which doesn't perform graceful shutdown 🙄

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, definitely good points to ponder. I'm also good with letting it throw.

Though, I've generally thought of the telemetry SDK and other profiling tools as similar to logging frameworks where "do no harm" is often the general mantra. Usually (hopefully) there are other signs that something is awry - like a sudden drop of data reported to your backend, even though seemingly your app is still running "just fine".

This conversation is definitely bigger than just exporter or processors - these questions would apply to instrumentation among other things as well. It's more of general design philosophy, maybe more appropriate for a spec-level kind of guidance/adoption?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A slightly different story from the Nt vs. Zw API.

I think given that none of us have strong opinion, and it seems @alanwest @CodeBlanch both have/had the intuition that it is nicer to swallow exception, we probably should go with the direction (to swallow exceptions) for now and make sure we handle this consistently across the repo?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I got two 👍 I'll send a PR to swallow the exception for both the exporting processor and composite processor.

this.stopped = true;
}

#if NET452
return Task.FromResult(0);
#else
return Task.CompletedTask;
#endif
}

/// <summary>
/// Releases the unmanaged resources used by this class and optionally releases the managed resources.
/// </summary>
/// <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);

if (disposing)
{
try
{
this.exporter.Dispose();
}
catch (Exception ex)
{
OpenTelemetrySdkEventSource.Log.SpanProcessorException(nameof(this.Dispose), ex);
}
}
}
}
}
1 change: 0 additions & 1 deletion test/OpenTelemetry.Tests/Resources/ResourceTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
using OpenTelemetry.Resources;
using Xunit;

namespace OpenTelemetry.Resources.Tests
Expand Down
1 change: 0 additions & 1 deletion test/OpenTelemetry.Tests/Resources/ResourcesTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
using OpenTelemetry.Resources;
using Xunit;

namespace OpenTelemetry.Resources.Tests
Expand Down
1 change: 0 additions & 1 deletion test/OpenTelemetry.Tests/Trace/OpenTelemetrySdkTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

using System.Diagnostics;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;
using Xunit;

namespace OpenTelemetry.Trace.Tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using OpenTelemetry.Context.Propagation;
using Xunit;

namespace OpenTelemetry.Context.Propagation.Tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using OpenTelemetry.Context.Propagation;

namespace OpenTelemetry.Context.Propagation.Tests
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using OpenTelemetry.Context.Propagation;
using Xunit;

namespace OpenTelemetry.Context.Propagation.Tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

using System.Collections.Generic;
using System.Linq;
using OpenTelemetry.Context.Propagation;
using Xunit;

namespace OpenTelemetry.Context.Propagation.Tests
Expand Down
1 change: 0 additions & 1 deletion test/OpenTelemetry.Tests/Trace/SpanAttributesTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
// </copyright>

using System;
using System.Collections.Generic;
using Xunit;

namespace OpenTelemetry.Trace.Tests
Expand Down
1 change: 0 additions & 1 deletion test/OpenTelemetry.Tests/Trace/TestSampler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
// </copyright>

using System;
using OpenTelemetry.Trace;

namespace OpenTelemetry.Trace.Tests
{
Expand Down