pingcap / pingcap/tiflash

Utilize telemetry to report exceptions

Open
#4,867 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type/enhancement
Dominant language
C++
Stars
1k
Forks
423
Avg merge
1d 15h
Merged PRs (30d)
24

Description

Enhancement

Currently there is no telemetry in TiFlash yet. Besides collecting usages by telemetry, we can also use it to catch exceptions like RUNTIME_CHECK and RUNTIME_ASSERT introduced by https://github.com/pingcap/tiflash/pull/4398. In this way, we can be noticed about logic errors at very early stage.

The telemetry stack looks to be easy to build up on sentry.

Notice that, unlike logs, we should only report call stack in the telemetry, in order to avoid collecting sensitive data.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names RUNTIME_CHECK and RUNTIME_ASSERT as the exception sources; begin by reviewing their implementation and the linked Sentry Native documentation. Done means TiFlash has telemetry for these logic errors that reports call stacks without collecting sensitive data.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.