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ý Ghi nhật ký Stackdriver.
Nội dung này cung cấp thông tin 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ừ một proxy API, bạn phải:
Trong IAM, hãy chỉ định quyền Logging > Logs Writer (Ghi nhật ký > Trình ghi nhật ký) cho thành viên dự án sẽ đại diện cho tiện ích của bạn trong hệ thống Ghi nhật ký Stackdriver. Để biết hướng dẫn về cách cấp vai trò, hãy xem bài viết 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 về 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 nội dung của tệp JSON khoá thu được khi thêm và định cấu hình tiện ích bằng tệp tham chiếu cấu hình.
Giới thiệu về tính năng Ghi nhật ký Stackdriver
Stackdriver Logging (Ghi nhật ký Stackdriver) là một phần của bộ sản phẩm Stackdriver trong Google Cloud Platform (GCP). Bộ công cụ này bao gồm bộ nhớ cho 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 phương thức 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ậ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 đang ghi các mục vào nhật ký.
Để biết thêm thông tin, hãy xem tài liệu về tính năng Ghi nhật ký Stackdriver.
Mẫu
Các ví dụ sau đây minh hoạ cách định cấu hình tính năng hỗ trợ cho các thao tác của tiện ích Ghi nhật ký Stackdriver bằng cách sử dụng chính sách ExtensionCallout.
Nhật ký toàn cục
Chính sách sau đây sẽ ghi thông báo "This is a test" (Đây là kiểm thử) vào nhật ký có tên example-log trong tài nguyên Toàn cầu của Stackdriver. Trong quá trình sử dụng thực tế, bạn có thể chứa thông báo trong một biến flow (luồng) có giá trị được đặ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 thông tin 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 tiện ích bằng bảng điều khiển Apigee, hãy xem phần Thêm và định cấu hình tiện ích.
Thao tác
log
Ghi thông báo vào nhật ký.
Thao tác này sẽ ghi một mục nhập nhật ký Stackdriver. Mục nhập nhật ký bao gồm siêu dữ liệu và dữ liệu mục nhập. Để biết thêm về các mục nhập nhật ký, hãy xem Tài liệu tham khảo về 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 về tính năng 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>
Tham số yêu cầu
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 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 tuỳ chọn về cách đặt type và labels trong metadata , hãy xem MonitoredResource. |
JSON | Không có. | STT |
tin nhắn | Dữ liệu để 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. Xem thêm bài viết Gỡ lỗi tiện ích.
Tài liệu tham khảo về cấu hình
Hãy sử dụng nội dung sau đây 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 mở rộng 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ó |
Thuộc tính cho gói tiện ích này
Chỉ định giá trị cho các thuộc tính cấu hình sau đây dành riêng cho tiện ích này.
Thuộc tính | Mô tả | Mặc định | Bắt buộc |
---|---|---|---|
projectId | Mã dự án GCP nơi tạo nhật ký. | Không có. | Có. |
thông tin xác thực | Khi 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ụ. Khi được gửi qua API quản lý, đâ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ó. |