Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến
Tài liệu về Apigee X. thông tin
Phiên bản 1.2.0
Ghi các mục vào nhật ký Stackdriver Logging.
Nội dung này cung cấp tài liệu tham khảo để định cấu hình và sử dụng tiện ích này.
Điều kiện tiên quyết
Trước khi sử dụng tiện ích này từ proxy API, bạn phải:
Trong IAM, hãy chỉ định Nhật ký > Quyền Người ghi nhật ký cho thành viên dự án. Quyền này sẽ đại diện cho tiện ích của bạn cho hệ thống Ghi nhật ký Stackdriver. Để biết hướng dẫn về cách cấp vai trò, hãy xem phần Cấp vai trò cho tài khoản dịch vụ đối với các tài nguyên cụ thể. Để biết thêm thông tin về các vai trò ghi nhật ký, hãy xem Hướng dẫn kiểm soát quyền truy cập.
Sử dụng Bảng điều khiển của GCP để tạo khoá cho tài khoản dịch vụ.
Sử dụng nội dung của tệp JSON của khoá thu được khi thêm và định cấu hình tiện ích bằng cách sử dụng tài liệu tham khảo về cấu hình.
Giới thiệu về tính năng Ghi nhật ký Stackdriver
Stackdriver Logging là một phần trong bộ sản phẩm Stackdriver trong Google Cloud Platform (GCP). Phiên bản này bao gồm bộ nhớ lưu trữ nhật ký, giao diện người dùng có tên là Trình xem nhật ký và một API để quản lý nhật ký theo cách lập trình. Với tính năng Ghi nhật ký Stackdriver, bạn có thể đọc và ghi các mục nhập nhật ký, tìm kiếm và lọc nhật ký, xuất nhật ký và tạo các chỉ số dựa trên nhật ký.
Tiện ích này hiện ghi các mục nhập vào nhật ký.
Để biết thêm thông tin, hãy xem tài liệu về Ghi nhật ký Stackdriver.
Mẫu
Các ví dụ sau minh hoạ cách định cấu hình tính năng hỗ trợ cho các thao tác sử dụng tiện ích Ghi nhật ký Stackdriver bằng chính sách ExtensionAnnotation.
Nhật ký chung
Chính sách sau đây sẽ ghi thông báo "Đây là một thử nghiệm" vào nhật ký có tên example-log trong tài nguyên Stackdriver Global. Trong thực tế, thông báo có thể nằm trong một biến luồng có giá trị mà bạn đã đặt ở nơi khác trong proxy API.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
<DisplayName>Logging Connector</DisplayName>
<Connector>stackdriver-extension-sample</Connector>
<Action>log</Action>
<Input><![CDATA[{
"logName": "example-log",
"metadata": {
"resource": {
"type": "global",
"labels": {
"project_id": "my-test"
}
}
},
"message": "This is a test"
}]]></Input>
</ConnectorCallout>
Nội dung này cung cấp tài liệu tham khảo để định cấu hình và sử dụng tiện ích này. Để biết các bước định cấu hình một tiện ích bằng bảng điều khiển Apigee, hãy xem bài viết Thêm và định cấu hình tiện ích.
Thao tác
log
Ghi một thông điệp vào nhật ký.
Thao tác này sẽ ghi một mục nhập nhật ký Stackdriver. Các mục trong nhật ký bao gồm siêu dữ liệu và dữ liệu nhập. Để biết thêm thông tin về các mục nhập nhật ký, hãy xem Tài liệu tham khảo cho mục nhập. Để biết thông tin về nội dung của thuộc tính metadata
, hãy xem đối tượng LogEntry trong tài liệu Ghi nhật ký Stackdriver.
Cú pháp
<Action>log</Action>
<Input><![CDATA[{
"logName" : "stackdriver-log-name-to-use",
"metadata" : JSON-structured-metadata,
"message" : "data-to-log-as-entry"
}]]></Input>
Ví dụ:
<Action>log</Action>
<Input><![CDATA[{
"logName" : "stackdriver-log-name-to-use",
"metadata" : { "resource" : { "type" : "global" } },
"message" : "data-to-log-as-entry"
}]]></Input>
Yêu cầu thông số
Thông số | Mô tả | Loại | Mặc định | Bắt buộc |
---|---|---|---|---|
logName | Tên của nhật ký chứa mục nhập này. | Chuỗi | Không có. | Có. |
siêu dữ liệu | Siêu dữ liệu về mục nhập nhật ký. Để biết thêm thông tin và các lựa chọn về cách cài đặt type và labels trong metadata , hãy xem phần MonitoredResource. |
JSON | Không có. | STT |
tin nhắn | Dữ liệu được sử dụng làm giá trị cho mục nhập nhật ký này. | Chuỗi | Không có. | Có. |
Phản hồi
Không có nếu thông báo được ghi vào nhật ký. Nếu không, yêu cầu sẽ trả về lỗi. Hãy xem thêm bài viết Gỡ lỗi tiện ích.
Tham chiếu cấu hình
Sử dụng mã sau khi bạn định cấu hình và triển khai tiện ích này để sử dụng trong proxy API.
Các thuộc tính tiện ích phổ biến
Các thuộc tính sau có sẵn cho mỗi tiện ích.
Tài sản | Mô tả | Mặc định | Bắt buộc |
---|---|---|---|
name |
Tên mà bạn đang đặt cho cấu hình của tiện ích này. | Không có | Có |
packageName |
Tên của gói tiện ích do Apigee Edge cung cấp. | Không có | Có |
version |
Số phiên bản của gói tiện ích mà bạn đang định cấu hình tiện ích. | Không có | Có |
configuration |
Giá trị cấu hình cụ thể cho tiện ích bạn đang thêm. Xem Thuộc tính cho gói tiện ích này | Không có | Có |
Các thuộc tính của gói tiện ích này
Chỉ định giá trị cho các thuộc tính cấu hình sau dành riêng cho tiện ích này.
Thuộc tính | Mô tả | Mặc định | Bắt buộc |
---|---|---|---|
mã dự án | Mã dự án GCP nơi bạn tạo nhật ký. | Không có. | Có. |
thông tin xác thực | Khi được nhập vào bảng điều khiển Apigee Edge, đây là nội dung của tệp khoá tài khoản dịch vụ của bạn. Khi được gửi qua API quản lý, giá trị này là một giá trị được mã hoá base64 được tạo từ tệp khoá tài khoản dịch vụ. | Không có. | Có. |