LogBrew Docs

まずアプリまたはフレームワークを選び、Add Project でプロジェクトを作成して、CLI と dashboard の参照へ進む前に最初のシグナルを確認します。

プラットフォームを選ぶAdd Project を開く

プラットフォームを選ぶ

プロジェクトに合うアプリまたはフレームワークから始めます。Add Project でも同じ選択を使います。

プラットフォームを絞り込む
26件中6件を表示

Node.js

Node.js サービス

バックエンドサービスが logs、request spans、actions、releases、metrics を送る場合は Node.js パッケージを使います。

npm install @logbrew/sdk @logbrew/node
Node の最初のシグナル手順を使う

Express

Express サービス

Node サービスが Express middleware で requests を扱う場合は Express package を使います。

npm install @logbrew/sdk @logbrew/express express
Add Project を開く

Fastify

Fastify サービス

Node サービスが Fastify plugins で routes を扱う場合は Fastify package を使います。

npm install @logbrew/sdk @logbrew/fastify fastify
Add Project を開く

NestJS

NestJS サービス

Node サービスが Nest modules と request handling を中心に構成されている場合は NestJS package を使います。

npm install @logbrew/sdk @logbrew/nestjs @nestjs/common @nestjs/core @nestjs/platform-express reflect-metadata rxjs
Add Project を開く

Python

Python サービス

Python workers と services は core package から始めます。

python3 -m pip install logbrew-sdk
Add Project を開く

Django

Django アプリ

Django project から request と app signals を送る場合は Django package を使います。

python3 -m pip install logbrew-sdk logbrew-django
Add Project を開く

インストールコマンド

最初のSDK成功実行

最初の作業は短く保ちます。パッケージを入れ、プロジェクトを作成し、秘密情報のないプロダクトアクションを1件送り、LogBrewで確認します。

  1. 1SDKをインストールログ、span、アクション、リリース、メトリクスが必要なバックエンドサービスには Node パッケージを使います。
    npm install @logbrew/sdk @logbrew/node
  2. 2プロジェクトを作成Add Project を開き、プラットフォームを選び、setup パネルから一度だけ使う ingest 認証情報をコピーします。Add Project を開く
  3. 3プロダクトアクションを1件送信本番コードへ組み込む前に同梱サンプルを実行し、最初の形を確認して token を含めない状態にします。
    node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs
  4. 4LogBrewで確認さらに instrumentation を増やす前に、最初の info シグナルを logs で読み取ります。
    logbrew logs info --json
AIアシスタント用コンテキスト

アプリやセットアップコマンドを編集する前に、公開LogBrewマップをエージェントへ渡します。

curl -L https://logbrew.co/llms.txt
AIセットアッププロンプト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 で確認してください。チャットやコミットで認証情報を求めないでください。
エージェントガイドを開く
最初の Node SDK シグナルを LogBrew に送る

追加の設定記事ではなく、実際のプロジェクトデータが必要なときに使う Node の流れです。Dashboard がプロジェクトを作成し、一度だけ使う ingest 認証情報を表示します。公開 docs にはパッケージと安全な確認手順だけを置きます。

  1. JavaScript SDK パッケージを追加する

    Backend サービスから logs、request spans、actions、releases、metrics を送るときは、core SDK と Node helper から始めます。

    npm install @logbrew/sdk @logbrew/node

  2. Add Project でプロジェクトを作成する

    サインインして Add Project を開き、プラットフォームを選び、その setup パネルから一度だけ使う ingest 認証情報をコピーします。パネルを離れると website は再表示しません。

    Add Project を開く

  3. 最初の SDK シグナル例を実行する

    アプリに組み込む前に、インストール済みパッケージの例で release、environment、request span、product action、network milestone、metric の形を確認します。

    node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs

  4. LogBrew で最初のシグナルを読む

    SDK がプロジェクト認証情報で info シグナルを送ったら、さらに instrumentation を足す前に CLI または dashboard の logs で到着を確認します。

    logbrew logs info --json
Docs サーフェス3

docs.logbrew.co

完全な Docs サイト

長いセットアップ、API 詳細、製品ページを詰め込みすぎないための例は、専用の Docs サイトで確認します。

Docs サイトを開く

プレーンテキスト

Markdown Docs ミラー

エージェントやターミナルのワークフローがブラウザ専用の状態なしで同じ Docs を読む必要があるときは、ローカライズされた Markdown ミラーを使います。

Markdown を開く

プレーンテキスト

エージェントミラー

エージェントが予測可能な公開読み取りパスを必要とするときは、llms.txt、Markdown ミラー、robots、sitemap を使います。

llms.txt を開く
開始パスを選ぶ3

セットアップ

LogBrew の準備状況を確認する

まず status を実行し、到達性、ログイン状態、安全な次の読み取りを確認します。

logbrew status --json

トリアージ

直近の失敗から始める

直近の error ログを読み、リリースやプロジェクトに文脈が必要なときは課題またはトレースへ進みます。

logbrew logs error --json

引き継ぎ

安定した課題ビューを共有する

チームメイトが同じ失敗グループを必要とするとき、未解決の課題を一覧します。

logbrew issues open --json
コマンドマップ6

コマンドマップ

Status

private 読み取りの前に、ローカル auth、API 到達性、復旧手順を確認します。

logbrew status --json

コマンドマップ

ログ

リリース、プロジェクト、トレースの文脈が必要なときは、直近のエラーから始めます。

logbrew logs error --json

コマンドマップ

課題

解決、クローズ、無視、再オープンを決める前に、未解決の失敗グループを一覧します。

logbrew issues open --json

コマンドマップ

トレース詳細

ログや課題が一つの失敗リクエストを指すとき、既知の trace id を読みます。

logbrew trace <trace_id> --json

コマンドマップ

アクション

重要な文脈がプロダクト操作の場合、ユーザーイベントを名前で絞り込みます。

logbrew actions --name checkout_failed --json

コマンドマップ

リリース

ログ、課題、トレース span、アクション数でロールアウト文脈を比較します。

logbrew releases --json
LogBrew Docs4

まず CLI

ローカル認証と API 到達性を確認する

最初の読み取りでは、トークン情報を出さずに、CLI が LogBrew API へ到達できるかを確認できます。

  • スクリプトや自動化が安定したフィールドを必要とするときは JSON モードを使います。
  • 開発者が次のコマンドを必要とするときは人向け出力を使います。
  • auth の復旧は login と status へ戻すようにします。

観測

本番シグナルをリソースごとに読む

ログ、課題、アクション、トレース、リリース、プロジェクトは、すばやく確認できる程度に分け、文脈を戻せる程度につなげます。

  • ログは重大度、リリース、環境、プロジェクト、トレース、検索フィルターを保持します。
  • 課題は状態、トレース文脈、変更語彙を保持します。
  • トレースは span 名、リリース文脈、環境文脈、プロジェクト範囲を保持します。

共有

プロジェクトデータを出さずに役立つ文脈を送る

セットアップ支援や安全な引き継ぎが必要なときは、公開 Docs、Markdown、コピーできるコマンドを使います。

  • 次の手順がセットアップやコマンド確認なら Docs リンクを共有します。
  • スクリーンショットよりプレーンテキストがよい場合は Markdown を共有します。
  • ダッシュボードのプロジェクトデータはログインと backend auth の後ろに置きます。

API マップ

ダッシュボードを 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 コマンドから取得します。