Tiện ích ghi nhật ký của Google Cloud

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 2.0.0

Ghi các mục vào nhật ký Cloud Logging.

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:

1. Trong IAM, hãy chỉ định vai trò Logging > Logs Writer (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 Cloud Logging. Để 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.

2. Sử dụng Google Cloud Console để tạo khoá cho tài khoản dịch vụ.

3. 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.

Tiện ích này hỗ trợ việc được gọi bằng chính sách ExtensionCallout nằm trong PostClientFlow. Nếu bạn muốn sử dụng chính sách ExtensionCallout để gọi tiện ích này từ PostClientFlow, hãy đảm bảo rằng cờ features.allowExtensionsInPostClientFlow được đặt thành true trong tổ chức của bạn.

• Nếu là khách hàng của Apigee Edge cho đám mây công khai, bạn phải liên hệ với Nhóm hỗ trợ Apigee Edge để đảm bảo rằng cờ features.allowExtensionsInPostClientFlow được đặt thành true trong tổ chức của bạn.

• Nếu bạn là khách hàng của Apigee Edge cho Private Cloud, hãy sử dụng API Cập nhật thuộc tính tổ chức để đặt cờ features.allowExtensionsInPostClientFlow thành true.

Giới thiệu về Cloud Logging

Cloud Logging là một phần của bộ công cụ hoạt động của Google Cloud. 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 khám phá 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 Nhật ký trên đám mây, 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 Cloud Logging (Ghi nhật ký trên đám mâ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ý trên đám mây.

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ý trên đám mây 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 vào nhật ký có tên example-log trong tài nguyên Cloud Global. Trong quá trình sử dụng thực tế, bạn có thể đặt 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>cloud-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ật ký trong Cloud Logging. 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 nội dung Tham khảo 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ý trên đám mây.

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "cloud-log-name-to-use",
  "metadata" : JSON-structured-metadata,
  "message" : "data-to-log-as-entry"
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message": "This is a test."
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : { "info" :  "This is a test." }
}]]></Input>

Tham số yêu cầu

Phản hồi

None 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.

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.