Lỗi dùng envelope lỗi API chuẩn. Lần đọc không có
xác thực tài khoản hợp lệ trả về
401 với code: "unauthorized". Không hiển
thị lỗi đó thành mức sử dụng bằng 0, biểu đồ trống hoặc gói miễn phí. Phương
thức không được hỗ trợ trả về 405 với code: "method_not_allowed", và next
nêu tên yêu cầu được hỗ trợ.
Account API báo cáo mức sử dụng telemetry, không phải số tiền. API này không báo
cáo khoản phí, hóa đơn hoặc trạng thái thanh toán.
Mức sử dụng của tài khoản
GET /api/account/usage là endpoint chuẩn cho mức sử dụng và hạn mức. Dùng
endpoint này để lấy tổng mức sử dụng, thời điểm đặt lại, trạng thái hạn mức và
số liệu phân tách theo dự án và theo luồng telemetry. Không tự tính mức sử dụng
từ tệp SDK, tệp CLI hoặc bộ đếm phía client. Lệnh CLI logbrew usage đọc
endpoint này. Xem Tham khảo CLI.
Sự kiện bị SDK loại bỏ
Gửiresponse_version=2 để nhận thêm sdk_dropped_events. Nếu không có tham số này, hoặc dùng response_version=1, phản hồi sẽ không có trường này.
sdk_dropped_events liệt kê các sự kiện mà SDK báo là đã loại bỏ trước khi gửi trong kỳ hiện tại, ví dụ vì hàng đợi của client đã đầy. Mỗi dự án và lý do có 1 dòng:
Các sự kiện bị loại bỏ chưa bao giờ đến được LogBrew. Chúng không bị tính phí và không được tính vào
usage, by_project hoặc by_stream. Mảng sẽ trống khi không có SDK nào báo loại bỏ sự kiện.
Mảng này cũng đếm các bản ghi OTLP mà LogBrew đã từ chối, với lý do otlp_rejected_record, hoặc usage_limit_exceeded khi đạt hạn mức của gói. Các bản ghi này đã đến LogBrew nhưng LogBrew không lưu chúng. Chúng không bị tính phí. Xem OpenTelemetry (OTLP).
Ưu đãi cho tài khoản mới
Các tài khoản trước đây được dùng hạn mức của gói Pro miễn phí trong 6 tháng, tính từ lúc đăng ký, hoặc từ ngày 2026-10-22 với tài khoản đã có vào ngày đó. Các tài khoản này giữ ưu đãi đếnends_at. Tài khoản mới bắt đầu với gói Free và không nhận ưu đãi này. Gói Pro có 1 tháng dùng thử miễn phí. Thêm thẻ để bắt đầu; sau đó gói tự gia hạn hằng tháng cho đến khi bạn hủy. Gửi response_version=3 để nhận thêm offer. Phiên bản 1 và 2 không có trường này. Phiên bản 3 cũng có sdk_dropped_events.
offer là null khi không có ưu đãi nào đang hiệu lực. Nếu có, nó gồm các trường sau:
Khi một ưu đãi đang hiệu lực,
limits.retention_days, state, limit, percent_used và next_action dùng hạn mức lớn hơn giữa gói riêng của tài khoản và ưu đãi. plan vẫn hiển thị gói riêng của tài khoản. Sau ends_at, tài khoản dùng lại gói riêng của mình. Phiên bản 1 và 2 theo cùng các hạn mức, nhưng không hiển thị ưu đãi. Tổng quan thanh toán GET /api/billing/overview có cùng trường offer. Phần này còn có pro_trial_available, có giá trị true khi thanh toán gói Pro sẽ bắt đầu thời gian dùng thử miễn phí.
Trạng thái hạn mức
Dùngstate cho nhánh xử lý chính. limit chỉ là null khi state là ok.
Bảng này áp dụng cho phiên bản 2 và 3. Phiên bản 1, mặc định, có 2 điểm khác:
warning cũng là true ở trạng thái blocked, và ở trạng thái warning,
next_action.target là account_usage.
next_action.state, next_action.limit và next_action.reset_at lặp lại các
giá trị ở cấp trên cùng. Các giá trị next_action.code còn gồm
check_usage_limits với target account_usage. Nếu client nhận được cặp giá
trị này, đọc lại mức sử dụng và hiển thị next.
LogBrew đo từng loại telemetry theo hạn mức riêng của loại đó. limit gộp
chúng thành nhóm:
eventsgồm sự kiện vấn đề và span của trace.bytesgồm byte log và byte chỉ số.
limit nêu tên hạn
mức bị chặn. Trạng thái warning bắt đầu khi mức sử dụng đạt
warning_threshold của một hạn mức. Trạng thái blocked bắt đầu khi mức sử
dụng chạm hạn mức.
Văn bản next có thể thay đổi, ví dụ khi các gói không được bán. Các giá trị
next_action không thay đổi. Bản địa hóa dựa trên next_action. Không phân
tích cú pháp next.
Hạn mức sử dụng của tài khoản không phải là giới hạn tốc độ API. Khi lượng dữ
liệu gửi vượt quá một hạn mức, yêu cầu gửi dữ liệu trả về 429 với
usage_limit_exceeded, và body có thêm limit và reset_at. Trong lỗi đó,
limit nêu tên chính xác hạn mức: issue_events, log_bytes, metric_bytes
hoặc trace_spans. LogBrew từ chối toàn bộ yêu cầu. Không gửi lại loại
telemetry đó cho đến reset_at hoặc cho đến khi gói thay đổi. Khi
client gửi quá nhiều yêu cầu, API trả về rate_limited. Xem
Lỗi API.
Phản hồi là một snapshot (dữ liệu tại thời điểm đọc). Đọc lại sau khi tài khoản thay đổi.
GET /api/logs/usage là phản hồi tương thích cũ dành cho ứng dụng di động,
với bytes_used, limit_bytes và month. Dùng GET /api/account/usage cho
các tích hợp mới.Lịch sử sử dụng
GET /api/account/usage/history trả về các khoảng gộp mức sử dụng với số lượng
có giới hạn, để vẽ biểu đồ và lập báo cáo. Khoảng gộp không có dữ liệu được
điền 0. Đặt interval thành một giá trị được hỗ trợ. Nếu bỏ interval, API dùng
monthly. Route này không nhận tham số truy vấn nào khác.
Phản hồi
yearly này dùng dữ liệu giả lập cho một yêu cầu vào tháng 6 năm 2026.
Toàn bộ mức sử dụng diễn ra trong tháng 6:
current.reset_at để biết thời điểm đặt lại hạn mức. Không dùng thời điểm
kết thúc của cửa sổ lịch sử. current không phải là tổng của các khoảng gộp, và
ngày của nó có thể khác với ngày của cửa sổ.
Khoảng gộp cuối cùng chứa kỳ lịch hiện tại, là kỳ chưa kết thúc. Thời điểm kết
thúc trong tương lai của khoảng gộp này không có nghĩa là LogBrew đã đo mức sử
dụng trong tương lai. Khoảng gộp có giá trị 0 nghĩa là LogBrew không đếm được
mức sử dụng nào trong khoảng gộp đó.
Trong một khoảng gộp, usage.projects đếm các dự án có mức sử dụng trong khoảng
gộp đó. Không cộng các số này để lấy số dự án. Dùng current.usage.projects để
biết số dự án mà tài khoản sở hữu.
Vẽ sự kiện và byte thành các chuỗi riêng vì chúng dùng đơn vị khác nhau. Các
khoảng gộp chứa mức sử dụng, không chứa chi phí. Không gắn nhãn biểu đồ là chi
tiêu, hóa đơn hoặc yêu cầu API.
Chu kỳ không được hỗ trợ trả về 422:
422 với validation_failed.
Gói và hạn mức
GET /api/billing/catalog liệt kê các gói. Endpoint này không cần xác thực. Mọi gói đều có đầy đủ tính năng. Mọi gói đều có số thành viên và dự án không giới hạn. Các gói khác nhau về khối lượng và thời gian giữ dữ liệu. Hạn mức được đặt lại mỗi tháng thanh toán. 1 GB là 1.000.000.000 byte.
Bạn mua gói Pro và Business qua trang thanh toán, và checkout_available là true. Với Enterprise, hãy gửi email đến địa chỉ quote_email của gói để nhận báo giá. Tài khoản có ưu đãi cho tài khoản mới đang hiệu lực được dùng hạn mức của gói Pro miễn phí cho đến khi ưu đãi kết thúc.
Danh mục và tổng quan thanh toán dùng các giá trị
tier developer, team, business và enterprise. Phản hồi về mức sử dụng và gói đăng ký dùng free, pro và scale. Gói Business và Enterprise đều là scale.
Thời gian giữ dữ liệu
Thời gian giữ dữ liệu là số ngày LogBrew giữ telemetry của một tài khoản. Thời gian giữ dữ liệu của tài khoản là giá trị lớn hơn giữa gói và ưu đãi cho tài khoản mới đang hiệu lực. Hợp đồng Enterprise tự quy định thời gian giữ dữ liệu.- Thao tác đọc chỉ trả về telemetry nằm trong thời gian giữ dữ liệu.
- Mỗi ngày, LogBrew xóa telemetry của tài khoản cũ hơn thời gian giữ dữ liệu cộng thêm 1 ngày.
- Sau khi hạ gói hoặc khi ưu đãi kết thúc, thời gian giữ dữ liệu ngắn hơn áp dụng từ lần xóa hằng ngày tiếp theo.
Trạng thái sẵn sàng của gói đăng ký
GET /api/account/subscription là endpoint chỉ đọc. Dùng endpoint này để quyết định có bật các tùy chọn của tổ chức hay không. Dùng endpoint mức sử dụng để biết trạng thái hạn mức.
account_id là giá trị giả lập:
9007199254740991 trong members_per_organization và projects_per_organization nghĩa là không giới hạn. Đây là số nguyên lớn nhất mà ứng dụng khách JSON đọc chính xác. Hiển thị “Không giới hạn” cho giá trị này. Chỉ số tổ chức mà một tài khoản sở hữu mới có thể chặn việc tạo tổ chức.
next là văn bản để hiển thị. Hiển thị văn bản được trả về, hoặc bản địa hóa từ next_action. Không gán cứng tên gói từ next.
Giá trị enum:
API không trả về các lý do chặn
subscription_required và subscription_inactive. Mỗi lý do chặn có một cặp next_action:
Giá trị tier là ID, không phải tên hiển thị. Giữ nguyên các giá trị này trong client đã bản địa hóa. Kiểm tra
organization_creation_allowed trước khi bật tính năng tạo tổ chức.
Endpoint này không tạo tổ chức, không gửi lời mời, không đổi vai trò và không
thay đổi thông tin thanh toán.
Lời mời vào tổ chức
Chủ sở hữu hoặc quản trị viên của tổ chức mời đồng nghiệp qua email. LogBrew gửi cho đồng nghiệp một email có liên kết đến lời mời. Lời mời hết hạn sau 7 ngày. Các endpoint này hiển thị lời mời cho tài khoản được mời trước khi tài khoản đó chấp nhận. Một lời mời là của bạn khi được gửi đến địa chỉ email của tài khoản bạn hoặc của một phương thức đăng nhập đã liên kết với tài khoản bạn. Liệt kê các lời mời đang chờ của bạn:
Chỉ tài khoản được mời mới đọc được lời mời. Tài khoản khác, ID lời mời không xác định và tổ chức không xác định đều nhận cùng một
404 với code: "not_found". Đăng nhập bằng địa chỉ email được mời, rồi thử lại.
Để chấp nhận, gửi POST đến accept_path bằng tài khoản được mời. Cùng một tài khoản chấp nhận lần thứ hai sẽ nhận lại cùng tư cách thành viên. Lời mời đã hết hạn hoặc đã thu hồi trả về 422 với code: "invite_invalid". Nhờ chủ sở hữu hoặc quản trị viên gửi lời mời mới.
Một tài khoản gửi được tối đa 20 lời mời mỗi ngày UTC, tính trên tất cả tổ chức của tài khoản. Lời mời tiếp theo trả về 429 với code: "invitation_limit_exceeded" và limit: "invitations_per_inviter_per_day". Chờ đến reset_at. Xem Lỗi API.
Đăng xuất
Chọn phạm vi nhỏ nhất phù hợp với tác vụ. Các endpoint này không xóa tài khoản hoặc dự án, không xoay vòng khóa gửi dữ liệu và không thu hồi quyền mà nhà cung cấp đăng nhập bên thứ ba đã cấp.Một phiên đăng nhập trên ứng dụng hoặc CLI
Gửi yêu cầu từ client đang giữ refresh token. ĐặtContent-Type: application/json:
200:
200 như cũ. Nếu token không hợp
lệ, đã hết hạn hoặc là access token, phản hồi là 401 với
code: "unauthorized" và next_action.code: "authorize_request". Trong trường
hợp đó, cũng xóa thông tin xác thực cục bộ. logbrew logout dùng endpoint này.
Mọi phiên đăng nhập LogBrew
Phản hồi thành công là200:
revoked_before bao gồm cả chính mốc thời gian đó và có độ chính xác đến mili
giây. LogBrew từ chối access token, phiên trình duyệt và refresh token của lần
đăng nhập diễn ra vào hoặc trước thời điểm đó. Token được làm mới sau đó từ một
lần đăng nhập như vậy cũng bị từ chối. Các phiên luồng trực tiếp hiện tại kết
thúc, và phản hồi xóa cookie phiên trình duyệt. Lần đăng nhập sau thời điểm đó
vẫn hợp lệ. Mỗi client phải xóa thông tin xác thực LogBrew cục bộ và đăng nhập
lại.
Không tự động đăng nhập lại rồi lặp lại yêu cầu này. Yêu cầu mới cũng sẽ thu hồi
lần đăng nhập mới.
Nếu mất phản hồi, không báo rằng mọi phiên đăng nhập đã bị thu hồi. Lỗi 401
nhận sau đó từ một thông tin xác thực cũ không thay thế cho phản hồi thành công.
Để biết thêm các bước khôi phục, đọc
Bảo vệ tài khoản bị xâm nhập.
Phiên trình duyệt
POST /api/auth/web/logout xóa cookie logbrew_session của trình duyệt và trả
về 204 No Content không có body. Gọi endpoint này từ trình duyệt. Không sao
chép cookie phiên vào lệnh. Yêu cầu này không đăng xuất các client khác và không
thu hồi bản sao của giá trị cookie. Để thu hồi mọi phiên, dùng
Mọi phiên đăng nhập LogBrew.
Khôi phục sau lỗi đăng xuất
Để xem route, bộ lọc và phân trang telemetry, đọc
Telemetry API.
