Skip to content

Latest commit

 

History

History
242 lines (206 loc) · 12.8 KB

crash.md

File metadata and controls

242 lines (206 loc) · 12.8 KB
Raw

Crash Post Endpoints

Most crash uploads to BugSplat are done via pre-signed URLs. However, some platforms do not support uploading via pre-signed URLs. The following documentation describes how customers can POST crashes directly to BugSplat via a suite of endpoints specific to their BugSplat database.

{% hint style="warning" %} All these crashes must be uploaded via your BugSplat subdomain (e.g., https://your-database.bugsplat.com) to ensure that our backend accepts them. {% endhint %}

PlayStation 4

POST https://{{database}}.bugsplat.com/post/ps4/crash

Uploads a Playstation 4 crash report, extracts user data and user files

Path Parameters

Name Type Description
{{database}}* string Replace the subdomain value with the value of your BugSplat database

Request Body

Name Type Description
corefile* object The core dump file to be uploaded
application* string

Name of the crashing application.

IMPORTANT

this value must match the value used to upload symbols.
version* string

Crashing application's version.

IMPORTANT

this value must match the value used to upload symbols

{% tabs %} {% tab title="200 " %}

{
    "status": "success",
    "crashId": 1,
    "techSupportUrl": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

{% endtab %} {% endtabs %}

PlayStation 5

POST https://{{database}}.bugsplat.com/post/ps5/crash

Uploads a Playstation 5 crash report, extracts user data and user files

Path Parameters

Name Type Description
{{database}}* string Replace the subdomain value with the value of your BugSplat database

Request Body

Name Type Description
corefile* object The core dump file to be uploaded
application* string

Name of the crashing application.

IMPORTANT

this value must match the value used to upload symbols.
version* string

Crashing application's version.

IMPORTANT

this value must match the value used to upload symbols

{% tabs %} {% tab title="200 " %}

{
    "status": "success",
    "crashId": 1,
    "techSupportUrl": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

{% endtab %} {% endtabs %}

Crashpad

POST https://{{database}}.bugsplat.com/post/bp/crash/crashpad.php

Uploads a Crashpad crash report with optional metadata.

Path Parameters

Name Type Description
{{database}}* String Replace the subdomain value with the name of your BugSplat database

Request Body

Name Type Description
upload_file_minidump* FILE File POST parameter. This file can optionally be zip compressed.
other files FILE Any additional file POSTs will be attached to the crash report.
product* String Application name
version* String Application version
key String BugSplat crash key
user String User reporting the crash
list_annotations String User description of the problem
String

{% tabs %} {% tab title="200: OK " %}

{
    "status": "success",
    "crash_id": 1,
    "url": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

{% endtab %} {% endtabs %}

XML

POST {{database}}.bugsplat.com/post/xml/index.php

Uploads an XML crash report and can be used to create reports for languages and platforms not directly supported by BugSplat.

Path Parameters

Name Type Description
{{database}}* String Replace the subdomain value with the name of your BugSplat database

Request Body

Name Type Description
file* FILE XML file containing crash report. File name must be bsCrashReport.xml
other files FILE Any additional file POSTs will be attached to the crash report.
appName* String Application name
appVersion* String Application version
appKey String BugSplat crash key
user String User reporting the crash
email String Email of user
description String User description of the problem
ipAddress String IP Address of machine generating report
notes string Arbitrary additional data about the crash report

{% tabs %} {% tab title="200: OK " %}

{
    "status": "success",
    "crash_id": 1,
    "url": "https://app.bugsplat.com/browse/crashInfo.php?vendor=fred&version=1.0&key=key&id=99999999&row=1"
}

{% endtab %} {% endtabs %}

Example XML File

<report>
    <process>
        <exception>
            <code>FATAL ERROR</code>
            <explanation>This is an error code explanation</explanation>
            <func><![CDATA[myConsoleCrasher!MemoryException]]></func>
            <file>/www/bugsplatAutomation/myConsoleCrasher/myConsoleCrasher.cpp</file>
            <line>143</line>
            <registers>
                <cs>0023</cs>
                <ds>002b</ds>
                <eax>00000011</eax>
                <ebp>00affb58</ebp>
                <ebx>00858000</ebx>
                <ecx>43bf1e0e</ecx>
                <edi>00affb58</edi>
                <edx>014480b4</edx>
                <efl>00010202</efl>
            </registers>
        </exception>
        <modules numloaded="2">
            <module>
                <name>myConsoleCrasher</name>
                <order>1</order>
                <address>01320000-01457000</address>
                <path>C:/www/BugsplatAutomation/BugsplatAutomation/bin/x64/Release/temp/BugSplat/bin/myConsoleCrasher.exe</path>
                <symbolsloaded>deferred</symbolsloaded>
                <fileversion/>
                <productversion/>
                <checksum>00000000</checksum>
                <timedatestamp>SatJun1501:18:092019</timedatestamp>
            </module>
            <module>
                <name>BugSplatRc</name>
                <order>2</order>
                <address>01320000-01457000</address>
                <path>C:/www/BugsplatAutomation/BugsplatAutomation/bin/x64/Release/BugSplatRc.dll</path>
                <symbolsloaded>deferred</symbolsloaded>
                <fileversion/>
                <productversion/>
                <checksum>00000000</checksum>
                <timedatestamp>SatJun1501:18:092019</timedatestamp>
            </module>
        </modules>
        <threads count="2">
            <thread id="0" current="yes" event="yes" framecount="3">
                <frame>
                    <symbol><![CDATA[myConsoleCrasher!MemoryException]]></symbol>
                    <file>/www/bugsplatAutomation/myConsoleCrasher/myConsoleCrasher.cpp</file>
                    <line>143</line>
                    <offset>0x35</offset>
                </frame>
                <frame>
                    <symbol>
                        <![CDATA[myConsoleCrasher!wmain]]>
                    </symbol>
                    <file>C:/www/BugsplatAutomation/BugsplatAutomation/BugSplat/samples/myConsoleCrasher/myConsoleCrasher.cpp</file>
                    <line>83</line>
                    <offset>0x239</offset>
                </frame>
                <frame>
                    <symbol><![CDATA[myConsoleCrasher!__scrt_wide_environment_policy::initialize_environment]]></symbol>
                    <file>d:/agent/_work/4/s/src/vctools/crt/vcstartup/src/startup/exe_common.inl</file>
                    <line>90</line>
                    <offset>0x43</offset>
                </frame>
            </thread>
            <thread id="1" current="no" event="no" framecount="3">
                <frame>
                    <symbol><![CDATA[my2ConsoleCrasher!MemoryException]]></symbol>
                    <file>/www/bugsplatAutomation/myConsoleCrasher/myConsoleCrasher.cpp</file>
                    <line>143</line>
                    <offset>0x35</offset>
                </frame>
                <frame>
                    <symbol><![CDATA[my2ConsoleCrasher!wmain]]></symbol>
                    <file>C:/www/BugsplatAutomation/BugsplatAutomation/BugSplat/samples/myConsoleCrasher/myConsoleCrasher.cpp</file>
                    <line>83</line>
                    <offset>0x239</offset>
                </frame>
                <frame>
                    <symbol><![CDATA[my2ConsoleCrasher!__scrt_wide_environment_policy::initialize_environment]]></symbol>
                    <file>d:/agent/_work/4/s/src/vctools/crt/vcstartup/src/startup/exe_common.inl</file>
                    <line>90</line>
                    <offset>0x43</offset>
                </frame>
            </thread>
        </threads>
    </process>
</report>