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

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X.
Thông tin

Phiên bản 1.2.1

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:

  1. Trong IAM, hãy chỉ định quyền 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 đối với 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 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 GCP 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 cách sử dụng tài liệu tham khảo về cấu hình.

Giới thiệu về công cụ Ghi nhật ký Stackdriver

Stackdriver Logging là một phần trong bộ sản phẩm Stackdriver của Google Cloud Platform (GCP). Nền tảng này bao gồm bộ nhớ để lưu trữ nhật ký, một 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 Stackdriver Logging, 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ề Stackdriver Logging.

Mẫu

Các ví dụ sau đây minh hoạ cách định cấu hình chế độ hỗ trợ cho các thao tác của tiện ích Stackdriver Logging bằng cách sử dụng chính sách ExtensionCallout.

Nhật ký toàn cầu

Chính sách sau đây ghi thông báo "Đây là một quy trình kiểm thử" vào một nhật ký có tên là example-log trong tài nguyên Stackdriver Global. Trong thực tế, có thể bạn sẽ có thông báo nằm trong một biến luồng mà bạn đặt giá trị ở 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 một 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 một thông báo vào nhật ký.

Thao tác này sẽ ghi một mục 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 thông tin về các mục nhật ký, hãy xem phần Thông tin tham khảo về mục. Để 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ề Stackdriver Logging.

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ụ: Chuỗi

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

Ví dụ: JSON

<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

Tham 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ật ký.
Để biết thêm thông tin và các lựa chọn về cách đặt typelabels 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. Bạn có thể chỉ định một chuỗi đơn giản hoặc sử dụng JSON để ghi lại một thông báo có cấu trúc hơn. Chuỗi hoặc JSON 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 những thông tin 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 mở rộng chung

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ó
packageName Tên của gói tiện ích do Apigee Edge cung cấp. Không 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ó
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 thuộc tính cho gói tiện ích này

Chỉ định các 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 trên Google Cloud nơi nhật ký sẽ được tạo. 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ụ. Khi được gửi qua API quản lý, đây là giá trị được mã hoá base64 được tạo từ tệp khoá tài khoản dịch vụ. Không có. Có.