Adding custom data

User email

When you already have your users identified within your app, you might want to add their email automatically attached to the bug report. Bugsee provides APIs for setting, getting and clearing the email.

// setting email
BugseePlugin.Bugsee.SetEmail("name@example.com");

// getting email, null will be returned if email was not set.
String email = BugseePlugin.Bugsee.GetEmail();

// clearing email
BugseePlugin.Bugsee.ClearEmail();

User/Session attributes

Besides email, any arbitrary attributes can be attached to the report as well. Issues are searchable by these attributes in the Bugsee dashboard as well.

Note, that each attribute has a limit of 1kB and total size of all attributes must not be more than 25kB
BugseePlugin.Bugsee.SetAttribute("name", "John Doe");
BugseePlugin.Bugsee.SetAttribute("age", 23);
BugseePlugin.Bugsee.SetAttribute("married", false);

Once set, attributes persist until the application is uninstalled from the device. The can be cleared however using the following API.

// Clear a single attribute by name
BugseePlugin.Bugsee.ClearAttribute("name");

// .. or clear all of them
BugseePlugin.Bugsee.ClearAllAttributes();

Custom traces

Traces may be useful when you want to trace how a specific variable or state changes over time right before the problem happens.

// Number value
BugseePlugin.Bugsee.Trace("credit_balance", 15);

// String value
BugseePlugin.Bugsee.Trace("current_location", "USA");

// Boolean value
BugseePlugin.Bugsee.Trace("logged_in", true);

Custom events

Events are identified by a string and can have an optional dictionary of parameters that will be stored and passed along with the report.

// Without any additional parameters
BugseePlugin.Bugsee.Event("payment_processed");

// ...our with additional custom parameters
Dictionary<string, object> parameters = new Dictionary<string, object> ();
parameters.Add("amount", 125);
parameters.Add("currency", "USD");
BugseePlugin.Bugsee.Event("event with params", parameters);

File Attachments

Binary files (attachments) can also be added to the report right before report is being sent. The attachment will be available for download right from the issue viewer. Currently both the amount of attachments and their size is limited. Max of 3 attachments, 3MB (size increased from 1MB starting from v3.2.0).

Your should provide implementation for AttachmentForReport delegate and subscribe it to Bugsee.OnAttachmentForReport event.

Bugsee.OnAttachmentForReport += delegate (BugseeReport report)
{
    var attachments = new List<BugseeAttachment>();

    if (
        report.Severity == BugseeSeverityLevel.Blocker &&
        report.Type == BugseeIssueType.Crash
    )
    {
        attachments.Add(new BugseeAttachment()
        {
            name = "Attachment1",
            filename = "just_text.txt",
            data = System.Text.Encoding.UTF8.GetBytes("This is attachment content!")
        });
    }

    return attachments;
};