BabelReportingExtensions

Namespace: Babel.Licensing Assembly: Babel.Licensing.dll

A babel reporting extensions.

public static class BabelReportingExtensions

Inheritance

object ← BabelReportingExtensions

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Methods

SendExceptionReport(BabelReporting, string, Exception)

Sends an exception report to the BabelReporting service.

public static SendReportResult SendExceptionReport(this BabelReporting self, string userKey, Exception error)

Parameters

Name	Description
self BabelReporting	The BabelReporting instance.
userKey string	The license user key.
error Exception	The exception to be reported.

Returns

Name	Description
SendReportResult	The send report operation result .

SendExceptionReportAsync(BabelReporting, string, Exception, CancellationToken)

Sends an exception report asynchronously to the BabelReporting service.

public static Task<SendReportResult> SendExceptionReportAsync(this BabelReporting self, string userKey, Exception error, CancellationToken cancellationToken = default)

Parameters

Name	Description
self BabelReporting	The BabelReporting instance.
userKey string	The license user key.
error Exception	The exception to be reported.
cancellationToken CancellationToken	(Optional) A token that allows processing to be cancelled.

Returns

Name	Description
Task<SendReportResult>	A task representing the asynchronous operation that returns a .

Examples

C#

BabelReporting reporting = new BabelReporting();

BabelReporting.Configure(config => {
    // Set the service URL
    ServiceUrl = "http://localhost:5005",

	// If you want to encrypt the report, set the password here
	// This is the same password configured in Babel Licensing Service to decrypt the report
    config.EncryptionKey = "my custom encryption key";

	// Whether to collect the process information
    config.ExceptionReportOptions.Environment.CollectProcessInformation = true;
});

// Add report custom properties
reporting.BeforeSendReport += (s, e) => {                
	e.Report.Properties.Add("my_custom_property", "my custom value");
};

// Send the report
// User key can be obtained from the Babel Licensing service
string userKey = "user key here";
reporting.SendExceptionReport(userKey, new Exception("test exception"));

VB

Dim reporting As New BabelReporting()

BabelReporting.Configure(Sub(config)
    ' Set the service URL
    config.ServiceUrl = "http://localhost:5005"

    ' If you want to encrypt the report, set the password here
    ' This is the same password configured in Babel Licensing Service to decrypt the report
    config.EncryptionKey = "my custom encryption key"

    ' Whether to collect the process information
    config.ExceptionReportOptions.Environment.CollectProcessInformation = True
End Sub)

' Add report custom properties
AddHandler reporting.BeforeSendReport, Sub(s, e)
    e.Report.Properties.Add("my_custom_property", "my custom value")
End Sub

' Send the report
' User key can be obtained from the Babel Licensing service
Dim userKey As String = "user key here"
reporting.SendExceptionReport(userKey, New Exception("test exception"))

SendLicenseReport(BabelReporting, string)

A BabelReporting extension method that sends a license usage report.

public static SendReportResult SendLicenseReport(this BabelReporting self, string userKey)

Parameters

Name	Description
self BabelReporting	The self to act on.
userKey string	The license user key.

Returns

Name	Description
SendReportResult	The send report operation result .

SendLicenseReportAsync(BabelReporting, string, CancellationToken)

A BabelReporting extension method that sends a license usage report asynchronous.

public static Task<SendReportResult> SendLicenseReportAsync(this BabelReporting self, string userKey, CancellationToken cancellationToken = default)

Parameters

Name	Description
self BabelReporting	The self to act on.
userKey string	The license user key.
cancellationToken CancellationToken	(Optional) A token that allows processing to be cancelled.

Returns

Name	Description
Task<SendReportResult>	An asynchronous result that yields the send license usage report.