Tiện ích ghi nhật ký Google Stackdriver

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

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:

1. Trong IAM, hãy chỉ định quyền Ghi nhật ký > Người viết nhật ký và Ghi nhật ký > Vai trò Người xem nhật ký đối với 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 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 Bảng điều khiển của GCP để tạo khoá cho tài khoản dịch vụ.

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

Tiện ích này hỗ trợ việc gọi bằng chính sách ExtensionAnnotation có trong PostClientFlow. Nếu bạn muốn sử dụng Chính sách về chú thích tiện ích để 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 Public Cloud, 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à đối tác Apigee Edge cho khách hàng Private Cloud, 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ý 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.

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

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

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.

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.