https://github.com/gameframex/com.gameframex.unity.sentry
GameFrameX Unity Sentry integration for real-time error tracking, crash reporting and performance monitoring
https://github.com/gameframex/com.gameframex.unity.sentry
crash-reporting csharp error-tracking game-framework monitoring sentry unity upm-package
Last synced: 14 days ago
JSON representation
GameFrameX Unity Sentry integration for real-time error tracking, crash reporting and performance monitoring
- Host: GitHub
- URL: https://github.com/gameframex/com.gameframex.unity.sentry
- Owner: GameFrameX
- License: apache-2.0
- Created: 2026-01-09T02:35:27.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-06-07T08:38:46.000Z (29 days ago)
- Last Synced: 2026-06-07T10:21:23.840Z (29 days ago)
- Topics: crash-reporting, csharp, error-tracking, game-framework, monitoring, sentry, unity, upm-package
- Language: C#
- Homepage: https://gameframex.doc.alianblank.com
- Size: 42 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.ja.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Game Frame X Sentry
[](https://github.com/GameFrameX/com.gameframex.unity.sentry/blob/main/LICENSE.md)
[](https://github.com/GameFrameX/com.gameframex.unity.sentry/releases)
[](https://unity.com/)
[](https://gameframex.doc.alianblank.com)
インディゲーム開発者向けオールインワンソリューション · インディ開発者の夢を支援
[ドキュメント](https://gameframex.doc.alianblank.com) · [クイックスタート](#クイックスタート) · QQグループ: 467608841 / 233840761
[English](README.md) | [简体中文](README.zh-CN.md) | [繁體中文](README.zh-TW.md) | **日本語** | [한국어](README.ko.md)
## 言語
[English](README.md) | [简体中文](README.zh-CN.md) | [繁體中文](README.zh-TW.md) | **日本語** | [한국어](README.ko.md)
---
## プロジェクト概要
このプラグインは [GameFrameX](https://github.com/GameFrameX/GameFrameX) フレームワークの Sentry ログ報告モジュールです。Unity プロジェクトのログ情報を Sentry プラットフォームにリアルタイムで報告し、開発者がゲームの実行状態を監視・分析できるようにします。
## 機能
- **マルチレベルログ報告** - Debug、Info、Warning、Error、Fatal の5つのログレベルをサポート
- **タイムスタンプマーク** - 各ログエントリにUnityタイムスタンプを自動追加し、問題追跡を容易に
- **GameFramework 統合** - GameFramework ログシステムとシームレスに統合
- **コードストリッピング防止** - `[Preserve]` 属性を使用して Unity のコードストリッピング問題を防止
- **軽量実装** - パフォーマンスに影響を与えない効率的なログヘルパー実装
## クイックスタート
### インストール
以下のいずれかの方法を選択してください：
1. Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください：
```json
{
"scopedRegistries": [
{
"name": "GameFrameX",
"url": "https://gameframex.upm.alianblank.uk",
"scopes": [
"com.gameframex"
]
}
],
"dependencies": {
"com.gameframex.unity.sentry": "1.1.1"
}
}
```
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
2. `manifest.json` の `dependencies` に直接追加：
```json
{
"com.gameframex.unity.sentry": "https://github.com/gameframex/com.gameframex.unity.sentry.git"
}
```
3. Unity の **Package Manager** で **Git URL** を使用して追加：`https://github.com/gameframex/com.gameframex.unity.sentry.git`
4. リポジトリを Unity プロジェクトの `Packages` ディレクトリにクローンしてください。自動的に読み込まれます。
## 使用例
### SentryLogHelper の初期化
```csharp
using GameFrameX;
using GameFrameX.SentryLog.Runtime;
public class GameEntry : MonoBehaviour
{
private void Start()
{
// GameFramework を初期化
GameFrameworkEntry.GetSingleton().SetLogHelper(new SentryLogHelper());
// すべてのログが自動的に Sentry に報告されます
Log.Debug("ゲーム起動成功");
Log.Info("プレイヤーログイン: {0}", playerName);
Log.Warning("ネットワーク遅延が高い: {0}ms", latency);
Log.Error("アセットの読み込みに失敗: {0}", assetPath);
Log.Fatal("重大なエラー、ゲームが終了します");
}
}
```
### ログレベル
| ログレベル | Sentry レベル | 使用場面 |
|-----------|-------------|----------|
| Debug | Info | デバッグ情報、開発段階 |
| Info | Info | 一般情報、通常動作ログ |
| Warning | Warning | 警告情報、致命的でない問題 |
| Error | Error | エラー情報、機能障害 |
| Fatal | Fatal | 致命的エラー、プログラム継続不可 |
## プラットフォーム対応
| プラットフォーム | 対応 |
|------------------|------|
| iOS | はい |
| Android | はい |
| Windows | はい |
| macOS | はい |
| WebGL | はい |
## 依存関係
- **com.gameframex.unity**: 1.1.1+ - GameFramework コア
- **io.sentry.unity**: 4.0.0+ - Sentry Unity SDK
## 変更履歴
詳細は [CHANGELOG.md](CHANGELOG.md) をご覧ください。
## ドキュメントとリソース
- [ドキュメント](https://gameframex.doc.alianblank.com)
## コミュニティとサポート
- QQグループ: 467608841 / 233840761
## ライセンス
詳しくは [LICENSE.md](LICENSE.md) をご参照ください。