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 1.6.1

Ghi các mục vào nhật ký Cloud 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:

1. Trong IAM, hãy chỉ định vai trò Ghi nhật ký > Người ghi nhật ký cho thành viên dự án. Người này sẽ đại diện cho tiện ích của bạn vào hệ thống Ghi nhật ký trên đám mây. Để 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.

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 chứ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.

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

• Nếu là khách hàng của Apigee Edge dùng nền tảng đám mây công cộng, bạn phải liên hệ với Nhóm hỗ trợ Apigee để đả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 dành cho đám mây riêng tư, hãy sử dụng API Cập nhật thuộc tính của tổ chức để đặt cờ features.allowExtensionsInPostClientFlow thành true.

Giới thiệu về tính năng Ghi nhật ký trên đám mây

Tính năng Ghi nhật ký trên đám mây nằm trong bộ công cụ vận hành của Google Cloud. Bộ nhớ 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 Ghi nhật ký trên đám mây, 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 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 minh hoạ cách định cấu hình việc hỗ trợ các thao tác với tiện ích Ghi nhật ký trên đám mây bằng Chính sách Chú thích tiện ích.

Nhật ký chung

Chính sách sau đây ghi thông báo This is a test vào nhật ký có tên là example-log trong tài nguyên Cloud Global. Trong thực tế, bạn có thể sẽ thấy thông báo này 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>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 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 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

Viết 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ý Ghi nhật ký trên đám mây. Các 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ề Cloud Logging.

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

Thông số yêu cầu

Phản hồi

Giá trị là 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 về Gỡ lỗi tiện ích.

Tài liệu tham khảo về cấu hình

Sử dụng các đoạn mã sau khi bạn định cấu hình và triển khai tiện ích này để sử dụng trong các proxy API.

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.

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 dành riêng cho tiện ích này.