Skip to content

Commit d04e429

Browse files
splatyourbugsgitbook-bot
authored andcommitted
GitBook: [#277] updating attachements
1 parent c13e2bf commit d04e429

File tree

15 files changed

+36
-30
lines changed

15 files changed

+36
-30
lines changed

β€Ž.gitbook/assets/log-viewer-bs.gif

5.13 MB
Loading

β€Žabout/who-is-bugsplat/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Who is BugSplat?
22

3-
### **Our Story **
3+
### **Our Story** 
44

55
BugSplat started in 2004 as an informal side project by David Plunkett and a couple of friends.
66

7-
Dave and the gang had built and maintained crash reporting tools at much larger software companies in their previous roles. This was an experience that led them to three big takeaways:
7+
Dave and the gang had built and maintained crash reporting tools at much larger software companies in their previous roles. This was an experience that led them to three big takeaways: 
88

99
1. Crash reporting was a nearly magical tool for finding and fixing crash defects. \
1010

@@ -43,13 +43,13 @@ Through it all we’ve maintained a laser focus on providing our users with the
4343

4444
Despite the industry changes we’re still 100% self-funded and have never accepted outside investment. That means we only answer to you, our customer. We're lean, profitable, growing, and supporting ourselves and our families through this business.
4545

46-
Today BugSplat helps developers track and fix over 500 million crashes on around 350 million computers, tablets, consoles, and phones every year.
46+
Today BugSplat helps developers track and fix over 500 million crashes on around 350 million computers, tablets, consoles, and phones every year. 
4747

4848
We know that we have an amazing gig with BugSplat. It’s a lot of work, sure, but we work every day on interesting problems with great partners. We’re a fully remote company that emphasizes flexibility, self-responsibility, and personal and professional exploration.
4949

5050
All of this is to say...
5151

52-
If you're a BugSplat user, thank you for making this happen. If you're not a user yet, please consider [signing up](https://app.bugsplat.com/v2/sign-up).
52+
If you're a BugSplat user, thank you for making this happen. If you're not a user yet, please consider [signing up](https://app.bugsplat.com/v2/sign-up).  
5353

5454
Cheers,
5555

β€Žadministration/billing/billing-and-plan-managment/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Billing and Plan Management
22

3-
This segment focuses on helping using to manage their current billing, update account settings around billing, and add or remove credit cards associated with BugSplat accounts.
3+
This segment focuses on helping using to manage their current billing, update account settings around billing, and add or remove credit cards associated with BugSplat accounts.  
44

5-
**Not finding what you're looking for? **
5+
**Not finding what you're looking for?** 
66

77
Try searching for it using the search bar at the top right of this screen. If you still can't find the answer you're looking for, please send us a note at [[email protected]](mailto:[email protected]). You can also drop by our [Discord Server](https://discord.gg/K4KjjRV5ve) and talk to us directly.
88

β€Žeducation/faq/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# FAQs
22

3-
### **Welcome to the BugSplat FAQs Documentation. **
3+
### **Welcome to the BugSplat FAQs Documentation.**  
44

5-
In this segment, users will find answers to commonly asked questions about the BugSplat app and crash reporting.
5+
In this segment, users will find answers to commonly asked questions about the BugSplat app and crash reporting.  
66

77
Use the left-hand menu to navigate to specific FAQs or search for your topic using the search feature at the top right-hand of the page.
88

9-
### **Not finding what you're looking for? **
9+
### **Not finding what you're looking for?** 
1010

1111
If you still can't find the answer you're looking for, please send us a note at [[email protected]](mailto:[email protected]). You can also drop by our [Discord Server](https://discord.bugsplat.com) and talk to us directly.
1212

β€Žeducation/faq/bugsplat-application-uptime-data/what-are-the-upload-size-considerations-with-bugsplat-accounts..md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
Crash reports uploaded to BugSplat are typically quite small. However, you can add additional data to each crash report, for example, many customers include log files. If you add additional data to crash reports, be aware that your BugSplat subscription has crash report size limitations. The size limitations apply to the total size of the compress (zipped) crash report.
44

5-
Crash uploads are limited to **20 MB **(compressed), this includes the size of the minidump file or other crash artifacts generated by BugSplat, which are typically less than **50k**.  
5+
Crash uploads are limited to **20 MB** (compressed), this includes the size of the minidump file or other crash artifacts generated by BugSplat, which are typically less than **50k**.  
66

77
BugSplat allows larger upload size limits for Enterprise level users.

β€Žeducation/how-tos/crash-grouping-concepts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ When you define a crash group, all new crashes will be processed according to it
3434
You can only define a single group-by-level for any top-level stack frame. When you define a group-by-level, any existing crash groups for the top-level stack frame are removed.
3535
{% endhint %}
3636

37-
Crash group-by-level is powerful and operates on all crashes related to the same top-level stack frame, but group-by-level is a blunt tool that doesn't work for every situation. What if some crashes don't have your interesting** **code at the selected level? If you want to do more surgical crash grouping, you need **group-similar.**
37+
Crash group-by-level is powerful and operates on all crashes related to the same top-level stack frame, but group-by-level is a blunt tool that doesn't work for every situation. What if some crashes don't have your interesting **** code at the selected level? If you want to do more surgical crash grouping, you need **group-similar.**
3838

3939
#### Group Similar Crashes 
4040

@@ -52,6 +52,6 @@ Let's return to our example above. We first created a group-by-level crash group
5252

5353
Any individual crash group can be deleted. This applies to groups created with group-similar and for any single group that was automatically created with group-by-level. You can also remove all crash groups for a single top-level stack frame.
5454

55-
**Grouping of Existing Crashes **
55+
**Grouping of Existing Crashes** 
5656

5757
When you define a crash group, you select a timeframe for regrouping existing crashes in your database. The grouping for crashes older than the selected timeframe will not be modified.  

β€Žintroduction/development/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This **Development** section includes articles that are useful for using BugSpla
1414

1515
****[**Commenting**](commenting.md) - is BugSplat's built-in comment tool and issue tracker.
1616

17-
[**3rd Party Tools**](integrating-with-tools/)** **- compliment your workflow by integrating BugSplat with your issue tracker, messaging app, or another tool.
17+
[**3rd Party Tools**](integrating-with-tools/) **** - compliment your workflow by integrating BugSplat with your issue tracker, messaging app, or another tool.
1818

1919
[**API**](web-services/) – is an overview of the BugSplat API.
2020

β€Žintroduction/development/using-the-app.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,16 @@ The Crash page includes valuable information like crash time, environment, corre
7272

7373
### Additional Information
7474

75-
All data covered to this point on the Crash page are found under the **Crash Overview** tab. To access additional information about crashes like **Other Threads**, **Registers**, **Modules**, **Debugger Output**, and **Attachments** β€” use the tabs found above the **User Details** module.
75+
All data covered to this point on the Crash page are found under the **Crash Overview** tab. To access additional information about crashes like **Other Threads**, **Registers**, **Modules**, **Debugger Output**, and **Attachments** β€” use the tabs found above the **User Details** module. 
7676

7777
![](<../../.gitbook/assets/viewing-tabs-crashreport (1) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (2) (1).gif>)
7878

79+
#### Previwing attached files&#x20;
80+
81+
To preview or download an attached file, simply navigate to the **Attachments** tab in a crash report and click on the right arrow next to the attachment name in order to load a preview of the attached text.
82+
83+
![](../../.gitbook/assets/log-viewer-bs.gif)
84+
7985
## Summary
8086

8187
The [Summary](https://app.bugsplat.com/v2/summary) page shows a view of an application's crash data which automatically groups crashes by the top line of the call stack, allowing users to see which defects are occurring most frequently.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Source Maps
22

3-
BugSplat has the ability to convert uglified and minified JavaScript stack traces into function names and line numbers from the original source. You can upload [source map](https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Use_a_source_map) files to BugSplat during your build process by leveraging [@bugsplat/symbol-upload](https://www.npmjs.com/package/@bugsplat/symbol-upload).
3+
BugSplat has the ability to convert uglified and minified JavaScript stack traces into function names and line numbers from the original source. You can upload [source map](https://developer.mozilla.org/en-US/docs/Tools/Debugger/How\_to/Use\_a\_source\_map) files to BugSplat during your build process by leveraging [@bugsplat/symbol-upload](https://www.npmjs.com/package/@bugsplat/symbol-upload).
44

5-
In order to correctly unwind uglified stack traces, you’ll need to ensure that the filename of the source map matches the file name of the original source file. For instance, if your build process generates a file `main.153ee63b.chunk.js`, the corresponding source map file should be named `main.153ee63b.chunk.js.map`.
5+
In order to correctly unwind uglified stack traces, you’ll need to ensure that the filename of the source map matches the file name of the original source file. For instance, if your build process generates a file `main.153ee63b.chunk.js`, the corresponding source map file should be named `main.153ee63b.chunk.js.map`.&#x20;
66

77
{% hint style="info" %}
88
Be sure to upload source maps for each released version of your application for best results.
99
{% endhint %}
1010

11-
If BugSplat is unable to convert the uglified stack trace back to the original source the **Debugger Output **tab will display diagnostic information from the BugSplat backend that will help you troubleshoot.
11+
If BugSplat is unable to convert the uglified stack trace back to the original source the **Debugger Output** tab will display diagnostic information from the BugSplat backend that will help you troubleshoot.

β€Žintroduction/getting-started/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ Once these steps are complete, users should learn more about using the BugSplat
2222
If at any point you get stuck and want some helpβ€”please reach out to us via our [Discord](https://discord.gg/K4KjjRV5ve) or by sending us an [email](mailto:[email protected]).
2323

2424
{% hint style="success" %}
25-
πŸ§™β€β™‚οΈ** Attention new accounts**: You will also have the opportunity to follow these steps via the onboarding helper tool that's visible to new users right after they [create an account](signing-up-for-an-account-with-bugsplat.md).
25+
πŸ§™β€β™‚οΈ **Attention new accounts**: You will also have the opportunity to follow these steps via the onboarding helper tool that's visible to new users right after they [create an account](signing-up-for-an-account-with-bugsplat.md).
2626
{% endhint %}

β€Žintroduction/getting-started/integrations/game-development/unity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,11 @@ Once you've posted an exception or a minidump to BugSplat click the link in the
118118

119119
## WebGL
120120

121-
A few settings must be changed in order to capture function names and line numbers in a WebGL exception report. Open **File > Build Settings **and switch the platform to **WebGL** and check **Development Build.**
121+
A few settings must be changed in order to capture function names and line numbers in a WebGL exception report. Open **File > Build Settings** and switch the platform to **WebGL** and check **Development Build.**
122122

123123
![Unity Build Settings Menu](../../../../.gitbook/assets/unity-build-settings.png)
124124

125-
Click the button that says **Player Settings**, highlight the **Player** section. Under **Publishing Settings**, select **Full With Stacktrace**.
125+
Click the button that says **Player Settings**, highlight the **Player** section. Under **Publishing Settings**, select **Full With Stacktrace**.&#x20;
126126

127127
![Unity Player Publishing Settings](../../../../.gitbook/assets/unity-full-with-stack-trace.png)
128128

β€Žintroduction/getting-started/integrations/game-development/unreal-engine.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Remember the values you use for {database}, {appName}, and {appVersion}. You wil
3434

3535
#### Unreal Engine 4.25 and older
3636

37-
For capturing crashes in packaged games in Unreal Engine 4.25 and earlier,** **copy `DefaultEngine.ini` to `{{output directory}}\Engine\Programs\CrashReportClient\Config\NoRedist` making sure to create folders that don't exist.
37+
For capturing crashes in packaged games in Unreal Engine 4.25 and earlier, **** copy `DefaultEngine.ini` to `{{output directory}}\Engine\Programs\CrashReportClient\Config\NoRedist` making sure to create folders that don't exist.
3838

3939
**Unreal Engine 4.26 and newer**
4040

@@ -52,7 +52,7 @@ Package your game, check that the **Include Crash Reporter** and **Include Debug
5252

5353
### Step 3
5454

55-
To create symbolic call stacks on Windows platforms you will need to upload symbol and executable files. The easiest way to upload files is to use our `SendPdbs` command line utility. `SendPdbs` can be downloaded either by [clicking here](https://app.bugsplat.com/browse/download_item.php?item=sendpdbs) or via the [SendPDBs](../../../../education/faq/using-sendpdbs-to-automatically-upload-symbol-files.md) doc. Run it from your build folder using the following commands.
55+
To create symbolic call stacks on Windows platforms you will need to upload symbol and executable files. The easiest way to upload files is to use our `SendPdbs` command line utility. `SendPdbs` can be downloaded either by [clicking here](https://app.bugsplat.com/browse/download\_item.php?item=sendpdbs) or via the [SendPDBs](../../../../education/faq/using-sendpdbs-to-automatically-upload-symbol-files.md) doc. Run it from your build folder using the following commands.
5656

5757
```bash
5858
cd {your build folder}

β€Žintroduction/getting-started/posting-a-test-crash/myconsolecrasher-c-plus-plus/address-sanitizer-reports.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Enable the Address Sanitizer by choosing the Enable Address Sanitizer (/fsanitiz
88

99
![Visual Studio Enable Address Sanitizer](../../../../.gitbook/assets/screen-shot-2021-08-03-at-5.14.10-pm.png)
1010

11-
Modify the Visual Studio Include Directories so that the Address Sanitizer header files can be located:
11+
Modify the Visual Studio Include Directories so that the Address Sanitizer header files can be located:&#x20;
1212

1313
![](../../../../.gitbook/assets/screen-shot-2021-08-03-at-5.27.05-pm.png)
1414

15-
## Modify Initialization Code
15+
## Modify Initialization Code&#x20;
1616

17-
To hook into the Address Sanitizer you will call **\__asan_set_error_report_callback**_ _with the BugSplat **createAssanReport** method. To do this, we'll need a global instance of the BugSplat MiniDmpSender object and a new asanCallback function. See below for how you would modify our myConsoleCrasher sample program:
17+
To hook into the Address Sanitizer you will call **\_\_asan\_set\_error\_report\_callback** __ with the BugSplat **createAssanReport** method. To do this, we'll need a global instance of the BugSplat MiniDmpSender object and a new asanCallback function. See below for how you would modify our myConsoleCrasher sample program:
1818

1919
```cpp
2020
...
@@ -42,7 +42,7 @@ int wmain(int argc, wchar_t** argv)
4242
}
4343
```
4444
45-
## Create Memory Corruption Test
45+
## Create Memory Corruption Test&#x20;
4646
4747
The only step left is to generate a memory corruption that Address Sanitizer will catch. Here's one way to do that:
4848
@@ -91,7 +91,7 @@ void HeapCorruption() {
9191
}
9292
```
9393
94-
Calling HeapCorruption (or your own memory error code) will generate the Address Sanitizer report and send a crash report to BugSplat.
94+
Calling HeapCorruption (or your own memory error code) will generate the Address Sanitizer report and send a crash report to BugSplat.&#x20;
9595
9696
## Crash Report Result
9797

β€Žintroduction/getting-started/signing-up-for-an-account-with-bugsplat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To register an account with BugSplat, visit the [Sign Up](https://app.bugsplat.c
44

55
![](../../.gitbook/assets/screen-shot-2021-08-24-at-9.55.33-am.png)
66

7-
Once you've hit **Sign Up** you'll be a registered user of BugSplat.
7+
Once you've hit **Sign Up** you'll be a registered user of BugSplat. &#x20;
88

99
Then, you'll be presented with a screen welcoming you to BugSplat. Here you can either go through a guided onboarding which aids in quickly configuring new accounts, or you can skip the onboarding and go directly to the [Dashboard](../development/using-the-app.md#dashboard) page.
1010

@@ -13,5 +13,5 @@ Then, you'll be presented with a screen welcoming you to BugSplat. Here you can
1313

1414

1515
{% hint style="info" %}
16-
🀝 **Looking to get access to an existing team? **You can request access from a team member using this form [here](https://app.bugsplat.com/v2/sign-up/team-access). Learn more about requesting access [here](../../administration/introduction/requesting-access-to-your-teams-accounts.md).
16+
🀝 **Looking to get access to an existing team?** You can request access from a team member using this form [here](https://app.bugsplat.com/v2/sign-up/team-access). Learn more about requesting access [here](../../administration/introduction/requesting-access-to-your-teams-accounts.md).
1717
{% endhint %}

β€Župdates/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Renames post and delete to postSymbols and deleteSymbols respectively
3333

3434
* Changes the order of the parameters for BugSplatApiClient's createAuthenticatedClientForNode and createAuthenticatedClientForWebBrowser functions so that host can be an optional parameter with a default value
3535

36-
## iOS - **Update - **September 26th, 2021
36+
## iOS - **Update -** September 26th, 2021
3737

3838
* Updated documentation.
3939

0 commit comments

Comments
Β (0)