Dự án, dịch vụ, môi trường
Thiết lập dự án
Cài đặt CLI. Chạylogbrew status --json để đọc quyền truy cập
của tài khoản. Nếu quyền truy cập không hợp lệ, một người phải tự chạy
logbrew login. Không thể đăng nhập bằng khóa gửi dữ liệu của dự án.
1
Tạo hoặc chọn dự án
Liệt kê các dự án của bạn trước. Chỉ tạo dự án khi dự án đó chưa tồn tại.CLI ghi khóa gửi dữ liệu vào một tệp mới mà chỉ chủ sở hữu truy cập được.
CLI không bao giờ in khóa hay đường dẫn tệp. Nếu kết quả không rõ ràng,
chạy lại đúng lệnh đó. Đừng đổi tên dự án hoặc tệp khóa. CLI sẽ dùng lại
định danh của yêu cầu đang chờ. Trang Bắt đầu nhanh chỉ
cách đọc ID dự án từ kết quả.Với dự án đã có, ghi lại trạng thái thiết lập:Để tạo thêm khóa gửi dữ liệu cho dự án đã có, dùng
logbrew projects keys create.
Hướng dẫn Xoay vòng khóa gửi dữ liệu có
ví dụ cho lệnh này.logbrew setup --create-project chỉ hiển thị trợ giúp. Lệnh này không tạo
dự án.2
Đặt tên dịch vụ trong SDK
Dùng tên lấy từ repository và cấu hình triển khai của bạn, chẳng hạn
api, worker, web, ios hoặc checkout-api. Tên dịch vụ là một nhãn,
không dùng để chọn dự án. Dự án do khóa gửi dữ liệu quyết định. Đổi tên
dịch vụ không chuyển các sự kiện đã lưu. Nếu không tìm thấy sự kiện, kiểm
tra dự án và khóa gửi dữ liệu mà ứng dụng đang dùng trước khi tạo dự án
khác.3
Dùng môi trường chuẩn
Dùng
production, staging, preview và local. Nếu hệ thống triển khai
của bạn dùng tên khác, dùng các tên đó một cách nhất quán. Tên môi trường
không được chứa dấu cách, / hoặc dấu gạch chéo ngược.4
Gửi sự kiện thử và đọc lại
Cấu hình SDK bằng khóa gửi dữ liệu của dự án, theo hướng
dẫn Tích hợp SDK. Tạo dự án
không tự cài SDK vào ứng dụng của bạn. Không đưa khóa vào hệ thống quản lý
mã nguồn. Đặt dịch vụ, môi trường và bản phát hành trong ứng dụng. Gửi một
sự kiện an toàn, rồi đọc lại:Mỗi loại tín hiệu có danh sách riêng. Danh sách log trống không có nghĩa là
dự án không có vấn đề hay trace nào.Trong bảng điều khiển, chọn cùng dự án đó và một khoảng thời gian có chứa
sự kiện thử. Đảm bảo bộ lọc dịch vụ, môi trường và bản phát hành khớp với
sự kiện.
Chẩn đoán thiết lập dự án
Đọc trạng thái thiết lập bằng project doctor (công cụ chẩn đoán dự án). Đừng suy ra trạng thái thiết lập từ tệp cục bộ hoặc từ một truy vấn log trống.status, checks và next. Mã thoát 0 không cho
thấy mọi bước kiểm tra đều đạt. Đọc từng mục trong checks. Xem
Đọc báo cáo doctor của dự án.
Phản hồi trực tiếp từ API
Client API gọiGET /api/projects/{project_id}/doctor bằng xác thực tài khoản.
Endpoint này không có tham số truy vấn hay body của yêu cầu. Không bao giờ dùng
khóa gửi dữ liệu của dự án cho lần đọc này.
Phản hồi 200 có các trường sau: project_id, state, setup_status,
setup_acknowledged, has_active_ingest_key, first_telemetry_seen_at,
last_seen_at, last_signal, next và next_action. Dấu thời gian có định
dạng RFC3339 hoặc là null. last_signal là bản tóm tắt an toàn để hiển thị,
không phải tín hiệu thô.
Doctor kiểm tra khóa gửi dữ liệu trước tiên. Dự án không có khóa gửi dữ liệu
nào đang hoạt động sẽ ở trạng thái
needs_ingest_key, bất kể trạng thái thiết
lập là gì.
setup_status là created, setup_started, sdk_seen,
first_telemetry_seen hoặc active. setup_acknowledged chỉ là true với 3
giá trị cuối. created cho ra needs_setup. setup_started và sdk_seen cho
ra needs_telemetry. first_telemetry_seen và active cho ra ready.
Nếu vẫn không đọc được, báo cáo sự cố. Không đưa
thông tin xác thực, header, nội dung tín hiệu, dữ liệu khách hàng, đường dẫn cục
bộ hoặc mã nguồn vào báo cáo.
Lưu trữ hoặc xóa dự án
Lưu trữ dự án để đưa nó ra khỏi danh sách dự án đang hoạt động:--yes. Sau khi lưu trữ, các khóa gửi dữ liệu của dự án ngừng
nhận telemetry mới. Route API là DELETE /api/projects/{project_id}. Route này
trả về 204 không kèm body. Liệt kê các dự án đã lưu trữ bằng
GET /api/projects/archived. Khôi phục một dự án bằng
POST /api/projects/{project_id}/restore, route này cũng trả về 204.
Chỉ xóa vĩnh viễn dự án khi bạn chắc chắn:
--confirm. Khi yêu cầu được chấp nhận, dự án
ngừng hoạt động ngay lập tức và được lên lịch xóa vĩnh viễn. Sau đó bạn không
thể khôi phục dự án.