audacity::sentry::anonymous_namespace{SentryReport.cpp} Namespace Reference

Classes
class	ExceptionContext
	Helper class to store additional details about the exception. More...

Functions
void	AddOSContext (rapidjson::Value &root, rapidjson::Document::AllocatorType &allocator)
	Append the data about the operating system to the JSON document. More...
rapidjson::Document	CreateSentryDocument ()
	Create the minimal required Sentry JSON document. More...
void	AddExceptionDataToJson (rapidjson::Value &value, rapidjson::Document::AllocatorType &allocator, const ExceptionData &data)
	Append the ExceptionData to the Exception JSON object. More...
void	SerializeException (const Exception &exception, rapidjson::Value &root, rapidjson::Document::AllocatorType &allocator)
	Serialize the Exception to JSON. More...

Function Documentation

AddExceptionDataToJson()

void audacity::sentry::anonymous_namespace{SentryReport.cpp}::AddExceptionDataToJson	(	rapidjson::Value &	value,
		rapidjson::Document::AllocatorType &	allocator,
		const ExceptionData &	data
	)

Append the ExceptionData to the Exception JSON object.

Definition at line 169 of file SentryReport.cpp.

{
   value.AddMember(
      rapidjson::Value(data.first.c_str(), data.first.length(), allocator),
      rapidjson::Value(data.second.c_str(), data.second.length(), allocator),
      allocator);
}

Referenced by SerializeException().

Here is the caller graph for this function:

AddOSContext()

void audacity::sentry::anonymous_namespace{SentryReport.cpp}::AddOSContext	(	rapidjson::Value &	root,
		rapidjson::Document::AllocatorType &	allocator
	)

Append the data about the operating system to the JSON document.

Definition at line 86 of file SentryReport.cpp.

{
   rapidjson::Value osContext(rapidjson::kObjectType);
 
   const wxPlatformInfo platformInfo = wxPlatformInfo::Get();
 
   const std::string osName =
      ToUTF8(platformInfo.GetOperatingSystemFamilyName());
 
   osContext.AddMember("type", rapidjson::Value("os", allocator), allocator);
 
   osContext.AddMember(
      "name", rapidjson::Value(osName.c_str(), osName.length(), allocator),
      allocator);
 
   const std::string osVersion =
      std::to_string(platformInfo.GetOSMajorVersion()) + "." +
      std::to_string(platformInfo.GetOSMinorVersion()) + "." +
      std::to_string(platformInfo.GetOSMicroVersion());
 
   osContext.AddMember(
      "version",
      rapidjson::Value(osVersion.c_str(), osVersion.length(), allocator),
      allocator);
 
   root.AddMember("os", std::move(osContext), allocator);
}

References BasicUI::Get(), and audacity::ToUTF8().

Referenced by CreateSentryDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

CreateSentryDocument()

rapidjson::Document audacity::sentry::anonymous_namespace{SentryReport.cpp}::CreateSentryDocument

(

)

Create the minimal required Sentry JSON document.

Definition at line 116 of file SentryReport.cpp.

{
   using namespace std::chrono;
   rapidjson::Document document;
 
   document.SetObject();
 
   document.AddMember(
      "timestamp",
      rapidjson::Value(
         duration_cast<seconds>(system_clock::now().time_since_epoch())
            .count()),
      document.GetAllocator());
 
   std::string eventId = Uuid::Generate().ToHexString();
 
   document.AddMember(
      "event_id",
      rapidjson::Value(
         eventId.c_str(), eventId.length(), document.GetAllocator()),
      document.GetAllocator());
 
   constexpr char platform[] = "native";
 
   document.AddMember(
      "platform",
      rapidjson::Value(platform, sizeof(platform) - 1, document.GetAllocator()),
      document.GetAllocator());
 
   document["platform"].SetString(
      platform, sizeof(platform) - 1, document.GetAllocator());
 
   const std::string release = std::string("audacity@") +
                               std::to_string(AUDACITY_VERSION) + "." +
                               std::to_string(AUDACITY_RELEASE) + "." +
                               std::to_string(AUDACITY_REVISION);
 
   document.AddMember(
      "release",
      rapidjson::Value(
         release.c_str(), release.length(), document.GetAllocator()),
      document.GetAllocator());
 
   rapidjson::Value contexts = rapidjson::Value(rapidjson::kObjectType);
 
   AddOSContext(contexts, document.GetAllocator());
 
   document.AddMember("contexts", contexts, document.GetAllocator());
 
   return document;
}

References AddOSContext(), audacity::Uuid::Generate(), and audacity::Uuid::ToHexString().

Here is the call graph for this function:

SerializeException()

void audacity::sentry::anonymous_namespace{SentryReport.cpp}::SerializeException	(	const Exception &	exception,
		rapidjson::Value &	root,
		rapidjson::Document::AllocatorType &	allocator
	)

Serialize the Exception to JSON.

Definition at line 180 of file SentryReport.cpp.

{
   root.AddMember(
      "type",
      rapidjson::Value(
         exception.Type.c_str(), exception.Type.length(), allocator),
      allocator);
 
   root.AddMember(
      "value",
      rapidjson::Value(
         exception.Value.c_str(), exception.Value.length(), allocator),
      allocator);
 
   rapidjson::Value mechanismObject(rapidjson::kObjectType);
 
   mechanismObject.AddMember(
      "type", rapidjson::Value("runtime_error", allocator), allocator);
 
   mechanismObject.AddMember(
      "handled", false, allocator);
 
   auto contextData = ExceptionContext::Get().MoveParameters();
 
   if (!exception.Data.empty() || !contextData.empty())
   {
      rapidjson::Value dataObject(rapidjson::kObjectType);
 
      for (const auto& data : contextData)
         AddExceptionDataToJson(dataObject, allocator, data);
 
      for (const auto& data : exception.Data)
         AddExceptionDataToJson(dataObject, allocator, data);
 
      mechanismObject.AddMember("data", std::move(dataObject), allocator);
   }
 
   root.AddMember("mechanism", std::move(mechanismObject), allocator);
}

References AddExceptionDataToJson(), audacity::sentry::AnonymizedMessage::c_str(), audacity::sentry::Exception::Data, BasicUI::Get(), audacity::sentry::AnonymizedMessage::length(), audacity::sentry::Exception::Type, and audacity::sentry::Exception::Value.

Referenced by audacity::sentry::Report::ReportImpl::ReportImpl().

Here is the call graph for this function:

Here is the caller graph for this function: