diff --git a/docs/ai/agent-skills/sdk/cordova/SKILL.md b/docs/ai/agent-skills/sdk/cordova/SKILL.md index 4a099c4..9dcb9c4 100644 --- a/docs/ai/agent-skills/sdk/cordova/SKILL.md +++ b/docs/ai/agent-skills/sdk/cordova/SKILL.md @@ -83,7 +83,7 @@ document.addEventListener('deviceready', function() { > Replace the tokens with values from your Bugsee dashboard. -> iOS/iPadOS: Since v7.0.0 the Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, use a real device. +> iOS/iPadOS: Since v6.0.0 the Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, use a real device. --- diff --git a/docs/ai/agent-skills/sdk/kmp/SKILL.md b/docs/ai/agent-skills/sdk/kmp/SKILL.md index ece0aa2..185bdc5 100644 --- a/docs/ai/agent-skills/sdk/kmp/SKILL.md +++ b/docs/ai/agent-skills/sdk/kmp/SKILL.md @@ -79,7 +79,7 @@ kotlin { sourceSets { commonMain.dependencies { - implementation("com.bugsee:bugsee-kotlin-multiplatform:+") + implementation("com.bugsee:bugsee-kotlin-multiplatform:0.1.1") } } } diff --git a/docs/ai/plugins/claude-code.md b/docs/ai/plugins/claude-code.md index aac53e4..0efe0d5 100644 --- a/docs/ai/plugins/claude-code.md +++ b/docs/ai/plugins/claude-code.md @@ -18,7 +18,7 @@ Add the Bugsee marketplace, then install the plugin: /plugin install bugsee@bugsee-plugin-marketplace ``` -That's it — Claude Code now has the Bugsee SDK-setup and workflow skills, and the read-only Bugsee MCP server (`https://api.bugsee.com/mcp`) is configured. +That's it — Claude Code now has the Bugsee SDK-setup and workflow skills, and the Bugsee MCP server (`https://api.bugsee.com/mcp`) is configured with the read-only `mcp:read` scope. ## Connect the MCP server @@ -37,6 +37,6 @@ Ask Claude Code in natural language: - **SDK setup skills** for every supported platform. - **Workflow skills**: `bugsee-fix-issues` (triage and root-cause crashes, errors, and bug reports through the MCP server), `bugsee-build-insights` (build size, regressions, and dependency vulnerabilities through the MCP server), and `bugsee-upload-symbols` (dSYMs, JavaScript source maps, Android mapping files). -- **MCP server** access to your Bugsee applications and issues (read-only). +- **MCP server** access to your Bugsee applications and issues (read-only by default — the `mcp:read` scope). See [Plugins](/ai/plugins) for the full list, or browse the source at [github.com/bugsee/bugsee-for-ai](https://github.com/bugsee/bugsee-for-ai). diff --git a/docs/ai/plugins/codex.md b/docs/ai/plugins/codex.md index 0a9bd40..dad8899 100644 --- a/docs/ai/plugins/codex.md +++ b/docs/ai/plugins/codex.md @@ -23,7 +23,7 @@ Repeat for any platform you need, or point Codex at the [bugsee-for-ai](https:// ## Connect the MCP server -Add the read-only Bugsee MCP server to your Codex configuration (`~/.codex/config.toml`) so the assistant can read your issues. Use the OAuth URL `https://api.bugsee.com/mcp`, or the personal-token URL `https://api.bugsee.com/mcp/` for unattended setups. See [MCP configuration](/mcp/configuration) for how to generate a token and the security model. +Add the Bugsee MCP server to your Codex configuration (`~/.codex/config.toml`) so the assistant can read your issues. Use the OAuth URL `https://api.bugsee.com/mcp`, or the personal-token URL `https://api.bugsee.com/mcp/` for unattended setups. See [MCP configuration](/mcp/configuration) for how to generate a token and the security model. ## Use it diff --git a/docs/ai/plugins/other-agents.md b/docs/ai/plugins/other-agents.md index c18de01..d7561ce 100644 --- a/docs/ai/plugins/other-agents.md +++ b/docs/ai/plugins/other-agents.md @@ -25,7 +25,7 @@ curl -o .claude/skills/bugsee-android-sdk/SKILL.md \ ## Any MCP-capable client -Connect the read-only Bugsee MCP server (`https://api.bugsee.com/mcp`) to read your applications and issues. [MCP configuration](/mcp/configuration) has per-client setup for Claude Desktop, Cursor, Windsurf, VS Code, Cline, Zencoder, and Antigravity, plus the OAuth and personal-token flows for anything else. +Connect the Bugsee MCP server (`https://api.bugsee.com/mcp`) to read your applications and issues; the default `mcp:read` scope is read-only. [MCP configuration](/mcp/configuration) has per-client setup for Claude Desktop, Cursor, Windsurf, VS Code, Cline, Zencoder, and Antigravity, plus the OAuth and personal-token flows for anything else. ## What you get diff --git a/docs/dashboard/accounts/2fa.md b/docs/dashboard/accounts/2fa.md index 5b11afc..7084202 100644 --- a/docs/dashboard/accounts/2fa.md +++ b/docs/dashboard/accounts/2fa.md @@ -28,8 +28,8 @@ Now, when you have configured your authentication application, it's time to chec ![](2fa-step-4.png) -If you have properly configured your authentication application and verification was passed successfully, 2FA will be enabled for your account and you will be provided with backup codes. Please, store them somewhere to later obtain access to your account if you will not be able to access your authentication application anymore. +If you have properly configured your authentication application and verification was passed successfully, 2FA will be enabled for your account and you will be provided with backup codes. Please store them somewhere to later obtain access to your account if you will not be able to access your authentication application anymore. ![](2fa-step-5.png) -Finally, click _"Complete"_ to close the wizard. Two-Factor authentication is now activated for your account. \ No newline at end of file +Finally, click _"Complete"_ to close the wizard. Two-factor authentication is now activated for your account. \ No newline at end of file diff --git a/docs/dashboard/accounts/sso/index.md b/docs/dashboard/accounts/sso/index.md index cc1496f..303f937 100644 --- a/docs/dashboard/accounts/sso/index.md +++ b/docs/dashboard/accounts/sso/index.md @@ -11,8 +11,8 @@ Bugsee provides a generic auth provider for SAML2 based authentication, which al Bugsee supports the following SAML services: -Identity and Service Provider initiated SSO -Identity Provider initiated SLO (Single Logout) +- Identity and Service Provider initiated SSO +- Identity Provider initiated SLO (Single Logout) ### 1. Register Bugsee with IdP diff --git a/docs/dashboard/accounts/sso/instructions/config-gsuite.md b/docs/dashboard/accounts/sso/instructions/config-gsuite.md index 44f1847..4e989af 100644 --- a/docs/dashboard/accounts/sso/instructions/config-gsuite.md +++ b/docs/dashboard/accounts/sso/instructions/config-gsuite.md @@ -27,11 +27,11 @@ On the next step, fill the _"Application name"_, _"Description"_ and _"Logo"_. ![](gsuite-step-5.png) -Now, on _"Service Provider Details"_ step, you need to fill information available in _"SSO setup"_ wizard in Bugsee. Please, follow the instructions shown in the screenshot below. +Now, on _"Service Provider Details"_ step, you need to fill information available in _"SSO setup"_ wizard in Bugsee. Please follow the instructions shown in the screenshot below. ![](gsuite-step-6.png) -Finally, on the _"Attribute Mapping"_ step, you need to list attributes that will be available to Bugsee (as Service Provider). Please, follow the instructions shown in the screenshot below. Copy the attribute names. You must provide the same names in the Bugsee SSO setup wizard dialog when prompted. +Finally, on the _"Attribute Mapping"_ step, you need to list attributes that will be available to Bugsee (as Service Provider). Please follow the instructions shown in the screenshot below. Copy the attribute names. You must provide the same names in the Bugsee SSO setup wizard dialog when prompted. :::info Note that Bugsee is using single field to store user name, while Google Workspace does not provide similar one by default. In this tutorial, we use "Last name" as the target value for the "name" attribute. diff --git a/docs/integrations/index.md b/docs/integrations/index.md index e1d1b00..3f29c73 100644 --- a/docs/integrations/index.md +++ b/docs/integrations/index.md @@ -19,12 +19,12 @@ If you don't find your tool among the available integrations, please contact _"Space"_ -> _"Folder"_ -> _"List"_ -> _"Task"_. So, we provide one more step in integration setup wizard that asks you to pick the _"Team"_ and _"Space"_ pair to fetch folders and lists from. Please, pick one and click _"Next"_ to proceed. +ClickUp has the following structure: _"Team"_ -> _"Space"_ -> _"Folder"_ -> _"List"_ -> _"Task"_. So, we provide one more step in integration setup wizard that asks you to pick the _"Team"_ and _"Space"_ pair to fetch folders and lists from. Please pick one and click _"Next"_ to proceed. ![Choose workspace](workspace.png) @@ -70,8 +70,9 @@ function create(context) { return { // ... custom: { - // for some tasks this is 'open', for some others it's 'open' - status: 'open' + // Bugsee maps its own 'open' state to ClickUp's 'to do' by default; + // your space or list may use 'open', 'backlog' or a custom name instead. + status: 'to do' } }; } diff --git a/docs/integrations/providers/github/index.md b/docs/integrations/providers/github/index.md index 76bfc95..e9415fb 100644 --- a/docs/integrations/providers/github/index.md +++ b/docs/integrations/providers/github/index.md @@ -68,11 +68,11 @@ For custom fields you can use in [custom recipes](/integrations/recipes/recipes/ ## Custom recipes -Bugsee can accommodate all these customizations with the help of [custom recipes](/integrations/recipes/recipes/). This section provides a few examples of using custom recipes specifically with Github. For basic introduction, refer to custom recipe [documentation](/integrations/recipes/recipes/). +Bugsee can accommodate all these customizations with the help of [custom recipes](/integrations/recipes/recipes/). This section provides a few examples of using custom recipes specifically with GitHub. For basic introduction, refer to custom recipe [documentation](/integrations/recipes/recipes/). ### Setting labels field -By default Bugsee creates and updates Github issues with Bugsee issue _labels_. But _labels_ list can be overridden inside your custom recipe. For example you can add some new _label_ to existing ones: +By default Bugsee creates and updates GitHub issues with Bugsee issue _labels_. But _labels_ list can be overridden inside your custom recipe. For example you can add some new _label_ to existing ones: ```javascript function create(context) { diff --git a/docs/integrations/providers/gitlab/index.md b/docs/integrations/providers/gitlab/index.md index 73d874c..0a6a3fd 100644 --- a/docs/integrations/providers/gitlab/index.md +++ b/docs/integrations/providers/gitlab/index.md @@ -60,11 +60,11 @@ There are no specific configuration steps for GitLab. Refer to .atlassian.net```) and click _"Next"_. +Skip instructional steps. Provide valid URL to your Jira (if you're using Jira Cloud, then it will be ```https://.atlassian.net```) and click _"Next"_. ![Select OAuth](wz_step2_oauth.png) -You will be presented with dialog asking you to grant Bugsee permissions. Click _Allow_ to allow Bugsee access your JIRA. +You will be presented with dialog asking you to grant Bugsee permissions. Click _Allow_ to allow Bugsee access your Jira. ![OAuth Grant](oauth_grant.png) @@ -120,12 +120,12 @@ Paste the code you copied in previous step. Click _"Next"_. ## Configuration -There are no specific configuration steps for JIRA. Refer to configuration section for description about generic steps. +There are no specific configuration steps for Jira. Refer to configuration section for description about generic steps. ## Custom recipes -JIRA is very customizable, fields can be made mandatory, new fields can be added, issue types, priorities and other default types can be changed. Bugsee can accommodate all these customizations with the help of [custom recipes](/integrations/recipes/recipes/). This section provides a few examples of using custom recipes specifically with JIRA. For basic introduction, refer to custom recipe [documentation](/integrations/recipes/recipes/). +Jira is very customizable, fields can be made mandatory, new fields can be added, issue types, priorities and other default types can be changed. Bugsee can accommodate all these customizations with the help of [custom recipes](/integrations/recipes/recipes/). This section provides a few examples of using custom recipes specifically with Jira. For basic introduction, refer to custom recipe [documentation](/integrations/recipes/recipes/). Some fields in sent to Jira, require specifying _accountId_ field. You can find it by navigating to your Jira's _People_ section: ```https://.atlassian.net/people```. From there, select the user you want to get accountId for and URL in browser will change to something like: ```https://.atlassian.net/people/123456:44448ae7-90ce-4e62-bfda-e88abcde5555```. The last segment of URL, after "people/" is accountId, which in this particular case is ```123456:44448ae7-90ce-4e62-bfda-e88abcde5555```. @@ -278,15 +278,15 @@ function create(context) { return { // ... custom: { - // We use default JIRA versions field, which is an array of available version in JIRA. - // Important: This assumes the version with that name is already created in JIRA prior to first issue + // We use default Jira versions field, which is an array of available version in Jira. + // Important: This assumes the version with that name is already created in Jira prior to first issue // being reported, otherwise integration will break. versions : [ { name : app.version } ], - // To store the build number, we have a custom field created in JIRA, so lets store it there + // To store the build number, we have a custom field created in Jira, so lets store it there customfield_10308 : app.build } }; diff --git a/docs/integrations/providers/notion/index.md b/docs/integrations/providers/notion/index.md index b999374..74b3e65 100644 --- a/docs/integrations/providers/notion/index.md +++ b/docs/integrations/providers/notion/index.md @@ -11,7 +11,7 @@ Bugsee requires the "Projects and tasks" template to be present in the workspace During the authentication process you will be asked to grant Bugsee the access to your workspace in Notion. Make sure you select both "Projects" and "Tasks" databases. -Once authenticated, you will need to add the "Description" field to the task template. You can do that by creating the dummy task, opening it and clicking on "Add a property" button below the task fields (not, that this button may be collapsed under the "# more property" toggle). +Once authenticated, you will need to add the "Description" field to the task template. You can do that by creating the dummy task, opening it and clicking on "Add a property" button below the task fields (note that this button may be collapsed under the "# more property" toggle). ![Add description field](add_description_field.png) diff --git a/docs/integrations/providers/pivotal/index.md b/docs/integrations/providers/pivotal/index.md index 2e621ce..e81b0c8 100644 --- a/docs/integrations/providers/pivotal/index.md +++ b/docs/integrations/providers/pivotal/index.md @@ -5,6 +5,12 @@ sidebar_position: 21 slug: "/integrations/providers/pivotal" --- +:::warning[This integration is retired] +Pivotal Tracker was discontinued on **30 April 2025**. Bugsee can no longer create or update stories, and attempting to push to an existing Pivotal Tracker integration returns an error. + +Existing configurations are left in place so historical links keep resolving, but no new stories will be delivered. Migrate to another supported provider from the [integrations list](/integrations/). +::: + ## Authentication ### Supported authentication methods diff --git a/docs/integrations/providers/redmine/index.md b/docs/integrations/providers/redmine/index.md index 354e826..cf5a029 100644 --- a/docs/integrations/providers/redmine/index.md +++ b/docs/integrations/providers/redmine/index.md @@ -15,7 +15,7 @@ To let Bugsee integrate with your Redmine, you should enable REST API access. En - [Personal token](#personal-token) -## Basic authentication +### Basic authentication :::info No custom configuration required in Redmine for this type of authentication. diff --git a/docs/integrations/providers/splunk/index.md b/docs/integrations/providers/splunk/index.md index eb80523..bfc035a 100644 --- a/docs/integrations/providers/splunk/index.md +++ b/docs/integrations/providers/splunk/index.md @@ -124,8 +124,6 @@ In case, if you want to push data to some other _"index"_ and/or change the _"so ``` -## Custom recipes - Bugsee can accommodate all these customizations with the help of [custom recipes](/integrations/recipes/recipes/). This section provides a few examples of using custom recipes specifically with Splunk. For basic introduction, refer to custom recipe [documentation](/integrations/recipes/recipes/). ### Setting labels field diff --git a/docs/integrations/providers/wrike/index.md b/docs/integrations/providers/wrike/index.md index 7bfaf85..e19fd3b 100644 --- a/docs/integrations/providers/wrike/index.md +++ b/docs/integrations/providers/wrike/index.md @@ -13,7 +13,7 @@ slug: "/integrations/providers/wrike" ### OAuth -Start Bugsee integration wizard and select "OAuth" at the first step. Click _"Next"_. +Start Bugsee integration wizard and select "OAuth" at the first step. Click _"Next"_. ![Select OAuth](wz_step1_oauth.png) diff --git a/docs/integrations/providers/youtrack/index.md b/docs/integrations/providers/youtrack/index.md index 08befda..7d03773 100644 --- a/docs/integrations/providers/youtrack/index.md +++ b/docs/integrations/providers/youtrack/index.md @@ -14,7 +14,7 @@ slug: "/integrations/providers/youtrack" ### Basic authentication -To create issues in YouTrack you need to ensure that YouTrack account you will be using to integrate Bugsee has _"Reporter"_ role assigned to it. Please, follow steps below to do that. +To create issues in YouTrack you need to ensure that YouTrack account you will be using to integrate Bugsee has _"Reporter"_ role assigned to it. Please follow steps below to do that. Login to your YouTrack instance and go to user management page diff --git a/docs/integrations/providers/zoho_desk/index.md b/docs/integrations/providers/zoho_desk/index.md index 21dac98..8e3bd4d 100644 --- a/docs/integrations/providers/zoho_desk/index.md +++ b/docs/integrations/providers/zoho_desk/index.md @@ -16,7 +16,7 @@ slug: "/integrations/providers/zoho_desk" Start Bugsee integration wizard and select "OAuth" in the first step of integration wizard. Click "Next". -## OAuth +### OAuth ![Select OAuth](wz_step1_oauth.png) diff --git a/docs/integrations/recipes/recipes_issues.mdx b/docs/integrations/recipes/recipes_issues.mdx index f5a403b..ecbbc38 100644 --- a/docs/integrations/recipes/recipes_issues.mdx +++ b/docs/integrations/recipes/recipes_issues.mdx @@ -170,12 +170,11 @@ To mitigate this, we let you set the _description\_format_ field. By default, it |Aha|html| |Asana|raw| |Basecamp|html| -|BitBucket|markdown| -|BugZilla|raw| +|Bitbucket|markdown| +|Bugzilla|raw| |Freshdesk|html| |GitHub|markdown| |GitLab|markdown| -|Hipchat|html| |Jira|markdown| |Monday|html| |Nozbe|markdown| @@ -184,8 +183,7 @@ To mitigate this, we let you set the _description\_format_ field. By default, it |Redmine|raw| |Shortcut|markdown| |Slack|raw| -|Targetprocess|html| -|Testlio|raw| +|TargetProcess|html| |Trello|raw| |VSTS|html| |Wrike|raw| @@ -235,7 +233,7 @@ The input to the _create()_ and _update()_ methods is a full context of the issu } ], last_recording_id: '5fe309e2b87c320a48000000', // ID of the recently added recording (optional) - recordings: 1 // Number of recordings within this issue. For bugs it's always equal 1. + recordings: 1, // Number of recordings within this issue. For bugs it's always equal 1. statistics: { total_count: 1, // Total number of occurrences unique_devices: 1 // Total number of users (devices) affected by this issue diff --git a/docs/integrations/recipes/recipes_notifications.md b/docs/integrations/recipes/recipes_notifications.md index 8beb59e..7aa98a7 100644 --- a/docs/integrations/recipes/recipes_notifications.md +++ b/docs/integrations/recipes/recipes_notifications.md @@ -56,6 +56,6 @@ Note that the result is not used as-is. Before executing the recipe, a default m |title|String|Title of the message| |description|String|Description for the message| |severity|Number|Message severity. Value from 1 through 5 (from lower to higher). Pass 0 to ignore severity.| -|fields|Array|Array of ```{ title: '', value: '' }``` objects, that denote the additional fields for the message.| +|fields|Array|Array of `{ title: '', value: '' }` objects, that denote the additional fields for the message.| If you want to prevent pushing message to remote service, return ```null``` from the ```handle()```. \ No newline at end of file diff --git a/docs/sdk/android/appearance.mdx b/docs/sdk/android/appearance.mdx index 26cb21b..76a9f3d 100644 --- a/docs/sdk/android/appearance.mdx +++ b/docs/sdk/android/appearance.mdx @@ -1,6 +1,6 @@ --- title: "Appearance" -description: "Customizing the Bugsee report dialog, notification icons, and feedback UI appearance in Bugsee Android SDK 7.0.0." +description: "Customizing the Bugsee report dialog, notification icons, and feedback UI appearance in Bugsee Android SDK 7.x." sidebar_position: 9 slug: "/sdk/android/appearance" --- diff --git a/docs/sdk/android/breadcrumbs.mdx b/docs/sdk/android/breadcrumbs.mdx index 7164abb..d776349 100644 --- a/docs/sdk/android/breadcrumbs.mdx +++ b/docs/sdk/android/breadcrumbs.mdx @@ -1,13 +1,14 @@ --- title: "Breadcrumbs" description: "What breadcrumbs are and how to record your own with Bugsee.addBreadcrumb in the Bugsee Android SDK." +sidebar_position: 11 slug: "/sdk/android/breadcrumbs" --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This page documents the Bugsee Android SDK **7.0.0**. For the previous major version, see [Adding custom data](/sdk/android/v6/custom). +This page documents the Bugsee Android SDK **7.x**. For the previous major version, see [Adding custom data](/sdk/android/v6/custom). Breadcrumbs are small contextual entries that record the sequence of events leading up to an issue — navigation, taps, lifecycle changes, network requests, and system events. They are aggregated into the report timeline and surface in the Bugsee dashboard. The SDK captures four built-in breadcrumb sources (app, UI, network, and system) automatically; to disable collection, scrub, or drop them, see [Privacy → Breadcrumbs](/sdk/android/privacy/breadcrumbs). diff --git a/docs/sdk/android/configuration/ndk.mdx b/docs/sdk/android/configuration/ndk.mdx index 824858e..42e3377 100644 --- a/docs/sdk/android/configuration/ndk.mdx +++ b/docs/sdk/android/configuration/ndk.mdx @@ -14,12 +14,16 @@ Native crash detection is shipped as the **`bugsee-android-ndk` extension module The NDK extension exposes two runtime options: the master switch for native crash detection, and a toggle for including the OS tombstone's raw log buffers in native crash reports. -The programmatic constants live in the extension's own package: +The programmatic constants live in the shared contracts package, alongside every other Bugsee contract type: ```java -import com.bugsee.library.ndk.contracts.options.NdkOptions; +import com.bugsee.library.contracts.options.NdkOptions; ``` +:::info +Earlier builds exposed these keys from the module-nested `com.bugsee.library.ndk.contracts.options` package. That class still exists as a deprecated source-compatibility alias — the constants resolve to identical string values, so switching the import is a no-op at runtime — but it will be removed in a future major version. +::: + ## Detect and report native crashes | Constant | Manifest key | Type | Default | diff --git a/docs/sdk/android/configuration/overview.mdx b/docs/sdk/android/configuration/overview.mdx index a008f86..2194078 100644 --- a/docs/sdk/android/configuration/overview.mdx +++ b/docs/sdk/android/configuration/overview.mdx @@ -228,7 +228,7 @@ See [Performance monitoring](/sdk/android/performance) for the APM overview. | `PerformanceUploadMode` | `com.bugsee.option.performance.upload-mode` | String | `"batched"` | How standalone APM data is uploaded: `"batched"` (30 s flush) or `"realtime"`. | | `PerformanceAdaptiveSampling` | `com.bugsee.option.performance.adaptive-sampling` | boolean | `true` | On top of the static sample rate, promote "interesting" unsampled transactions — scored at finish by status, duration outlier-ness, and span-tree complexity — into the upload pipeline. | -`PerformanceUploadMode` accepts `"batched"` (30 s flush) or `"realtime"`. `PerformanceSampleRate` gates **standalone APM uploads only** — every transaction still flows into the capture pipeline for reports regardless of sampling. `PerformanceAdaptiveSampling = true` turns the sample rate into a ceiling rather than a fixed probability. +`PerformanceUploadMode` accepts `"batched"` (30 s flush) or `"realtime"`. `PerformanceSampleRate` gates **standalone APM uploads only** — every transaction still flows into the capture pipeline for reports regardless of sampling. `PerformanceAdaptiveSampling = true` turns the sample rate into a floor rather than a fixed probability — scored transactions are promoted on top of the random draw. ## Enum reference diff --git a/docs/sdk/android/events-and-traces.mdx b/docs/sdk/android/events-and-traces.mdx index 8418a98..bb5e1e0 100644 --- a/docs/sdk/android/events-and-traces.mdx +++ b/docs/sdk/android/events-and-traces.mdx @@ -1,13 +1,14 @@ --- title: "Custom events & traces" description: "Recording custom events and time-series traces into the Bugsee Android SDK report timeline." +sidebar_position: 12 slug: "/sdk/android/events-and-traces" --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This page documents the Bugsee Android SDK **7.0.0**. For the previous major version, see [Adding custom data](/sdk/android/v6/custom). +This page documents the Bugsee Android SDK **7.x**. For the previous major version, see [Adding custom data](/sdk/android/v6/custom). In addition to the data Bugsee captures automatically, you can enrich reports with your own signals. Custom events and traces live on the `Bugsee` facade and are safe to call before or after `Bugsee.launch(...)` — calls made before launch are buffered. diff --git a/docs/sdk/android/faq.md b/docs/sdk/android/faq.md index 8d7a5ab..cd5b28e 100644 --- a/docs/sdk/android/faq.md +++ b/docs/sdk/android/faq.md @@ -1,6 +1,6 @@ --- title: "FAQ" -description: "Frequently asked questions about Bugsee Android SDK 7.0.0." +description: "Frequently asked questions about Bugsee Android SDK 7.x." sidebar_position: 18 slug: "/sdk/android/faq" --- @@ -9,7 +9,7 @@ Looking for the previous major version? See the [6.x FAQ](/sdk/android/v6/faq). **1. What is the minimum Android version supported by Bugsee Android SDK?** -Bugsee Android SDK 7.0.0 supports Android 5.0 (API level 21) and up. +Bugsee Android SDK 7.x supports Android 5.0 (API level 21) and up.
diff --git a/docs/sdk/android/feedback.mdx b/docs/sdk/android/feedback.mdx index 1104448..e89c8ba 100644 --- a/docs/sdk/android/feedback.mdx +++ b/docs/sdk/android/feedback.mdx @@ -1,6 +1,6 @@ --- title: "Feedback" -description: "Installing and using the bugsee-android-feedback extension module for in-app feedback UI in Bugsee Android SDK 7.0.0." +description: "Installing and using the bugsee-android-feedback extension module for in-app feedback UI in Bugsee Android SDK 7.x." sidebar_position: 8 slug: "/sdk/android/feedback" --- diff --git a/docs/sdk/android/installation.mdx b/docs/sdk/android/installation.mdx index f13ddc2..004913e 100644 --- a/docs/sdk/android/installation.mdx +++ b/docs/sdk/android/installation.mdx @@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; :::note -This page documents Bugsee Android SDK 7.0. For the previous release, see the [6.x installation guide](/sdk/android/v6/installation). +This page documents Bugsee Android SDK 7.x. For the previous release, see the [6.x installation guide](/sdk/android/v6/installation). ::: Bugsee ships as a core artifact plus one extension module per optional capability, and requires the Gradle plugin, which performs build-time bytecode and Kotlin-compiler instrumentation (APM operation dispatch, log capture, OkHttp injection, Compose secure modifier, etc.). Without the plugin, several features stop working or require manual wiring. diff --git a/docs/sdk/android/logs.mdx b/docs/sdk/android/logs.mdx index ab42432..9515a5a 100644 --- a/docs/sdk/android/logs.mdx +++ b/docs/sdk/android/logs.mdx @@ -1,6 +1,6 @@ --- title: "Console logs" -description: "Capturing Logcat output and recording custom log entries with Bugsee Android SDK 7.0.0, including log filtering via EventFilter." +description: "Capturing Logcat output and recording custom log entries with Bugsee Android SDK 7.x, including log filtering via EventFilter." sidebar_position: 7 slug: "/sdk/android/logs" --- @@ -8,7 +8,7 @@ slug: "/sdk/android/logs" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This page documents the Bugsee Android SDK **7.0.0**. For the previous major +This page documents the Bugsee Android SDK **7.x**. For the previous major version, see the [6.x Logging page](/sdk/android/v6/logs). ## Automatic Logcat capture diff --git a/docs/sdk/android/manual/bug-reporting.mdx b/docs/sdk/android/manual/bug-reporting.mdx index cbc2dd9..05610b4 100644 --- a/docs/sdk/android/manual/bug-reporting.mdx +++ b/docs/sdk/android/manual/bug-reporting.mdx @@ -1,13 +1,14 @@ --- title: "Bug reporting" description: "Let users and your code file bug reports with the Bugsee Android SDK — shake and screenshot triggers, the report dialog, silent upload, programmatic report creation, and the ReportHandler hook." +sidebar_position: 1 slug: "/sdk/android/manual/bug-reporting" --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This page documents the Bugsee Android SDK **7.0.0**. For the previous major version, see the [6.x documentation](/sdk/android/v6/manual). +This page documents the Bugsee Android SDK **7.x**. For the previous major version, see the [6.x documentation](/sdk/android/v6/manual). Bug reports cover something that is wrong but did not crash the app. Your users can raise one with a gesture, or you can open the report dialog — or submit a report silently — from your own code. (Crashes and handled errors are covered separately, in [Crash & error reporting](/sdk/android/manual/crash-error-reporting).) diff --git a/docs/sdk/android/manual/crash-error-reporting.mdx b/docs/sdk/android/manual/crash-error-reporting.mdx index 7dac17c..c33d4fe 100644 --- a/docs/sdk/android/manual/crash-error-reporting.mdx +++ b/docs/sdk/android/manual/crash-error-reporting.mdx @@ -1,6 +1,7 @@ --- title: "Crash & error reporting" description: "Crashes are captured automatically by the Bugsee Android SDK; this page covers reporting handled errors with logException, manual crash reporting, and verifying the crash pipeline with testCrash." +sidebar_position: 2 slug: "/sdk/android/manual/crash-error-reporting" --- diff --git a/docs/sdk/android/migration.mdx b/docs/sdk/android/migration.mdx index f3aedfd..afeaeb5 100644 --- a/docs/sdk/android/migration.mdx +++ b/docs/sdk/android/migration.mdx @@ -396,7 +396,7 @@ Every option key changed name. Use this table to do a mechanical search/replace | `CrashReport` | `DetectAndReportCrash` | | `DetectAppExit` | `DetectAndReportExit` | | `DetectAppLaunchCrash` | `DetectAndReportEarlyCrash` | -| _(not available)_ | `DetectAndReportCrashNdk` | +| _(not available)_ | `NdkOptions.DetectAndReport` (in the `bugsee-android-ndk` module — see [NDK options](/sdk/android/configuration/ndk)) | | _(not available)_ | `DetectAndReportHang` | | _(not available)_ | `DetectAndReportMainThreadMisuse` | | _(not available)_ | `DetectAndReportHttpErrors` | diff --git a/docs/sdk/android/network.mdx b/docs/sdk/android/network.mdx index ad99626..e79127a 100644 --- a/docs/sdk/android/network.mdx +++ b/docs/sdk/android/network.mdx @@ -1,6 +1,6 @@ --- title: "Network events" -description: "Capture HTTP request/response metadata via OkHttp, Ktor 2/3, and Cronet extension modules for Bugsee Android SDK 7.0.0." +description: "Capture HTTP request/response metadata via OkHttp, Ktor 2/3, and Cronet extension modules for Bugsee Android SDK 7.x." sidebar_position: 6 slug: "/sdk/android/network" --- diff --git a/docs/sdk/android/overview.mdx b/docs/sdk/android/overview.mdx index 00dc3ca..d7aaffe 100644 --- a/docs/sdk/android/overview.mdx +++ b/docs/sdk/android/overview.mdx @@ -1,6 +1,7 @@ --- title: "Overview" description: "What the Bugsee Android SDK records and detects, how it fits into your app, its requirements, and the device types it supports — phones, tablets, Android TV, Wear OS, and Automotive." +sidebar_position: 0 slug: "/sdk/android/overview" --- diff --git a/docs/sdk/android/performance.mdx b/docs/sdk/android/performance.mdx index 9f6bc0d..b49efae 100644 --- a/docs/sdk/android/performance.mdx +++ b/docs/sdk/android/performance.mdx @@ -1,6 +1,6 @@ --- title: "Performance monitoring" -description: "Application performance monitoring (APM) with transactions, spans, built-in providers, sampling, and upload modes in Bugsee Android SDK 7.0.0." +description: "Application performance monitoring (APM) with transactions, spans, built-in providers, sampling, and upload modes in Bugsee Android SDK 7.x." sidebar_position: 13 slug: "/sdk/android/performance" --- @@ -181,8 +181,8 @@ APM emits two independent data streams — see [Two data paths](#two-data-paths) | Option | Default | Purpose | | --- | --- | --- | | `PerformanceMonitoring` | `true` | Master switch. When `false`, `startTransaction`/`startSpan` return no-op instances and no provider runs. | -| `PerformanceSampleRate` | `0.01` | Probability (0.0–1.0) that a completed transaction is uploaded through the standalone APM pipeline. Does **not** affect whether transactions appear in issue reports. When `PerformanceAdaptiveSampling` is on, this acts as a ceiling rather than a fixed probability. | -| `PerformanceAdaptiveSampling` | `true` | Adaptive sampling — the SDK adjusts the effective sample rate based on observed transaction volume so high-traffic operations don't dominate the upload budget. Set to `false` to keep `PerformanceSampleRate` as a fixed probability. _New in 7.0.0._ | +| `PerformanceSampleRate` | `0.01` | Probability (0.0–1.0) that a completed transaction is uploaded through the standalone APM pipeline. Does **not** affect whether transactions appear in issue reports. When `PerformanceAdaptiveSampling` is on, this acts as a floor: transactions that lose the random draw can still be promoted on merit. | +| `PerformanceAdaptiveSampling` | `true` | Adaptive sampling — transactions that lost the random draw are scored at finish time on status, duration outlier-ness, and span-tree complexity, and sufficiently "interesting" ones are promoted into the upload pipeline. Set to `false` to keep `PerformanceSampleRate` as a fixed probability. _New in 7.0.0._ | | `PerformanceUploadMode` | `"batched"` | How sampled transactions are uploaded. `"batched"` flushes on a 30-second interval; `"realtime"` uploads as soon as a transaction finishes. | All four options can be set programmatically via the `Bugsee.launch(...)` options map or via manifest metadata. See [Configuration](/sdk/android/configuration) for the mapping between `Options.*` constants and `com.bugsee.option.performance.*` manifest keys. diff --git a/docs/sdk/android/user-session-data.mdx b/docs/sdk/android/user-session-data.mdx index 896293d..f129676 100644 --- a/docs/sdk/android/user-session-data.mdx +++ b/docs/sdk/android/user-session-data.mdx @@ -1,13 +1,14 @@ --- title: "User & session data" description: "Attaching user and session attributes and a stable user identifier to Bugsee Android SDK reports." +sidebar_position: 13 slug: "/sdk/android/user-session-data" --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This page documents the Bugsee Android SDK **7.0.0**. For the previous major version, see [Adding custom data](/sdk/android/v6/custom). +This page documents the Bugsee Android SDK **7.x**. For the previous major version, see [Adding custom data](/sdk/android/v6/custom). Annotate every report with facts about the current user and session: arbitrary key/value **attributes**, and a stable **user identifier**. Both live on the `Bugsee` facade and are safe to call before or after `Bugsee.launch(...)`. diff --git a/docs/sdk/android/v6/appearance.mdx b/docs/sdk/android/v6/appearance.mdx index cc928a9..bbd7e34 100644 --- a/docs/sdk/android/v6/appearance.mdx +++ b/docs/sdk/android/v6/appearance.mdx @@ -73,7 +73,6 @@ Bugsee.getAppearance().FeedbackInputTextColor = Integer.decode("0xff9999ff") | FeedbackVersionChangedTextColor | Text color in a bar in Feedback UI, which indicates that app version has changed | | NotificationTitleResId | String resource id of Bugsee notification title. NotificationTitle can be set instead. | | NotificationTitle | Bugsee notification title. NotificationTitleResId can be set instead | -| --- | --- | | ReportSummaryPlaceholder | Placeholder which is displayed in Summary field in built-in bug reporting UI | | ReportDescriptionPlaceholder | Placeholder which is displayed in Description field in built-in bug reporting UI | | ReportEmailPlaceholder | Placeholder which is displayed in Email field in built-in bug reporting UI | diff --git a/docs/sdk/android/v6/configuration.mdx b/docs/sdk/android/v6/configuration.mdx index cbfcc54..07cdb6a 100644 --- a/docs/sdk/android/v6/configuration.mdx +++ b/docs/sdk/android/v6/configuration.mdx @@ -172,7 +172,7 @@ Bugsee.stop() |DefaultCrashPriority|IssueSeverity.Blocker|Default priority for crashes. Option has value of com.bugsee.library.data.IssueSeverity type.| |DefaultBugPriority|IssueSeverity.High|Default priority for bugs. Option has value of com.bugsee.library.data.IssueSeverity type.| |CaptureDeviceAndNetworkNames|true|Capture device name, wifi SSID and mobile carrier name.| -|RememberUserDecisionForScreenCapture|false|Instructs Bugsee SDK to remember the choice user has made when permission dialog was shown for VideoMode.V2. To reset the remembered choice, use ```Bugsee.resetVideoCapturePermissionDecision()``` method.| +|RememberUserDecisionForScreenCapture|false|Instructs Bugsee SDK to remember the choice user has made when permission dialog was shown for VideoMode.V2. To reset the remembered choice, use `Bugsee.resetVideoCapturePermissionDecision()` method.| |ReportSummaryRequired|false|Controls whether _"Summary"_ field in bug reporting UI is mandatory or not.| |ReportDescriptionRequired|false|Controls whether _"Description"_ field in bug reporting UI is mandatory or not.| |ReportEmailRequired|false|Controls whether _"Email"_ field in bug reporting UI is mandatory or not.| diff --git a/docs/sdk/android/v6/custom.mdx b/docs/sdk/android/v6/custom.mdx index 5c3bdd1..7941703 100644 --- a/docs/sdk/android/v6/custom.mdx +++ b/docs/sdk/android/v6/custom.mdx @@ -198,7 +198,7 @@ Bugsee.setReportAttachmentsProvider(new ReportAttachmentsProvider() { ArrayList resultList = new ArrayList<>(); // If it is a Blocker or crash. - if (report.getType() == Report.Type.Crash || report.getSeverity() == IssueSeverity.Blocker) { + if (report.getType() == IssueType.Crash || report.getSeverity() == IssueSeverity.Blocker) { // myFilePath is a path to a file that should be attached to the report. CustomAttachment attachment = CustomAttachment.fromDataFilePath(myFilePath); attachment.setFileName("detailed_info.txt"); diff --git a/docs/sdk/android/v6/faq.md b/docs/sdk/android/v6/faq.md index d525dc3..f2f17af 100644 --- a/docs/sdk/android/v6/faq.md +++ b/docs/sdk/android/v6/faq.md @@ -36,7 +36,7 @@ These values were measured on Google Pixel 5 with Android 12 and can be influenc AAPT: error: attribute android:foregroundServiceType not found. ``` -Please, switch `compileSdk` in your build.gradle to the latest version (at least 35, as shown below). +Please switch `compileSdk` in your build.gradle to the latest version (at least 35, as shown below). ```groovy android { compileSdk 35 diff --git a/docs/sdk/android/v6/logs.mdx b/docs/sdk/android/v6/logs.mdx index 28b1050..89ea955 100644 --- a/docs/sdk/android/v6/logs.mdx +++ b/docs/sdk/android/v6/logs.mdx @@ -20,7 +20,7 @@ No special setup is required if you just need to retrieve standard logcat logs, ```java -// With default log level (normal) +// With default log level (info) Bugsee.log("Some log message"); // Set the log level explicitly @@ -33,7 +33,7 @@ Bugsee.log("Some log message", BugseeLogLevel.Warning); ```kotlin -// With default log level (normal) +// With default log level (info) Bugsee.log("Some log message") // Set the log level explicitly diff --git a/docs/sdk/android/v6/maven-installation.md b/docs/sdk/android/v6/maven-installation.md index 00a3cc4..5b4bd81 100644 --- a/docs/sdk/android/v6/maven-installation.md +++ b/docs/sdk/android/v6/maven-installation.md @@ -22,7 +22,7 @@ Add Bugsee dependency to your pom.xml com.bugsee bugsee-android - 1.11.7 + 6.0.4 aar @@ -58,5 +58,5 @@ Maven can't merge app's and library's manifests automatically. That's why it is android:theme="@style/BugseeActivityStyle"> - ``` \ No newline at end of file diff --git a/docs/sdk/android/v6/privacy/video.mdx b/docs/sdk/android/v6/privacy/video.mdx index 67fe279..f5b352b 100644 --- a/docs/sdk/android/v6/privacy/video.mdx +++ b/docs/sdk/android/v6/privacy/video.mdx @@ -310,10 +310,10 @@ Note, that secure rectangle coordinates remain the same after screen orientation ## Going dark -In some rare cases you might want to conceal the whole screen and stop recording events completely. The following APIs will come in handy, no data is being gathered +In some rare cases you might want to conceal the whole screen and stop recording events completely. between the calls to pause and resume. -The following APIs will come in handy, no video or touch events are being gathered between the calls to ```pause()``` and ```resume()``` below: +The following APIs will come in handy — no video or touch events are gathered between the calls to `pause()` and `resume()` below: diff --git a/docs/sdk/cordova/configuration.mdx b/docs/sdk/cordova/configuration.mdx index f3ad925..e910c2f 100644 --- a/docs/sdk/cordova/configuration.mdx +++ b/docs/sdk/cordova/configuration.mdx @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'; ## Launching with options :::warning -iOS/iPadOS: Since v7.0.0 the underlying Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, launch your app with Bugsee on a real device. +iOS/iPadOS: Since v6.0.0 the underlying Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, launch your app with Bugsee on a real device. ::: Bugsee behavior is very customizable. If the default configuration does not satisfy your needs, you can launch the SDK with additional parameters. Use an instance of ```IOSLaunchOptions``` or ```AndroidLaunchOptions``` for the corresponding platform to change Bugsee behavior. @@ -51,10 +51,10 @@ Bugsee.launch("", bugseeOptions); |Key|Default|Notes |---|---|---| -|captureDeviceAndNetworkNames|true|Capture device name, wifi SSID and mobile carrier name.| +|captureDeviceAndNetworkNames|false|Capture device name, wifi SSID and mobile carrier name.| |captureLogs|true|Automatically capture all console logs| |crashReport|true|Catch and report application crashes (\*)| -|defaultBugPriority|Low|Default priority for bugs| +|defaultBugPriority|High|Default priority for bugs| |defaultCrashPriority|Blocker|Default priority for crashes| |killDetection|false|Detect abnormal termination (experimental, [read more](/sdk/ios/app-kills/))| |maxRecordingTime|60|Maximum recording duration| @@ -81,7 +81,7 @@ Bugsee.launch("", bugseeOptions); |captureDeviceAndNetworkNames|true|Capture device name, wifi SSID and mobile carrier name.| |captureLogs|true|Automatically capture all console logs| |crashReport|true|Catch and report application crashes| -|defaultBugPriority|Low|Default priority for bugs| +|defaultBugPriority|High|Default priority for bugs| |defaultCrashPriority|Blocker|Default priority for crashes| |extendedVideoMode|true|Enables or disables the use of MediaProjection API (\*\*)| |frameRate|High|Specifies how often frames are captured| diff --git a/docs/sdk/cordova/installation.md b/docs/sdk/cordova/installation.md index 7636a7d..8da6eae 100644 --- a/docs/sdk/cordova/installation.md +++ b/docs/sdk/cordova/installation.md @@ -32,7 +32,7 @@ cordova plugin add cordova-plugin-device --save ## Initialization :::warning -iOS/iPadOS: Since v7.0.0 the underlying Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, launch your app with Bugsee on a real device. +iOS/iPadOS: Since v6.0.0 the underlying Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, launch your app with Bugsee on a real device. ::: Initialize the Bugsee plugin when your application starts, preferably when the *deviceready* event fires, e.g.: diff --git a/docs/sdk/cordova/logs.md b/docs/sdk/cordova/logs.md index bfc663f..ba300d0 100644 --- a/docs/sdk/cordova/logs.md +++ b/docs/sdk/cordova/logs.md @@ -8,7 +8,7 @@ slug: "/sdk/cordova/logs" You can use the Bugsee logging interface directly, we provide two API functions to send a message to a log: ```javascript -// With default log level (normal) +// With default log level (info) Bugsee.log("Some log message"); // Set the log level explicitly diff --git a/docs/sdk/cordova/manual.md b/docs/sdk/cordova/manual.md index 9ce72f9..77870ea 100644 --- a/docs/sdk/cordova/manual.md +++ b/docs/sdk/cordova/manual.md @@ -25,7 +25,7 @@ Bugsee.showReportDialog("Problem summary", "Further description", Bugsee.Severit User doesn't have to be involved, you can also generate and upload a report automatically from your code. ```javascript -// Bugsee.assert(summary, description, severity) +// Bugsee.upload(summary, description, severity) Bugsee.upload("Problem summary", "Further description", Bugsee.Severity.Blocker); ``` ## Non-fatal exceptions diff --git a/docs/sdk/dotnet/configuration.mdx b/docs/sdk/dotnet/configuration.mdx index 5c409f2..461cbee 100644 --- a/docs/sdk/dotnet/configuration.mdx +++ b/docs/sdk/dotnet/configuration.mdx @@ -96,14 +96,14 @@ namespace YourNameSpace |DefaultBugPriority|High|Default priority for bugs| |DefaultCrashPriority|Blocker|Default priority for crashes| |DetectAppExit|false|Detect any kind of process termination \(e.g. when user swipes off the application from multitasking UI, or when system unloads the app due to memory pressure\). Special error report is generated for this scenario with "BugseeAppExit" domain| -|FrameRate|High|Specifies how often frames are captured| +|FrameRate|BugseeFrameRate.High|Specifies how often frames are captured| |KillDetection|false|Detect abnormal termination (experimental, [read more](/sdk/ios/app-kills/))| |MaxDataSize|50|Bugsee will avoid using more disk space than specified (in MB). If total Bugsee data size exceeds specified value, oldest recordings (even not sent) will be removed. Value should not be smaller than 10| |MaxNetworkBodySize|5120|The limit above which network requests bodies will not be captured. Specified in bytes.| |MaxRecordingTime|60|Maximum recording duration| |MonitorNetwork|true|Capture network traffic| |MonitorBluetoothStatus|false|Monitor bluetooth state.
_**IMPORTANT**: You must add "Privacy - Bluetooth Always Usage Description" key into your Info.plist with a string value explaining to the user why you need bluetooth permission_| -|MonitorDiskSpace|false|| +|MonitorDiskSpace|false|Monitor available disk space and include it in reports as a system trace.| |ReportDescriptionRequired|false|Controls whether _"Description"_ field in bug reporting UI is mandatory or not.| |ReportEmailRequired|false|Controls whether _"Email"_ field in bug reporting UI is mandatory or not| |ReportPrioritySelector|false|Allow user to modify priority when reporting manually| @@ -125,7 +125,7 @@ namespace YourNameSpace |Key|Default|Notes |---|---|---| -|CaptureDeviceAndNetworkNames|false|Capture device name, wifi SSID and mobile carrier name.| +|CaptureDeviceAndNetworkNames|true|Capture device name, wifi SSID and mobile carrier name.| |CaptureLogs|true|Automatically capture all console logs| |CrashReport|true|Catch and report application crashes| |DefaultBugPriority|High|Default priority for bugs| @@ -133,7 +133,6 @@ namespace YourNameSpace |DetectAppExit|false|Detect any kind of process termination \(e.g. when user swipes off the application from multitasking UI, or when system unloads the app due to memory pressure\). Special error report is generated for this scenario with "BugseeAppExit" domain| |FrameRate|BugseeFrameRate.High|Specifies how often frames are captured| |ExtendedVideoMode|false|Enables or disables the use of MediaProjection API (\*\*)| -|FrameRate|High|Specifies how often frames are captured| |LogLevel|Verbose|Minimal log level of Logcat messages, which will be attached to report| |MaxDataSize|50|Maximum disk space consumed by Bugsee| |MaxNetworkBodySize|5120|The limit above which network requests bodies will not be captured. Specified in bytes.| diff --git a/docs/sdk/dotnet/custom.md b/docs/sdk/dotnet/custom.md index 1138c95..f5fe251 100644 --- a/docs/sdk/dotnet/custom.md +++ b/docs/sdk/dotnet/custom.md @@ -85,7 +85,7 @@ BugseePlugin.Bugsee.Event("event with params", parameters); ## File Attachments Binary files (attachments) can also be added to the report right before it is sent. The attachment will be available for download directly from the issue viewer. -Currently both the amount of attachments and their size are limited. Max of 3 attachments, 1M each. +Currently both the amount of attachments and their size are limited. Max of 3 attachments, 3MB each (size increased from 1MB starting from v3.2.0). You should provide an implementation for the **BugseeAttachmentsHandler** delegate and set it via the SetAttachmentsHandler() method. diff --git a/docs/sdk/dotnet/installation.mdx b/docs/sdk/dotnet/installation.mdx index 85ca6b9..c988395 100644 --- a/docs/sdk/dotnet/installation.mdx +++ b/docs/sdk/dotnet/installation.mdx @@ -158,7 +158,7 @@ namespace YourNameSpace { var options = new AndroidLaunchOptions(); // Set any desired options - options.monitorNetwork = true; + options.MonitorNetwork = true; // Platform below is from Microsoft.Maui.ApplicationModel namespace Bugsee.Launch(() => Platform.CurrentActivity, "", options); diff --git a/docs/sdk/dotnet/logs.md b/docs/sdk/dotnet/logs.md index aaec043..f563421 100644 --- a/docs/sdk/dotnet/logs.md +++ b/docs/sdk/dotnet/logs.md @@ -16,7 +16,7 @@ in Bugsee report viewer. You can use the Bugsee logging interface directly, we provide two API functions for sending a message to a log: ```csharp -// With default log level (normal) +// With default log level (info) BugseePlugin.Bugsee.Log("Some log message"); // Set the log level explicitly diff --git a/docs/sdk/dotnet/symbolication.mdx b/docs/sdk/dotnet/symbolication.mdx index 4e8a804..3cdf194 100644 --- a/docs/sdk/dotnet/symbolication.mdx +++ b/docs/sdk/dotnet/symbolication.mdx @@ -14,7 +14,7 @@ Bugsee can automatically upload managed (PDB/MDB) and platform native (like, dSY ## Configuring -Before adding changes to trigger symbols collection and uploading, make sure your projects are configured to produce those symbols, as it's quite common practice to disable debug information completely for `Release` builds. Go to `Project options` -> `Compiler` and make sure `Debug information` option is set to either **Portable**, **Symbols only** or **Full**. As was noted above, we operate over managed and native symbols, which are generated alongside each other. The former contain debug information for managed code (which you write in one of IL-based languages, like C#) while the latter contain information that lets us symbolicate crashes in native code (like, Objective-C in case of iOS-targeted build). +Before adding changes to trigger symbols collection and uploading, make sure your projects are configured to produce those symbols, as it's quite common practice to disable debug information completely for `Release` builds. Make sure the project's `DebugType` is set to either **portable**, **embedded** or **full** — in Visual Studio via project properties, or directly in the `.csproj` with `portable`. As was noted above, we operate over managed and native symbols, which are generated alongside each other. The former contain debug information for managed code (which you write in one of IL-based languages, like C#) while the latter contain information that lets us symbolicate crashes in native code (like, Objective-C in case of iOS-targeted build). ## Auto upload diff --git a/docs/sdk/flutter/configuration.md b/docs/sdk/flutter/configuration.md index 4aa3d20..8a8b5c3 100644 --- a/docs/sdk/flutter/configuration.md +++ b/docs/sdk/flutter/configuration.md @@ -8,7 +8,7 @@ slug: "/sdk/flutter/configuration" ## Launching with options :::warning -iOS/iPadOS: Since v9.0.0 the underlying Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, launch your app with Bugsee on a real device. +iOS/iPadOS: Since v6.0.0 the underlying Bugsee iOS SDK supports the simulator; crash capture is excluded. For full functionality, launch your app with Bugsee on a real device. ::: Bugsee behavior is very customizable, if default configuration is not satisfying your needs you can launch the SDK with additional parameters. Use instance of ```IOSLaunchOptions``` or ```AndroidLaunchOptions``` for corresponding platform to change Bugsee behavior. @@ -107,4 +107,4 @@ Future main() async { |videoEnabled|true|Enable video recording| |videoScale|1.0|Custom video scale| |wifiOnlyUpload|false|Upload reports only when a device is connected to a WiFi network| -|captureDeviceAndNetworkNames|false|Capture device name, wifi SSID and mobile carrier name.| +|captureDeviceAndNetworkNames|true|Capture device name, wifi SSID and mobile carrier name.| diff --git a/docs/sdk/flutter/logs.md b/docs/sdk/flutter/logs.md index 854632b..44717a2 100644 --- a/docs/sdk/flutter/logs.md +++ b/docs/sdk/flutter/logs.md @@ -15,7 +15,7 @@ in Bugsee report viewer. You can use the Bugsee logging interface directly, we provide two API functions for sending a message to a log: ```dart -// With default log level (normal) +// With default log level (info) Bugsee.log("Some log message"); // Set the log level explicitly diff --git a/docs/sdk/flutter/release-notes.md b/docs/sdk/flutter/release-notes.md index 6371960..2dfd6fa 100644 --- a/docs/sdk/flutter/release-notes.md +++ b/docs/sdk/flutter/release-notes.md @@ -24,7 +24,7 @@ slug: "/sdk/flutter/release-notes" - Feat: Updated native SDKs to their latest versions (Android: [5.9.1](/sdk/android/v6/release-notes/#591-september-29-2025), iOS: [5.5.8](/sdk/ios/release-notes/#558-august-21-2025)) ## 8.6.7 (September 23 2025) -- Feat: Updated native SDKs to their latest versions (Android: [5.8.7](/sdk/android/v6/release-notes/#587-september-9-2025), iOS: [5.5.8](/sdk/ios/release-notes/#557-august-1-2025)) +- Feat: Updated native SDKs to their latest versions (Android: [5.8.7](/sdk/android/v6/release-notes/#587-september-9-2025), iOS: [5.5.8](/sdk/ios/release-notes/#558-august-21-2025)) ## 8.6.6 (August 21 2025) - Feat: Updated native SDKs to their latest versions (Android: [5.8.4](/sdk/android/v6/release-notes/#584-august-21-2025), iOS: [5.5.8](/sdk/ios/release-notes/#558-august-21-2025)) diff --git a/docs/sdk/ios/configuration.mdx b/docs/sdk/ios/configuration.mdx index 5ef1be4..ad82af0 100644 --- a/docs/sdk/ios/configuration.mdx +++ b/docs/sdk/ios/configuration.mdx @@ -118,7 +118,7 @@ Bugsee.relaunch(options: options) |BugseeKillDetectionKey|NO|Detect abnormal termination ([read more](/sdk/ios/app-kills/))| |BugseeDetectAppExitKey|NO|Detect any kind of process termination \(e.g. when user swipes off the application from multitasking UI, or when system unloads the app due to memory pressure\). Special error report is generated for this scenario with "BugseeAppExit" domain| |BugseeVideoEnabledKey|YES|Enable video recording| -|BugseeScreenshotEnabledKey|YES|Attach screenshot to a report. Note, that if ```BugseeVideoEnabledKey``` option is *NO*, default value of this option is *NO* too.| +|BugseeScreenshotEnabledKey|YES|Attach screenshot to a report. Note, that if `BugseeVideoEnabledKey` option is *NO*, default value of this option is *NO* too.| |BugseeViewHierarchyEnabledKey|YES|Capture view hierarchy for Bug and Error reports| |BugseeCaptureLogsKey|YES|Automatically capture all console logs| |BugseeCaptureOSLogsKey|NO|Automatically capture OSLog and Logger print statements.
_**IMPORTANT**: Experimental feature_| @@ -137,7 +137,7 @@ Bugsee.relaunch(options: options) |BugseeStyleKey|Default|Enumeration of BugseeStyleSystemDefault, BugseeStyleDefault, BugseeStyleDark and BugseeStyleBasedOnStatusBarStyle| |BugseeFrameRateKey|BugseeFrameRateHigh|Specifies how often frames are attempted to be captured| |BugseeVideoScaleKey|@1|Additional down scaling applied to recorded video, (e.x @0.5 would reduce both width and height by half)| -|BugseeCaptureDeviceAndNetworkNamesKey\*\*|NO|Capture device name, wifi SSID and mobile carrier name.| +|BugseeCaptureDeviceAndNetworkNames\*\*|NO|Capture device name, wifi SSID and mobile carrier name.| |BugseeReportSummaryRequiredKey|NO|Controls whether _"Summary"_ field in bug reporting UI is mandatory or not.| |BugseeReportDescriptionRequiredKey|NO|Controls whether _"Description"_ field in bug reporting UI is mandatory or not.| |BugseeReportEmailRequiredKey|NO|Controls whether _"Email"_ field in bug reporting UI is mandatory or not.| diff --git a/docs/sdk/ios/custom.mdx b/docs/sdk/ios/custom.mdx index c082246..fc200b0 100644 --- a/docs/sdk/ios/custom.mdx +++ b/docs/sdk/ios/custom.mdx @@ -219,7 +219,8 @@ public class BugseeCustomDelegate: NSObject, BugseeDelegate { fileURL = URL(fileURLWithPath: pathToMyFile) } - if let att = BugseeAttachment(name:"internal app db", filename:"custom.db", data:Data(contentsOf: fileURL)) { + if let data = try? Data(contentsOf: fileURL), + let att = BugseeAttachment(name: "internal app db", filename: "custom.db", data: data) { // Return array with one attachment return [att] } diff --git a/docs/sdk/ios/faq.md b/docs/sdk/ios/faq.md index db47ca9..464bf77 100644 --- a/docs/sdk/ios/faq.md +++ b/docs/sdk/ios/faq.md @@ -20,7 +20,7 @@ The precise amount of RAM used by Bugsee depends on the device specifications an |Without Bugsee|44| |With Bugsee enabled|60| -These values were produced by testing Bugsee SDK in a sample application on iPhone Xs. The "Without Bugsee" row shows the baseline RAM usage of the app. +These values were produced by testing Bugsee SDK in a sample application on iPhone XS. The "Without Bugsee" row shows the baseline RAM usage of the app.
diff --git a/docs/sdk/ios/logs.mdx b/docs/sdk/ios/logs.mdx index 5a811b3..2e8fb95 100644 --- a/docs/sdk/ios/logs.mdx +++ b/docs/sdk/ios/logs.mdx @@ -58,7 +58,7 @@ You can use the Bugsee logging interface directly, we provide two API functions ```objectivec -// With default log level (normal) +// With default log level (info) [Bugsee log:@"Some log message"]; // Set the log level explicitly @@ -71,7 +71,7 @@ You can use the Bugsee logging interface directly, we provide two API functions ```swift -// With default log level (normal) +// With default log level (info) Bugsee.log("Some log message") // Set the log level explicitly diff --git a/docs/sdk/ios/manual.mdx b/docs/sdk/ios/manual.mdx index 148c4c7..7de986b 100644 --- a/docs/sdk/ios/manual.mdx +++ b/docs/sdk/ios/manual.mdx @@ -22,8 +22,8 @@ In addition to detection of a shake gesture or screenshot issue report view can // or pre-fill some fields, user will be able to modify them [Bugsee showReportControllerWithSummary:@"Some problem" description:@"" - severity:BugseeSeverityMedium, - labels: @[@"some-label"]]; + severity:BugseeSeverityMedium + labels:@[@"some-label"]]; ``` @@ -115,7 +115,7 @@ You can also use the BugseeExtendedReport to fill it with information and upload // Note: Do not trigger upload while video export is being performed! // // Available since Bugsee iOS SDK v5.4.0 - [extendedReport exportVideoToPath:@"full/video/path.mov" withCompletion:^{ + [report exportVideoToPath:@"full/video/path.mov" withCompletion:^{ // Video export completed. Check the file presence. If // export failed, the file will not be created. }]; @@ -155,7 +155,7 @@ Bugsee.createReport { report in report.setSummary("UI is broken.") report.setDescription("It happened when I pressed the button") - report.labels = ["test"] + report.labels = ["test", "qa"] let image = report.screenshot @@ -251,7 +251,9 @@ BUGSEE_ASSERT(balance > 0, @"Balance is wrong") ```swift // Unfortunately, there is no preprocessor in Swift, so you have to construct location string yourself -if balance < 0 Bugsee.logAssert(description: "Balance is wrong", location:"\(#function) (\(#file):\(#line))") +if balance < 0 { + Bugsee.logAssert(description: "Balance is wrong", location: "\(#function) (\(#file):\(#line))") +} ``` diff --git a/docs/sdk/ios/privacy/logs.mdx b/docs/sdk/ios/privacy/logs.mdx index 8baaed8..722ba32 100644 --- a/docs/sdk/ios/privacy/logs.mdx +++ b/docs/sdk/ios/privacy/logs.mdx @@ -26,14 +26,15 @@ Your class should implement the **BugseeDelegate** protocol and it must set itse ```objectivec -(void)bugseeFilterLog:(BugseeLogEvent *)log completionHandler:(BugseeLogFilterDecisionBlock)decisionBlock { - // Below is an example code that will remove access_token from all URLs going through the filter. + // Below is an example that replaces the access_token value in all URLs + // going through the filter with a fixed placeholder. NSError * error; NSRegularExpression * regex = [NSRegularExpression regularExpressionWithPattern:@"access_token=[0-9a-z\\-]*" options:NSRegularExpressionCaseInsensitive error:&error]; log.text = [regex stringByReplacingMatchesInString:log.text options:0 range:NSMakeRange(0, log.text.length) - withTemplate:@"TokenWasFound here"]; + withTemplate:@"access_token="]; decisionBlock(log); } @@ -48,10 +49,10 @@ Your class should implement the **BugseeDelegate** protocol and it must set itse private func bugseeFilterLog(log: BugseeLogEvent, completionHandler decisionBlock: @escaping BugseeLogFilterDecisionBlock) { let regex : NSRegularExpression do { - regex = try NSRegularExpression.init(pattern: "&access_token=[0-9a-z\\-]*", + regex = try NSRegularExpression.init(pattern: "access_token=[0-9a-z\\-]*", options: NSRegularExpression.Options.caseInsensitive) let range = NSMakeRange(0 , log.text.count) - log.text = regex.stringByReplacingMatches(in: log.text, options: .reportProgress, range: range, withTemplate: "") + log.text = regex.stringByReplacingMatches(in: log.text, options: .reportProgress, range: range, withTemplate: "access_token=") }catch { print("Somethings went wrong!") } decisionBlock(log); diff --git a/docs/sdk/ios/privacy/video.mdx b/docs/sdk/ios/privacy/video.mdx index 718d8f2..e74246f 100644 --- a/docs/sdk/ios/privacy/video.mdx +++ b/docs/sdk/ios/privacy/video.mdx @@ -33,7 +33,7 @@ self.myView.bugseeProtectedView = YES; ```swift -self.myView.bugseeProtectedView = YES +self.myView.bugseeProtectedView = true ``` diff --git a/docs/sdk/ios/symbolication.mdx b/docs/sdk/ios/symbolication.mdx index 636b341..07c643e 100644 --- a/docs/sdk/ios/symbolication.mdx +++ b/docs/sdk/ios/symbolication.mdx @@ -142,6 +142,8 @@ All variables read by `BugseeAgent`'s build-publish flow. Empty-string values (e | --- | --- | --- | --- | | `BUGSEE_BUILD_INFO_ENABLED` | **ON** | bool | Master switch for the entire build-publish flow. Disable to opt out (firewalled CI, privacy-sensitive builds). | | `BUGSEE_BUILD_INFO_ALL_CONFIGURATIONS` | OFF | bool | Register every `$CONFIGURATION`, not just `release*`. | +| `BUGSEE_BUILD_INFO_TIMINGS_ENABLED` | **ON** | bool | Per-section build timings read from the `.xcactivitylog`. Disable so no target or section names leave the machine. | +| `BUGSEE_DEPENDENCIES_ENABLED` | **ON** | bool | Resolved CocoaPods / SPM / Carthage dependency graph. Also the gate for the OSV vulnerability scan. | | `BUGSEE_BUILD_INFO_ALL_ACTIONS` | OFF | bool | Register Build actions too, not just Archive. The agent then locates the `.app` at `$TARGET_BUILD_DIR/$WRAPPER_NAME`. If `$TARGET_BUILD_DIR` is also missing, the agent skips with a diagnostic line. | | `BUGSEE_SIZE_ANALYSIS_ENABLED` | OFF | bool | Also upload the IPA bytes for server-side tree analysis. Requires `BUGSEE_BUILD_INFO_ENABLED=1`. | | `BUGSEE_CHUNKED_UPLOAD` | OFF | bool | Use the deduplicated chunked-upload protocol for the IPA. The artefact is split into 8 MiB SHA-1 chunks and only the chunks that changed since the prior build are re-uploaded — typically cuts upload time by 70–90% on incremental CI. Only meaningful with `BUGSEE_SIZE_ANALYSIS_ENABLED=1` (build-info-only has nothing to chunk). Any failure falls back to the single-PUT path so flaky links can't break CI. | diff --git a/docs/sdk/kmp/installation.md b/docs/sdk/kmp/installation.md index 6221ffd..eb2b78d 100644 --- a/docs/sdk/kmp/installation.md +++ b/docs/sdk/kmp/installation.md @@ -33,7 +33,7 @@ kotlin { sourceSets { commonMain.dependencies { - implementation("com.bugsee:bugsee-kotlin-multiplatform:+") + implementation("com.bugsee:bugsee-kotlin-multiplatform:0.1.1") } } } diff --git a/docs/sdk/kmp/privacy/video.md b/docs/sdk/kmp/privacy/video.md index 0d80dd5..46c1357 100644 --- a/docs/sdk/kmp/privacy/video.md +++ b/docs/sdk/kmp/privacy/video.md @@ -13,12 +13,12 @@ Video recording can be disabled completely using the **videoEnabled** launch opt Bugsee automatically detects and hides secure input fields (e.g. password fields) from the recorded video. However, due to the declarative nature of Compose UI, automatic detection may not cover all cases. We recommend using the `BugseeProtect` composable to explicitly wrap any sensitive content. It places a secure overlay that hides the protected area from Bugsee video recordings and screenshots on both Android and iOS. -Add the `library-protect` dependency to your shared module: +Add the `bugsee-kotlin-multiplatform-protect` dependency to your shared module: ```kotlin commonMain.dependencies { - implementation("com.bugsee:bugsee-kotlin-multiplatform:+") - implementation("com.bugsee:bugsee-kotlin-multiplatform-protect:+") + implementation("com.bugsee:bugsee-kotlin-multiplatform:0.1.1") + implementation("com.bugsee:bugsee-kotlin-multiplatform-protect:0.1.1") } ``` diff --git a/docs/sdk/react_native/configuration.mdx b/docs/sdk/react_native/configuration.mdx index dd73316..e9b8b58 100644 --- a/docs/sdk/react_native/configuration.mdx +++ b/docs/sdk/react_native/configuration.mdx @@ -77,7 +77,7 @@ Note that when you launch Bugsee, it starts working in background with the speci |captureDeviceAndNetworkNames|false|Capture device name, wifi SSID and mobile carrier name.| |captureLogs|true|Automatically capture all console logs| |crashReport|true|Catch and report application crashes (\*)| -|defaultBugPriority|Low|Default priority for bugs| +|defaultBugPriority|High|Default priority for bugs| |defaultCrashPriority|Blocker|Default priority for crashes| |killDetection|false|Detect abnormal termination (experimental, [read more](/sdk/ios/app-kills/))| |maxRecordingTime|60|Maximum recording duration| @@ -101,10 +101,10 @@ Note that when you launch Bugsee, it starts working in background with the speci |Key|Default|Notes |---|---|---| -|captureDeviceAndNetworkNames|false|Capture device name, wifi SSID and mobile carrier name.| +|captureDeviceAndNetworkNames|true|Capture device name, wifi SSID and mobile carrier name.| |captureLogs|true|Automatically capture all console logs| |crashReport|true|Catch and report application crashes| -|defaultBugPriority|Low|Default priority for bugs| +|defaultBugPriority|High|Default priority for bugs| |defaultCrashPriority|Blocker|Default priority for crashes| |frameRate|High|Specifies how often frames are captured| |handleAnr|false|Detect ANR (Application Not Responding) and transform it to a meaningful exception| @@ -122,10 +122,6 @@ Note that when you launch Bugsee, it starts working in background with the speci |videoMode|VideoMode.V3|Specifies video recording mode. Available options are: VideoMode.V1, VideoMode.V2, VideoMode.V3| |wifiOnlyUpload|false|Upload reports only when a device is connected to a WiFi network| -:::warning -** If extendedVideoMode is set to true, MediaProjection API is used, while recording video. In this case all types of views are recorded, but user is asked to allow video recording. If false (experimental), view drawing cache is used to capture the screen. In this case user is not asked to allow video recording, but frame rate is lower and some special views like status bar, soft keyboard and views, which contain Surface (MapView, VideoView, GlSurfaceView, etc.) are not recorded. Option has no effect, if VideoEnabled option is set to false. -::: - ## Stop, Relaunch It is also possible to relaunch Bugsee with other options later diff --git a/docs/sdk/react_native/logs.md b/docs/sdk/react_native/logs.md index 64822be..cb7e48a 100644 --- a/docs/sdk/react_native/logs.md +++ b/docs/sdk/react_native/logs.md @@ -26,7 +26,7 @@ RCTAddLogFunction((RCTLogFunction)BugseeReactNativeLogger); You can use the Bugsee logging interface directly from within Javascript bypassing the React logging system, we provide two API functions for sending a message to a log: ```javascript -// With default log level (normal) +// With default log level (info) Bugsee.log("Some log message"); // Set the log level explicitly diff --git a/docs/sdk/unity/appearance.md b/docs/sdk/unity/appearance.md index 8114625..6bb7acd 100644 --- a/docs/sdk/unity/appearance.md +++ b/docs/sdk/unity/appearance.md @@ -31,7 +31,6 @@ Bugsee.Appearance.Feedback.BackgroundColor = BugseeColor.Blue; | SendButtonColor | Send UIButton text color | | TextColor | UILabels text color | | VersionColor | UILabel with version number text color | -| --- | --- | | SummaryPlaceholder | Placeholder which is displayed in Summary field in built-in bug reporting UI | | DescriptionPlaceholder | Placeholder which is displayed in Description field in built-in bug reporting UI | | EmailPlaceholder | Placeholder which is displayed in Email field in built-in bug reporting UI | @@ -71,7 +70,6 @@ Bugsee.Appearance.Feedback.BackgroundColor = BugseeColor.Blue; | SeverityLabelActiveColor | Issue severity label text color in active state in Report UI | | TextColor | TextViews and EditTexts text color in Report UI | | VersionColor | Bugsee version number view text color in Report UI | -| --- | --- | | SummaryPlaceholder | Placeholder which is displayed in Summary field in built-in bug reporting UI | | DescriptionPlaceholder | Placeholder which is displayed in Description field in built-in bug reporting UI | | EmailPlaceholder | Placeholder which is displayed in Email field in built-in bug reporting UI | diff --git a/docs/sdk/unity/configuration.md b/docs/sdk/unity/configuration.md index 712ebd9..9edc258 100644 --- a/docs/sdk/unity/configuration.md +++ b/docs/sdk/unity/configuration.md @@ -67,7 +67,7 @@ Bugsee.Relaunch(options); |---|---|---| |CaptureLogs|true|Automatically capture all console logs| |CrashReport|true|Catch and report application crashes (\*)| -|DefaultBugPriority|Low|Default priority for bugs| +|DefaultBugPriority|High|Default priority for bugs| |DefaultCrashPriority|Blocker|Default priority for crashes| |KillDetection|false|Detect abnormal termination (experimental, [read more](/sdk/ios/app-kills/))| |MaxRecordingTime|60|Maximum recording duration| @@ -82,12 +82,12 @@ Bugsee.Relaunch(options); |WifiOnlyUpload|false|Upload reports only when a device is connected to a WiFi network| |MaxDataSize|50|Bugsee will avoid using more disk space than specified (in MB). If total Bugsee data size exceeds specified value, oldest recordings (even not sent) will be removed. Value should not be smaller than 10| |VideoScale|1.0|Additional down scaling applied to recorded video, (e.g., 0.5 would reduce both width and height by half).| -|CaptureDeviceAndNetworkNames|true|Capture device name, wifi SSID and mobile carrier name.| +|CaptureDeviceAndNetworkNames|false|Capture device name, wifi SSID and mobile carrier name.| |DetectAppExit|false|Detect any kind of process termination (e.g. when user swipes off the application from multitasking UI, or when system unloads the app due to memory pressure). Special error report is generated for this scenario with "BugseeAppExit" domain| |ViewHierarchyEnabled|false|Capture view hierarchy for Bug and Error reports| |CaptureOSLogs|false|Automatically capture OSLog and Logger print statements| |MonitorBluetoothStatus|false|Monitor bluetooth state.
IMPORTANT: You must add "Privacy - Bluetooth Always Usage Description" key into your Info.plist with a string value explaining to the user why you need bluetooth permission| -|MonitorDiskSpace|false|| +|MonitorDiskSpace|false|Monitor available disk space and include it in reports as a system trace.| |AppLaunchCrashDetection|false|Controls whether early crashes are intercepted and uploaded. Early crashes are those happening within the first 5 seconds after app launch. And they are uploaded synchronously (with blocking main thread) to guarantee upload| |CaptureAVPlayer|false|When enabled, video playing via AVPlayerLayer and via AVPlayerViewController will be captured on video| diff --git a/docs/sdk/unity/custom.md b/docs/sdk/unity/custom.md index 135d63f..60a6b0d 100644 --- a/docs/sdk/unity/custom.md +++ b/docs/sdk/unity/custom.md @@ -77,7 +77,7 @@ BugseePlugin.Bugsee.Event("event with params", parameters); ## File Attachments :::warning -"bgs_gameObject" GameObject is required to perform communication between managed code and our platform SDK. Please, do not remove or rename "bgs_gameObject". +"bgs_gameObject" GameObject is required to perform communication between managed code and our platform SDK. Please do not remove or rename "bgs_gameObject". ::: Binary files (attachments) can also be added to the report right before it is sent. The attachment will be available for download directly from the issue viewer. diff --git a/docs/sdk/unity/installation.md b/docs/sdk/unity/installation.md index dcc8947..afc6978 100644 --- a/docs/sdk/unity/installation.md +++ b/docs/sdk/unity/installation.md @@ -50,7 +50,7 @@ In cases when you want to launch Bugsee from code (e.g. upon some event or user Under the hood, Bugsee launcher adds an object to the scene named "bgs_gameObject". it is required to perform communication between managed code (.NET) and native backend (our platform SDK). When you call ```Bugsee.Launch()``` yourself, there will be no such special object added to the scene, hence you should do that yourself. :::warning -"bgs_gameObject" GameObject is required to perform communication between managed code and our platform SDK. Please, do not remove or rename "bgs_gameObject". +"bgs_gameObject" GameObject is required to perform communication between managed code and our platform SDK. Please do not remove or rename "bgs_gameObject". ::: You can use an existing object for that, but we strongly encourage you to create a dedicated object to prevent any possible conflicts. diff --git a/docs/sdk/unity/lifecycle.md b/docs/sdk/unity/lifecycle.md index a9e5c56..7783304 100644 --- a/docs/sdk/unity/lifecycle.md +++ b/docs/sdk/unity/lifecycle.md @@ -10,7 +10,7 @@ Bugsee SDK silently works within your app, recording everything to assist you in ## Implementing callback :::warning -"bgs_gameObject" GameObject is required to perform communication between managed code and our platform SDK. Please, do not remove or rename "bgs_gameObject". +"bgs_gameObject" GameObject is required to perform communication between managed code and our platform SDK. Please do not remove or rename "bgs_gameObject". ::: You should subscribe to **Bugsee.OnLifecycleEvent** event and handle incoming lifecycle changes in the attached handler: diff --git a/docs/sdk/unity/logs.md b/docs/sdk/unity/logs.md index 0874878..58225c1 100644 --- a/docs/sdk/unity/logs.md +++ b/docs/sdk/unity/logs.md @@ -9,7 +9,7 @@ Nothing needs to be done on your part if all you need is to retrieve standard lo ```csharp -// With default log level (normal) +// With default log level (info) BugseePlugin.Bugsee.Log("Some log message"); // Set the log level explicitly diff --git a/docs/sdk/unity/release-notes.md b/docs/sdk/unity/release-notes.md index 63f7ded..cbc9c13 100644 --- a/docs/sdk/unity/release-notes.md +++ b/docs/sdk/unity/release-notes.md @@ -50,7 +50,7 @@ slug: "/sdk/unity/release-notes" - Feat: \[Android\] 16KB memory pages support ## 5.2.0 (April 23 2024) -- Fix: \[Android\] In some cases, video before GF->BG->FG transitions may be absent +- Fix: \[Android\] In some cases, video before FG->BG->FG transitions may be absent - Note: \[Android\] compileSdkVersion 34 and up is now required ## 5.1.0 (April 11 2024) diff --git a/docs/sdk/xamarin/configuration.mdx b/docs/sdk/xamarin/configuration.mdx index 4d52113..200fd1a 100644 --- a/docs/sdk/xamarin/configuration.mdx +++ b/docs/sdk/xamarin/configuration.mdx @@ -99,7 +99,7 @@ namespace YourNameSpace |ScreenshotEnabled|true|Attach screenshot to a report| |WifiOnlyUpload|false|Upload reports only when a device is connected to a WiFi network| |MaxDataSize|50|Bugsee will avoid using more disk space than specified (in MB). If total Bugsee data size exceeds specified value, oldest recordings (even not sent) will be removed. Value should not be smaller than 10| -|CaptureDeviceAndNetworkNames|true|Capture device name, wifi SSID and mobile carrier name.| +|CaptureDeviceAndNetworkNames|false|Capture device name, wifi SSID and mobile carrier name.| :::warning * iOS allows only one crash detector to be active at a time, if you insist on using an alternative solution for handling crashes, you might want to use this option and disable Bugsee from taking over. diff --git a/docs/sdk/xamarin/logs.md b/docs/sdk/xamarin/logs.md index 5ddd66d..6aead30 100644 --- a/docs/sdk/xamarin/logs.md +++ b/docs/sdk/xamarin/logs.md @@ -20,7 +20,7 @@ in Bugsee report viewer. You can use the Bugsee logging interface directly, we provide two API functions for sending a message to a log: ```csharp -// With default log level (normal) +// With default log level (info) Bugsee.Log("Some log message"); // Set the log level explicitly diff --git a/docs/webhooks/configuration.md b/docs/webhooks/configuration.md index 9199a06..25fdb3e 100644 --- a/docs/webhooks/configuration.md +++ b/docs/webhooks/configuration.md @@ -11,7 +11,7 @@ Webhooks can be managed in special [Webhooks](https://app.bugsee.com/#/settings/ ![Add webhook](add_webhook_button.png) -That will bring up a new webhook wizard. One the first step fill in the remote URL to your server and optionally provide some description. +That will bring up a new webhook wizard. On the first step, fill in the remote URL to your server and optionally provide some description. ![Fill URL](wizard_step1.png) @@ -19,7 +19,7 @@ On the next step, check events you want to receive notifications about to the sp ![Select events](wizard_step2.png) -If you have selected any of _issue.\*_ events on the second step, you will be presented with the third one, where you can select applications you want these events to be triggered for (all unchecked applications will not triggering events). +If you have selected any of _issue.\*_ events on the second step, you will be presented with the third one, where you can select applications you want these events to be triggered for (all unchecked applications will not trigger events). ![Select applications](wizard_step3.png) diff --git a/docs/webhooks/events.md b/docs/webhooks/events.md index cd09b3c..c040f0a 100644 --- a/docs/webhooks/events.md +++ b/docs/webhooks/events.md @@ -32,7 +32,7 @@ Bugsee will send notifications for the following events: - [Environment](#environment) -All webhook payloads has common structure, like the one below: +All webhook payloads have a common structure, like the one below: ```json { @@ -534,7 +534,7 @@ This event is triggered when new issue is deleted. It has the following payload ### issue.comment -This event is triggered when someone add comment to issue. It has the following payload data structure: +This event is triggered when someone adds a comment to an issue. It has the following payload data structure: ```json {