# LogBrew Docs まずアプリまたはフレームワークを選び、Add Project でプロジェクトを作成して、CLI と dashboard の参照へ進む前に最初のシグナルを確認します。 # プラットフォームを選ぶ プロジェクトに合うアプリまたはフレームワークから始めます。Add Project でも同じ選択を使います。 ## Node.js サービス バックエンドサービスが logs、request spans、actions、releases、metrics を送る場合は Node.js パッケージを使います。 ```bash npm install @logbrew/sdk @logbrew/node ``` Next: Node の最初のシグナル手順を使う ## Express サービス Node サービスが Express middleware で requests を扱う場合は Express package を使います。 ```bash npm install @logbrew/sdk @logbrew/express express ``` Next: Add Project を開く ## Fastify サービス Node サービスが Fastify plugins で routes を扱う場合は Fastify package を使います。 ```bash npm install @logbrew/sdk @logbrew/fastify fastify ``` Next: Add Project を開く ## JavaScript アプリ Product actions、logs、軽量な client signals を送るフロントエンドページには JavaScript browser package を使います。 ```bash npm install @logbrew/sdk @logbrew/browser ``` Next: Add Project を開く ## Next.js アプリ Routes、server rendering、client actions を 1 つの setup path にまとめる Next.js アプリで使います。 ```bash npm install @logbrew/sdk @logbrew/next next react react-dom ``` Next: Add Project を開く ## React アプリ User actions と UI state を送るコンポーネント型 Web アプリには React package を使います。 ```bash npm install @logbrew/sdk @logbrew/react react ``` Next: Add Project を開く ## Angular アプリ Framework routing と app errors を同じ setup path で扱う場合は Angular package を使います。 ```bash npm install @logbrew/sdk @logbrew/angular @angular/core ``` Next: Add Project を開く ## Vue アプリ 明確な product actions と browser signals が必要な Vue アプリには Vue package を使います。 ```bash npm install @logbrew/sdk @logbrew/vue vue ``` Next: Add Project を開く ## Svelte アプリ 直接の SDK install path が必要な Svelte アプリには Svelte package を使います。 ```bash npm install @logbrew/sdk @logbrew/svelte svelte ``` Next: Add Project を開く ## NestJS サービス Node サービスが Nest modules と request handling を中心に構成されている場合は NestJS package を使います。 ```bash npm install @logbrew/sdk @logbrew/nestjs @nestjs/common @nestjs/core @nestjs/platform-express reflect-metadata rxjs ``` Next: Add Project を開く ## Python サービス Python workers と services は core package から始めます。 ```bash python3 -m pip install logbrew-sdk ``` Next: Add Project を開く ## Django アプリ Django project から request と app signals を送る場合は Django package を使います。 ```bash python3 -m pip install logbrew-sdk logbrew-django ``` Next: Add Project を開く ## FastAPI サービス Explicit request spans と actions を持つ Python API には FastAPI package を使います。 ```bash python3 -m pip install logbrew-sdk logbrew-fastapi ``` Next: Add Project を開く ## .NET サービス Service が server-side signals を所有する場合は .NET package をインストールします。 ```bash dotnet add package LogBrew ``` Next: Add Project を開く ## ASP.NET Core アプリ .NET の request handling と web app signals を 1 つの setup path で扱う場合は ASP.NET Core package を使います。 ```bash dotnet add package LogBrew.AspNetCore ``` Next: Add Project を開く ## Java サービス App-owned logs、request spans、product actions が必要な Java services には JVM package を使います。 ```bash implementation("co.logbrew:logbrew-sdk:0.1.0") ``` Next: Add Project を開く ## Go サービス Explicit logs、spans、metrics、trace context を所有する Go service には Go package を追加します。 ```bash go get github.com/LogBrewCo/sdk/go/logbrew@v0.1.3 ``` Next: Add Project を開く ## PHP アプリ PHP services と app-owned request signals には Composer を使います。 ```bash composer require logbrew/sdk ``` Next: Add Project を開く ## Ruby サービス Explicit app と request signals が必要な Ruby services には Ruby gem を使います。 ```bash gem install logbrew-sdk ``` Next: Add Project を開く ## Rust サービス 独自の logs、spans、actions、metrics を作る services には Rust crate を追加します。 ```bash cargo add logbrew ``` Next: Add Project を開く ## iOS アプリ Explicit product signals を送る iOS apps には Apple platform package を使います。 ```bash .package(url: "https://github.com/LogBrewCo/sdk.git", from: "0.1.1") ``` Next: Add Project を開く ## Android アプリ Android runtime から app-owned signals を送る apps には Android package を使います。 ```bash implementation("co.logbrew:logbrew-kotlin:0.1.0") ``` Next: Add Project を開く ## React Native アプリ JavaScript product actions を共有する mobile apps には React Native package を使います。 ```bash npm install @logbrew/sdk @logbrew/react-native react react-native ``` Next: Add Project を開く ## Unity アプリ Product actions と runtime signals を送る games や simulations には Unity package を使います。 ```bash "co.logbrew.unity": "file:../Packages/co.logbrew.unity" ``` Next: Add Project を開く ## C アプリ 直接 signal control が必要な native services や embedded apps には C sources を使います。 ```bash cc -std=c99 -Wall -Wextra -Wpedantic -Iinclude src/logbrew.c src/logbrew_metric.c src/logbrew_recording_transport.c src/logbrew_timeline.c src/logbrew_trace.c your_app.c -o your_app ``` Next: Add Project を開く ## C++ アプリ CMake 3.16 以上と C++17 のプロジェクトで公開済み CLI のプランを実行します。LogBrew::LogBrew をリンクします。ホステッド配信が必要な場合のみ LogBrew::HttpTransport と libcurl を有効にします。 ```bash logbrew setup --json ``` Next: Add Project を開く ## セットアップ手順の概要 この順序で、ドキュメントから確認済みプロダクトアクションまでセットアップ内で進めます。 - インストール. パッケージを追加: 実行環境に合う SDK パッケージから始めます。 - 作成. プロジェクトを作成: Add Project で一度だけ表示されるプロジェクト認証情報を取得します。 - 送信. プロダクトアクションを1件送信: アプリに組み込む前に、秘密を含まないプロダクトアクションを実行します。 - 確認. ログを確認: ログまたは CLI でシグナルを確認します。 # 最初のSDK成功実行 最初の作業は短く保ちます。パッケージを入れ、プロジェクトを作成し、秘密情報のないプロダクトアクションを1件送り、LogBrewで確認します。 ## 最初のシグナルに必要なもの SDK から直接送信するため、セットアップ手順を短く保てます。 - コレクター: ローカル agent 不要. SDK パッケージをインストールし、LogBrew API へ直接送信します。 - 認証情報: プロジェクト認証情報は1つ. そのプロジェクトを作成または設定するときだけ Add Project からコピーします。 - 確認: ログで確認. info シグナルを1件送り、本格的に計測する前に確認します。 ## AIアシスタント用コンテキスト アプリやセットアップコマンドを編集する前に、公開LogBrewマップをエージェントへ渡します。 ```bash curl -L https://logbrew.co/llms.txt ``` ### AIセットアッププロンプト ```bash https://logbrew.co/llms.txt を読み、次に https://logbrew.co/en/docs#docs-sdk-choice-title で一致するSDKカードを選んでください。npm install @logbrew/sdk @logbrew/node は server-side Node.js サービスだけで使います。Next.js、React、iOS、Android、React Native では選んだカードと Add Project prompt を使ってください。サインイン済みユーザーに Add Project を開いてもらい、認証情報は対応するアプリ環境にだけ設定してもらいます。server-side Node.js の環境変数は LOGBREW_SERVER_API_KEY です。node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs は Node サービスだけで実行し、その後 logbrew logs info --json で確認してください。チャットやコミットで認証情報を求めないでください。 ``` Next: エージェントガイドを開く ## SDKをインストール ログ、span、アクション、リリース、メトリクスが必要なバックエンドサービスには Node パッケージを使います。 ```bash npm install @logbrew/sdk @logbrew/node ``` ## プロジェクトを作成 Add Project を開き、プラットフォームを選び、setup パネルから一度だけ使う ingest 認証情報をコピーします。 Next: Add Project を開く ## プロダクトアクションを1件送信 本番コードへ組み込む前に同梱サンプルを実行し、最初の形を確認して token を含めない状態にします。 ```bash node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs ``` ## LogBrewで確認 さらに instrumentation を増やす前に、最初の info シグナルを logs で読み取ります。 ```bash logbrew logs info --json ``` # 最初の Node SDK シグナルを LogBrew に送る 追加の設定記事ではなく、実際のプロジェクトデータが必要なときに使う Node の流れです。Dashboard がプロジェクトを作成し、一度だけ使う ingest 認証情報を表示します。公開 docs にはパッケージと安全な確認手順だけを置きます。 ## JavaScript SDK パッケージを追加する Backend サービスから logs、request spans、actions、releases、metrics を送るときは、core SDK と Node helper から始めます。 ```bash npm install @logbrew/sdk @logbrew/node ``` ## Add Project でプロジェクトを作成する サインインして Add Project を開き、プラットフォームを選び、その setup パネルから一度だけ使う ingest 認証情報をコピーします。パネルを離れると website は再表示しません。 ## 最初の SDK シグナル例を実行する アプリに組み込む前に、インストール済みパッケージの例で release、environment、request span、product action、network milestone、metric の形を確認します。 ```bash node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs ``` ## LogBrew で最初のシグナルを読む SDK がプロジェクト認証情報で info シグナルを送ったら、さらに instrumentation を足す前に CLI または dashboard の logs で到着を確認します。 ```bash logbrew logs info --json ``` # 開始パスを選ぶ ## LogBrew の準備状況を確認する まず status を実行し、到達性、ログイン状態、安全な次の読み取りを確認します。 ```bash logbrew status --json ``` ## 直近の失敗から始める 直近の error ログを読み、リリースやプロジェクトに文脈が必要なときは課題またはトレースへ進みます。 ```bash logbrew logs error --json ``` ## 安定した課題ビューを共有する チームメイトが同じ失敗グループを必要とするとき、未解決の課題を一覧します。 ```bash logbrew issues open --json ``` # コマンドマップ ## Status private 読み取りの前に、ローカル auth、API 到達性、復旧手順を確認します。 ```bash logbrew status --json ``` ## ログ リリース、プロジェクト、トレースの文脈が必要なときは、直近のエラーから始めます。 ```bash logbrew logs error --json ``` ## 課題 解決、クローズ、無視、再オープンを決める前に、未解決の失敗グループを一覧します。 ```bash logbrew issues open --json ``` ## トレース詳細 ログや課題が一つの失敗リクエストを指すとき、既知の trace id を読みます。 ```bash logbrew trace --json ``` ## アクション 重要な文脈がプロダクト操作の場合、ユーザーイベントを名前で絞り込みます。 ```bash logbrew actions --name checkout_failed --json ``` ## リリース ログ、課題、トレース span、アクション数でロールアウト文脈を比較します。 ```bash logbrew releases --json ``` ## ローカル認証と API 到達性を確認する 最初の読み取りでは、トークン情報を出さずに、CLI が LogBrew API へ到達できるかを確認できます。 - スクリプトや自動化が安定したフィールドを必要とするときは JSON モードを使います。 - 開発者が次のコマンドを必要とするときは人向け出力を使います。 - auth の復旧は login と status へ戻すようにします。 ## 本番シグナルをリソースごとに読む ログ、課題、アクション、トレース、リリース、プロジェクトは、すばやく確認できる程度に分け、文脈を戻せる程度につなげます。 - ログは重大度、リリース、環境、プロジェクト、トレース、検索フィルターを保持します。 - 課題は状態、トレース文脈、変更語彙を保持します。 - トレースは span 名、リリース文脈、環境文脈、プロジェクト範囲を保持します。 ## プロジェクトデータを出さずに役立つ文脈を送る セットアップ支援や安全な引き継ぎが必要なときは、公開 Docs、Markdown、コピーできるコマンドを使います。 - 次の手順がセットアップやコマンド確認なら Docs リンクを共有します。 - スクリーンショットよりプレーンテキストがよい場合は Markdown を共有します。 - ダッシュボードのプロジェクトデータはログインと backend auth の後ろに置きます。 ## ダッシュボードを backend ルートに合わせる Web 作業環境は、dashboard-only の保存先や別契約を作らず、文書化された LogBrew API 契約に従う必要があります。 - ログは /api/logs から、重大度、リリース、環境、プロジェクト、トレース、検索フィルターで読み取ります。 - 課題は /api/telemetry/issues と /api/telemetry/issues/{issue_id} から読み取り、変更します。 - アクション、リリース、トレース詳細は /api/telemetry/actions、/api/telemetry/releases、/api/telemetry/traces/{trace_id} から読み取ります。 - プロジェクトと auth 状態は /api/projects、/api/auth、CLI status コマンドから取得します。 ## Public agent links - Full docs site: https://docs.logbrew.co - Docs: https://logbrew.co/ja/docs - Docs Markdown: https://logbrew.co/ja/docs.md - Agent guide: https://logbrew.co/ja/agents - Home Markdown: https://logbrew.co/ja/page.md - llms.txt: https://logbrew.co/llms.txt - Sitemap: https://logbrew.co/sitemap.xml