Skip to content
View as Markdown

IssueGroup

Field Type Description
id string The unique identifier for the issue group.
metadata bitdrift.public.unary.client_report.v1.IssueGroup.Metadata The metadata for the issue group.
platform repeated bitdrift.public.shared.platform.v1.Platform The platform on which the issue group occurred. Once we support React Native for issues/crashes, we may encounter issues that span multiple platforms. Most of the time we expect this to be a single platform.
stats bitdrift.public.unary.client_report.v1.IssueGroup.Stats The stats for the issue group BEFORE filters are applied.
assignees repeated bitdrift.public.unary.common.v1.Owner The assignees of the issue group.
status bitdrift.public.unary.client_report.v1.IssueGroupStatus The status of the issue group.
filtered_stats bitdrift.public.unary.client_report.v1.IssueGroup.Stats The stats for the issue group AFTER filters are applied.
version string (Only one of version, or version_code can be set)
version_code int64 android-specific version field

(Only one of version_code, or version can be set)

Example

JSON
{
  "assignees": [
    {
      "email": "user@example.com",
      "id": "usr_abc123",
      "name": "Jane Doe"
    }
  ],
  "filtered_stats": {
    "events": [
      {
        "count": 42,
        "period_start": "2024-01-15T09:30:00Z"
      }
    ],
    "first_report_seen": "2024-01-15T09:30:00Z",
    "first_seen": "2024-01-15T09:30:00Z",
    "last_seen": "2024-01-15T09:30:00Z",
    "session_count": 42,
    "user_count": 42
  },
  "id": "11937913729565882410",
  "metadata": {
    "context": "alloc::alloc::handle_alloc_error",
    "details": "Attempted to dereference a null pointer",
    "platform": {
      "apple": {
        "apps": [
          {
            "app_id": "com.example.app"
          }
        ]
      }
    },
    "reason": "KERN_INVALID_ADDRESS",
    "type": "EXC_BAD_ACCESS"
  },
  "platform": [
    {
      "apple": {
        "apps": [
          {
            "app_id": "com.example.app"
          }
        ]
      }
    }
  ],
  "stats": {
    "events": [
      {
        "count": 42,
        "period_start": "2024-01-15T09:30:00Z"
      }
    ],
    "first_report_seen": "2024-01-15T09:30:00Z",
    "first_seen": "2024-01-15T09:30:00Z",
    "last_seen": "2024-01-15T09:30:00Z",
    "session_count": 42,
    "user_count": 42
  },
  "status": "NEW",
  "version": "2.1.0"
}

IssueGroup.Metadata

Field Type Description
type string The type of the issue group metadata. i.e. Crash, ANR, Exception, etc.
reason string The reason behind the issue group metadata. i.e. OutOfMemoryError, NullPointerException, etc.
context optional string Additional context about the issue group metadata. i.e. file name, function name, etc. This is used as part of the issue grouping key.
details optional string The details of the issue group metadata. i.e. stack trace, error message, etc. This is not used as part of the issue grouping key. This will be the details associated with one of the issues in the group and is not necessarily representative of the entire group.
platform bitdrift.public.shared.platform.v1.Platform The platform and app_id associated with the issue group.

Example

JSON
{
  "context": "alloc::alloc::handle_alloc_error",
  "details": "Attempted to dereference a null pointer",
  "platform": {
    "apple": {
      "apps": [
        {
          "app_id": "com.example.app"
        }
      ]
    }
  },
  "reason": "KERN_INVALID_ADDRESS",
  "type": "EXC_BAD_ACCESS"
}

IssueGroup.Stats

Field Type Description
first_seen google.protobuf.Timestamp The first time the issue group was seen within the time range.
last_seen google.protobuf.Timestamp The last time the issue group was seen within the time range.
first_report_seen google.protobuf.Timestamp The first time any report was seen for this issue group.
user_count uint64 The number of unique users that have experienced this issue.
events repeated bitdrift.public.unary.client_report.v1.Event
session_count uint64 The number of unique sessions in which this issue was reported

Example

JSON
{
  "events": [
    {
      "count": 42,
      "period_start": "2024-01-15T09:30:00Z"
    }
  ],
  "first_report_seen": "2024-01-15T09:30:00Z",
  "first_seen": "2024-01-15T09:30:00Z",
  "last_seen": "2024-01-15T09:30:00Z",
  "session_count": 42,
  "user_count": 42
}