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.

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

Merged IHasMeasurements into ISpanData #2659

Merged
merged 16 commits into from Oct 2, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Expand Up @@ -14,6 +14,10 @@ without native/platform specific bindings and SDKs. See [this ticket for more de

- Drop .NET 6 Mobile in favor of .NET 7 ([#2624](https://github.com/getsentry/sentry-dotnet/pull/2604))

API Changes:

- Removed IHasMeasurements ([#2659](https://github.com/getsentry/sentry-dotnet/pull/2659))

### Features

- Sentry tracing middleware now gets configured automatically ([#2602](https://github.com/getsentry/sentry-dotnet/pull/2602))
Expand Down
63 changes: 0 additions & 63 deletions src/Sentry/IHasMeasurements.cs

This file was deleted.

51 changes: 51 additions & 0 deletions src/Sentry/ITransactionData.cs
@@ -1,8 +1,59 @@
using Sentry.Protocol;

namespace Sentry;

/// <summary>
/// Immutable data belonging to a transaction.
/// </summary>
public interface ITransactionData : ISpanData, ITransactionContext, IEventLike
{
/// <summary>
/// The measurements that have been set on the transaction.
/// </summary>
IReadOnlyDictionary<string, Measurement> Measurements { get; }

/// <summary>
/// Sets a measurement on the transaction.
/// </summary>
/// <param name="name">The name of the measurement.</param>
/// <param name="measurement">The measurement.</param>
[EditorBrowsable(EditorBrowsableState.Never)]
jamescrosswell marked this conversation as resolved.
Show resolved Hide resolved
void SetMeasurement(string name, Measurement measurement);
}

/// <summary>
/// Extensions for <see cref="ITransactionData"/>
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public static class TransactionDataExtensions
{
/// <summary>
/// Sets a measurement on the transaction.
/// </summary>
/// <param name="transaction">The transaction.</param>
/// <param name="name">The name of the measurement.</param>
/// <param name="value">The value of the measurement.</param>
/// <param name="unit">The optional unit of the measurement.</param>
public static void SetMeasurement(this ITransactionData transaction, string name, int value,
MeasurementUnit unit = default) =>
transaction.SetMeasurement(name, new Measurement(value, unit));

/// <inheritdoc cref="SetMeasurement(Sentry.ITransactionData,string,int,Sentry.MeasurementUnit)" />
public static void SetMeasurement(this ITransactionData transaction, string name, long value,
MeasurementUnit unit = default) =>
transaction.SetMeasurement(name, new Measurement(value, unit));

/// <inheritdoc cref="SetMeasurement(Sentry.ITransactionData,string,int,Sentry.MeasurementUnit)" />
#if !__MOBILE__
// ulong parameter is not CLS compliant
[CLSCompliant(false)]
#endif
public static void SetMeasurement(this ITransactionData transaction, string name, ulong value,
MeasurementUnit unit = default) =>
transaction.SetMeasurement(name, new Measurement(value, unit));

/// <inheritdoc cref="SetMeasurement(Sentry.ITransactionData,string,int,Sentry.MeasurementUnit)" />
public static void SetMeasurement(this ITransactionData transaction, string name, double value,
MeasurementUnit unit = default) =>
transaction.SetMeasurement(name, new Measurement(value, unit));
}
10 changes: 10 additions & 0 deletions src/Sentry/Internal/NoOpTransaction.cs
@@ -1,3 +1,5 @@
using Sentry.Protocol;

namespace Sentry.Internal;

/// <summary>
Expand Down Expand Up @@ -78,8 +80,16 @@ public IReadOnlyList<string> Fingerprint
}

public IReadOnlyCollection<ISpan> Spans => ImmutableList<ISpan>.Empty;

public IReadOnlyCollection<Breadcrumb> Breadcrumbs => ImmutableList<Breadcrumb>.Empty;

public ISpan? GetLastActiveSpan() => default;

public void AddBreadcrumb(Breadcrumb breadcrumb) { }

public IReadOnlyDictionary<string, Measurement> Measurements => ImmutableDictionary<string, Measurement>.Empty;

public void SetMeasurement(string name, Measurement measurement)
{
}
}
2 changes: 1 addition & 1 deletion src/Sentry/Transaction.cs
Expand Up @@ -9,7 +9,7 @@ namespace Sentry;
/// <summary>
/// Sentry performance transaction.
/// </summary>
public class Transaction : ITransactionData, IJsonSerializable, IHasDistribution, IHasTransactionNameSource, IHasMeasurements
public class Transaction : ITransactionData, IJsonSerializable, IHasDistribution, IHasTransactionNameSource
{
/// <summary>
/// Transaction's event ID.
Expand Down
2 changes: 1 addition & 1 deletion src/Sentry/TransactionTracer.cs
Expand Up @@ -7,7 +7,7 @@ namespace Sentry;
/// <summary>
/// Transaction tracer.
/// </summary>
public class TransactionTracer : ITransaction, IHasDistribution, IHasTransactionNameSource, IHasMeasurements
public class TransactionTracer : ITransaction, IHasDistribution, IHasTransactionNameSource
{
private readonly IHub _hub;
private readonly SentryOptions? _options;
Expand Down