Chính sách Ghi nhật ký tin nhắn

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X.
thông tin

Nội dung

Một trong những cách tốt nhất để theo dõi sự cố trong môi trường thời gian chạy API là ghi nhật ký thông điệp. Bạn có thể đính kèm và định cấu hình chính sách MessageLogging trên API của mình để ghi nhật ký các thông điệp tuỳ chỉnh vào ổ đĩa cục bộ (chỉ dành cho Edge cho Đám mây riêng tư) hoặc vào nhật ký hệ thống.

Mẫu

Nhật ký hệ thống

<MessageLogging name="LogToSyslog">
  <Syslog>
    <Message>[3f509b58 tag="{organization.name}.{apiproxy.name}.{environment.name}"] Weather request for WOEID {request.queryparam.w}.</Message>
    <Host>logs-01.loggly.com</Host>
    <Port>514</Port>
    <Protocol>TCP</Protocol>
    <FormatMessage>true</FormatMessage>
    <DateFormat>yyyy-MM-dd'T'HH:mm:ss.SSSZ</DateFormat>
  </Syslog>
  <logLevel>ALERT</logLevel>
</MessageLogging>

Một cách sử dụng phổ biến của loại chính sách MessageLogging là đăng nhập vào tài khoản nhật ký hệ thống. Khi được định cấu hình cho nhật ký hệ thống, một proxy API sẽ chuyển tiếp thông điệp nhật ký từ Apigee Edge đến một máy chủ nhật ký hệ thống từ xa. Bạn phải có sẵn một máy chủ hỗ trợ ghi nhật ký hệ thống. Nếu không, bạn có thể sử dụng các dịch vụ quản lý nhật ký công khai như Splunk, Sumo Logic và Loggly. Hãy xem phần Định cấu hình dịch vụ quản lý nhật ký của bên thứ ba.

Ví dụ: giả sử bạn cần ghi lại thông tin về từng thông báo yêu cầu mà API của bạn nhận được từ ứng dụng người dùng. Giá trị 3f509b58 biểu thị giá trị khoá dành riêng cho dịch vụ loggly. Nếu bạn có tài khoản loggly, hãy thay thế khoá loggly. Thông điệp nhật ký được tạo sẽ được điền sẵn bằng 4 giá trị: tổ chức, proxy API và tên môi trường liên kết với giao dịch, cùng với giá trị của tham số truy vấn trên thông báo yêu cầu.

Nếu triển khai Edge để triển khai Đám mây riêng tư, bạn cũng có thể ghi thông điệp nhật ký vào một tệp.

Nhật ký hệ thống qua TLS/SSL

<MessageLogging name="LogToSyslog">
  <Syslog>
    <Message>[3f509b58 tag="{organization.name}.{apiproxy.name}.{environment.name}"] Weather request for WOEID {request.queryparam.w}.</Message>
    <Host>logs-01.loggly.com</Host>
    <Port>6514</Port>
    <Protocol>TCP</Protocol>
    <FormatMessage>true</FormatMessage>
    <SSLInfo>
        <Enabled>true</Enabled>
    </SSLInfo>
    <DateFormat>yyMMdd-HH:mm:ss.SSS</DateFormat>
  </Syslog>
  <logLevel>WARN</logLevel>
</MessageLogging>

Bạn có thể gửi thông báo đến nhà cung cấp tính năng ghi nhật ký thông báo bên thứ ba qua TLS/SSL bằng cách thêm khối <SSLInfo>.

Xoay tệp: kích thước

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
      <FileName>test.log</FileName>
      <FileRotationOptions rotateFileOnStartup="true">
        <FileRotationType>SIZE</FileRotationType>
        <MaxFileSizeInMB>10</MaxFileSizeInMB>
        <MaxFilesToRetain>10</MaxFilesToRetain>
      </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

Xoay tệp dựa trên kích thước tệp.

Xoay tệp: thời gian

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
    <FileName>test.log</FileName>
    <FileRotationOptions rotateFileOnStartup="true">
      <FileRotationType>TIME</FileRotationType>
      <RotationFrequency unit="minute">10</RotationFrequency>
      <MaxFilesToRetain>10</MaxFilesToRetain>
    </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

Xoay tệp dựa trên thời gian.

Xoay tệp: thời gian và kích thước

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
    <FileName>test.log</FileName>
    <FileRotationOptions rotateFileOnStartup="true">
      <FileRotationType>TIME_SIZE</FileRotationType>
      <MaxFileSizeInMB>10</MaxFileSizeInMB>
      <MaxFilesToRetain>10</MaxFilesToRetain>
      <RotationFrequency unit="minute">10</RotationFrequency>
    </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

Xoay tệp dựa trên thời gian và kích thước.

Hỗ trợ phát trực tiếp

<MessageLogging name="LogPolicy">
  <File>
  ....
  ....
  </File>
  <BufferMessage>true</BufferMessage>
</MessageLogging>

Ghi nhật ký tin nhắn có bật tính năng phát trực tiếp


Tham chiếu phần tử

Dùng các phần tử sau để định cấu hình loại chính sách MessageLogging.

Tên trường Mô tả trường

File

Đích tệp cục bộ. (Tính năng ghi nhật ký tệp chỉ được hỗ trợ trong Edge cho việc triển khai Đám mây riêng tư.) Để biết thông tin về nơi lưu trữ các tệp, hãy xem bài viết Ghi nhật ký vị trí tệp trong Edge dành cho đám mây riêng tư.

Message Tạo thông điệp sẽ được gửi đến tệp nhật ký, kết hợp văn bản với các biến để thu thập thông tin bạn muốn. Xem phần Ứng dụng mẫu.
FileName Tên của tệp nhật ký nơi thông báo được ghi lại.
FileRotationOptions
rotateFileOnStartup

Thuộc tính. Giá trị hợp lệ: true/false

Nếu bạn đặt chính sách này thành true (đúng), thì tệp nhật ký sẽ được xoay mỗi khi công cụ nhắn tin khởi động lại.

FileRotationType Chỉ định chính sách xoay (size hoặc time) của tệp nhật ký.
MaxFileSizeInMB (Khi chọn size làm loại xoay) Chỉ định kích thước của tệp nhật ký kích hoạt máy chủ di chuyển thông điệp nhật ký sang một tệp riêng. Sau khi tệp nhật ký đạt đến kích thước đã chỉ định, máy chủ sẽ đổi tên tệp nhật ký hiện tại.
RotationFrequency (Khi chọn time làm loại xoay) Chỉ định thời gian tính bằng phút để kích hoạt máy chủ di chuyển thông điệp nhật ký sang một tệp riêng. Sau khi hết khoảng thời gian được chỉ định, tệp nhật ký hiện tại sẽ được đổi tên.
MaxFilesToRetain

Chỉ định số lượng tệp tối đa cần được giữ lại theo chế độ cài đặt xoay vòng. Giá trị mặc định là 8.

Nếu bạn chỉ định số không (0), các tệp nhật ký sẽ được giữ lại vô thời hạn, nhưng tuân theo chế độ cài đặt xoay tệp, mặc dù không có tệp nào bị xoá hoặc đổi tên. Do đó, để tránh lỗi toàn bộ ổ đĩa trong tương lai, hãy đặt giá trị này thành một giá trị lớn hơn 0 hoặc triển khai một hệ thống tự động thông thường dùng để xoá hoặc lưu trữ các tệp nhật ký được giữ lại cũ.

BufferMessage

Nếu bạn bật chế độ truyền trực tuyến HTTP cho proxy của mình, thì các thông báo yêu cầu/phản hồi sẽ không được lưu vào vùng đệm. Nếu bạn muốn ghi nhật ký nội dung yêu cầu phân tích cú pháp thông điệp luồng, hãy đặt BufferMessage thành true. Hãy xem thẻ mẫu "Đã bật luồng" để biết ví dụ. Mặc định: false

Syslog

Đích đến nhật ký hệ thống. Để gửi nhật ký hệ thống tới Splunk, Sumo Logic hoặc Loggly, hãy xem phần Định cấu hình các dịch vụ quản lý nhật ký của bên thứ ba.

Message

Tạo thông báo gửi đến nhật ký hệ thống, kết hợp văn bản với các biến để thu thập thông tin bạn muốn. Xem phần Ứng dụng mẫu.

Lưu ý: Biến phản hồi sẽ không có trong PostClientFlow theo Luồng lỗi. Sử dụng các biến thông báo để ghi lại thông tin phản hồi cho cả trường hợp lỗi và trường hợp thành công. Hãy xem thêm phần Ghi chú sử dụng.

Host Tên máy chủ hoặc địa chỉ IP của máy chủ nơi sẽ gửi nhật ký hệ thống. Nếu bạn không thêm phần tử này, giá trị mặc định sẽ là localhost.
Port Cổng nơi nhật ký hệ thống đang chạy. Nếu bạn không thêm phần tử này, giá trị mặc định sẽ là 514.
Protocol TCP hoặc UDP (mặc định). Mặc dù UDP có hiệu suất cao hơn, nhưng giao thức TCP vẫn đảm bảo việc phân phối nhật ký thông báo đến máy chủ hỗ trợ ghi nhật ký hệ thống. Để gửi thông báo nhật ký hệ thống qua TLS/SSL, chỉ TCP mới được hỗ trợ.
FormatMessage

true hoặc false (mặc định)

Không bắt buộc, nhưng cần phải có <FormatMessage>true</FormatMessage> để sử dụng với Loggly.

Phần tử này cho phép bạn kiểm soát định dạng của nội dung do Apigee tạo ra trước tin nhắn. Nếu bạn đặt chính sách này thành true (đúng), thì thông báo nhật ký hệ thống sẽ được thêm vào trước một số lượng ký tự cố định, nhờ đó, bạn có thể lọc ra thông tin đó khỏi các thông báo. Dưới đây là ví dụ về định dạng cố định:

<14>1 2023-03-20T09:24:39.039+0000 e49cd3a9-4cf6-48a7-abb9-7ftfe4d97d00 Apigee-Edge - - - Message starts here

Thông tin do Apigee tạo ra bao gồm:

  • <14> – Điểm số ưu tiên (xem Giao thức nhật ký hệ thống) dựa trên cấp độ nhật ký và cấp cơ sở của thông báo.
  • 1 – Phiên bản nhật ký hệ thống hiện tại.
  • Ngày có số giờ chênh lệch so với giờ UTC (UTC = +0000).
  • Mã nhận dạng duy nhất (UUID) của trình xử lý thư.
  • "Apigee-Edge – - – "

Nếu bạn đặt chính sách này thành false (mặc định), thì những ký tự cố định đó sẽ không được thêm vào trước thông báo.

PayloadOnly

true hoặc false (mặc định)

Phần tử này thiết lập định dạng của thông báo do Apigee tạo bằng cách chỉ chứa phần nội dung của thông báo nhật ký hệ thống mà không chứa các ký tự thêm vào đầu do FormatMessage chỉ định.

Nếu bạn không thêm phần tử này hoặc để trống, giá trị mặc định sẽ là false.

Xem FormatMessage.

DateFormat

Không bắt buộc.

Chuỗi mẫu định dạng dùng để định dạng dấu thời gian cho từng thông điệp nhật ký. Theo mặc định, Apigee sử dụng yyyy-MM-dd'T'HH:mm:ss.SSSZ. Hành vi của mẫu này được mô tả trong tài liệu về lớp SimpleDateFormat của Java.

SSLInfo

Cho phép bạn ghi nhật ký thông điệp thông qua SSL/TLS. Sử dụng với phần tử phụ <Enabled>true</Enabled>.

Nếu bạn không bao gồm phần tử này hoặc để trống phần tử, thì giá trị mặc định sẽ là false (không có TLS/SSL).

<SSLInfo>
    <Enabled>true</Enabled>
</SSLInfo>

Bạn có thể định cấu hình thẻ <SSLInfo> tương tự như trên TargetEndpoint, bao gồm cả việc bật TLS/SSL hai chiều, như được mô tả trong Tài liệu tham khảo cấu hình proxy API. Chỉ hỗ trợ giao thức TCP.

logLevel

Không bắt buộc.

Giá trị hợp lệ: INFO (mặc định), ALERT, WARN, ERROR

Thiết lập một mức độ thông tin cụ thể cần đưa vào nhật ký thông báo.

Nếu bạn đang sử dụng phần tử FormatMessage (đặt thành đúng), thì chế độ cài đặt logLevel sẽ ảnh hưởng đến điểm ưu tiên đã tính toán (số bên trong dấu ngoặc nhọn) trong thông tin do Apigee tạo ở phía trước thông báo.

Giản đồ


Ghi chú sử dụng

Khi đính kèm một chính sách MessageLogging vào một luồng proxy API, hãy cân nhắc việc đặt chính sách đó vào phản hồi ProxyEndpoint, trong một quy trình đặc biệt có tên là PostClientFlow. PostClientFlow sẽ thực thi sau khi phản hồi được gửi đến ứng dụng yêu cầu. Việc này đảm bảo rằng tất cả các chỉ số đều có sẵn để ghi nhật ký. Để biết thông tin chi tiết về cách sử dụng PostClientFlow, hãy xem Tài liệu tham khảo về cấu hình proxy API.

PostClientFlow đặc biệt theo hai cách:

  1. Thao tác này chỉ được thực thi trong luồng phản hồi.
  2. Đây là luồng duy nhất được thực thi sau khi proxy chuyển sang trạng thái lỗi.

Vì chính sách này được thực thi bất kể proxy thành công hay không thành công, nên bạn có thể đặt các chính sách MessageLogging vào PostClientFlow và đảm bảo rằng chúng luôn thực thi.

Hình ảnh Theo dõi sau đây cho thấy một chính sách MessageLogging thực thi như một phần của PostClientFlow, sau khi DefaultFaultRule thực thi:

Trong ví dụ này, chính sách Xác minh khoá API đã gây ra lỗi do khoá không hợp lệ.

Dưới đây là định nghĩa ProxyEndpoint bao gồm PostClientFlow:

<ProxyEndpoint name="default">
  ...
  <PostClientFlow>
    <Response>
      <Step>
        <Name>Message-Logging-1</Name>
      </Step>
    </Response>
  </PostClientFlow>
  ...
</ProxyEndpoint>

Edge ghi lại thông điệp dưới dạng văn bản đơn giản và bạn có thể định cấu hình nhật ký để bao gồm các biến, chẳng hạn như ngày và giờ nhận được yêu cầu hoặc phản hồi, danh tính người dùng trong yêu cầu, địa chỉ IP nguồn nơi yêu cầu được gửi đi, v.v. Edge ghi lại thông điệp không đồng bộ, nghĩa là không có độ trễ nào có thể gây ra do việc chặn chú thích được đưa vào API của bạn.

Chính sách MessageLogging ghi thông điệp đã ghi nhật ký trong bộ nhớ vào vùng đệm. Trình ghi nhật ký thông báo sẽ đọc thông điệp từ vùng đệm rồi ghi vào đích đến mà bạn định cấu hình. Mỗi đích đến có vùng đệm riêng.

Nếu tốc độ ghi vào vùng đệm tăng vượt quá tốc độ đọc, thì vùng đệm sẽ bị tràn và ghi nhật ký sẽ không thành công. Nếu việc này xảy ra, bạn có thể thấy một thông báo chứa nội dung sau trong tệp nhật ký:

Log message size exceeded. Increase the max message size setting

Nếu bạn gặp sự cố này trong Edge dành cho đám mây riêng tư 4.15.07 trở xuống, hãy tìm tệp message-logging.properties và dùng giải pháp sau:

Tăng thuộc tính max.log.message.size.in.kb (giá trị mặc định = 128 KB) trong tệp message-logging.properties.

Đối với Edge dành cho đám mây riêng tư 4.16.01 trở lên, hãy thiết lập thuộc tính conf_message-logging_max.log.message.size.in.kb trong tệp /opt/apigee/customer/application/message-processor.properties rồi khởi động lại Trình xử lý tin nhắn.

Lưu ý: Các biến thông báo phản hồi trong Edge không có trong Luồng lỗi. Các biến này cũng không có trong PostClientFlow nếu quy trình trước đó là Luồng lỗi. Nếu bạn muốn ghi nhật ký thông tin phản hồi từ PostClientFlow, hãy sử dụng đối tượng message (thông báo). Bạn có thể sử dụng đối tượng này để lấy tiêu đề và các thông tin khác từ phản hồi, bất kể có lỗi hay không. Hãy xem phần Biến thông báo để biết thêm thông tin và ví dụ.

Kiểm soát dấu thời gian của thông điệp nhật ký trong Edge dành cho đám mây riêng tư

Theo mặc định, dấu thời gian trong tất cả thông điệp nhật ký có định dạng:

yyyy-MM-dd'T'HH:mm:ss.SSSZ

Bạn có thể ghi đè giá trị mặc định trên toàn hệ thống này cho các đích đến nhật ký hệ thống bằng cách sử dụng phần tử DateFormat. Hành vi của mẫu này được mô tả trong tài liệu về lớp SimpleDateFormat của Java. Theo định nghĩa đó, yyyy sẽ được thay thế bằng một năm gồm 4 chữ số, MM sẽ được thay thế bằng một số tháng gồm 2 chữ số, v.v. Định dạng trên có thể dẫn đến một chuỗi dạng sau:

2022-09-28T22:38:11.721+0000

Bạn có thể sử dụng thuộc tính conf_system_apigee.syslogger.dateFormat trên Trình xử lý thông báo Edge để kiểm soát định dạng đó. Ví dụ: thay đổi định dạng thông báo thành:

yy/MM/dd'T'HH:mm:ss.SSSZ

..thay thế dấu gạch ngang bằng dấu gạch chéo và rút ngắn thành năm có 2 chữ số, ghi lại dấu thời gian vào biểu mẫu:

22/09/28T22:38:11.721+0000

Cách thay đổi định dạng:

  1. Mở tệp message-processor.properties trong trình chỉnh sửa. Nếu tệp không tồn tại, hãy tạo tệp:
    > vi /opt/apigee/customer/application/message-processor.properties
  2. Đặt các thuộc tính như mong muốn:
    conf_system_apigee.syslogger.dateFormat=yy/MM/dd'T'HH:mm:ss.SSSZ
  3. Lưu các thay đổi.
  4. Đảm bảo tệp thuộc tính thuộc sở hữu của người dùng "apigee":
    > chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
  5. Khởi động lại Trình xử lý tin nhắn Edge:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-message-processor khởi động lại

Vị trí tệp ghi nhật ký trong Edge dành cho đám mây riêng tư

Edge dành cho đám mây riêng tư 4.16.01 trở lên

Theo mặc định, nhật ký thông báo riêng trên Đám mây riêng tư nằm trong thư mục sau trên các nút Trình xử lý thông báo:

/opt/apigee/var/log/edge-message-processor/messagelogging/org_name/environment/api_proxy_name/revision/logging_policy_name/

Bạn có thể thay đổi vị trí nhật ký mặc định bằng cách sửa đổi các thuộc tính trong tệp message-logging.properties trên Bộ xử lý thông báo:

  • bin_setenv_data_dir – Thiết lập đường dẫn gốc cho bộ nhớ tệp nhật ký. Ví dụ: bin_setenv_data_dir=/opt/apigee/var/log
  • conf_message-logging_log.root.dir – Nếu bạn thiết lập đường dẫn này thành một đường dẫn tương đối, chẳng hạn như conf/message-logging.properties+log.root.dir=custom/folder/, the path is appended to the bin_setenv_data_dir location.

    sẽ được lưu trữ trong /opt/apigee/var/log/messages/messagelog/ nếu bạn thiết lập đường dẫn này thành một đường dẫn tuyệt đối, chẳng hạn như conf/message-logging.properties+log.root.dir=/opt/apigee/var/log/messages. Đường dẫn tuyệt đối sẽ được ưu tiên hơn bin_setenv_data_dir.

    Xin lưu ý rằng bạn phải tham chiếu thuộc tính dưới dạng conf/message-logging.properties+log.root.dir vì thuộc tính này được nhận xét theo mặc định. Hãy xem phần Đặt mã thông báo đang được nhận xét để biết thêm thông tin.

Nếu bạn muốn lưu trữ các tệp nhật ký trong một cấu trúc tệp phẳng để tất cả các tệp nhật ký đều được đặt trong cùng một thư mục, hãy đặt giá trị của conf/message-logging.properties+enable.flat.directory.structure thành true trong tệp message-logging.properties. Thông báo được lưu trữ trong thư mục do các thuộc tính ở trên chỉ định và tên tệp có dạng {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename}.

Cách đặt các thuộc tính này:

  1. Mở tệp message-processor.properties trong trình chỉnh sửa. Nếu tệp không tồn tại, hãy tạo tệp:
    > vi /opt/apigee/customer/application/message-processor.properties
  2. Đặt các thuộc tính theo ý muốn:
    conf/message-logging.properties+log.root.dir=/opt/apigee/var/log/messages
  3. Lưu các thay đổi.
  4. Đảm bảo tệp thuộc tính thuộc sở hữu của người dùng "apigee":
    > chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
  5. Khởi động lại thành phần Edge:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-message-processor khởi động lại

Edge dành cho đám mây riêng tư 4.15.07 trở xuống

Theo mặc định, nhật ký thông báo nằm ở vị trí sau trên trình xử lý thông báo:

/opt/apigee4/var/log/apigee/message-processor/messagelog/{org}/{environment}/{api_proxy_name}/{revision}/{logging_policy_name}/

Bạn có thể thay đổi vị trí mặc định của nhật ký bằng cách sửa đổi các thuộc tính sau trong tệp message-logging.properties trên trình xử lý thông báo:

  • data.dir – Thiết lập đường dẫn gốc cho bộ nhớ tệp nhật ký. Ví dụ: data.dir=/opt/apigee4/var/log
  • log.root.dir – Nếu bạn thiết lập đường dẫn này thành một đường dẫn tương đối, chẳng hạn như log.root.dir=custom/folder/, thì đường dẫn này sẽ được thêm vào vị trí data.dir.

Ví dụ: việc kết hợp 2 thuộc tính sẽ đặt thư mục ghi nhật ký tại /opt/apigee4/var/log/custom/folder/messagelog/ (lưu ý rằng /messagelog được thêm tự động).

Nếu bạn đặt giá trị này thành một đường dẫn tuyệt đối, chẳng hạn như log.root.dir=/opt/apigee4/var/log/messages, thì nhật ký thông báo sẽ được lưu trữ trong /opt/apigee4/var/log/messages/messagelog/. Đường dẫn tuyệt đối trong log.root.dir được ưu tiên hơn data.dir.

Nếu bạn muốn lưu trữ các tệp nhật ký trong một cấu trúc tệp phẳng để tất cả các tệp nhật ký đều được đặt trong cùng một thư mục, hãy đặt thuộc tính enable.flat.directory.structure thành true trong tệp message-logging.properties trên Trình xử lý thư. Các thông báo được lưu trữ trong thư mục do các thuộc tính ở trên chỉ định và tên tệp có dạng {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename}.

Giá trị mặc định cho các biến trong mẫu thông báo

Bạn có thể chỉ định riêng giá trị mặc định cho từng biến trong mẫu tin nhắn. Ví dụ: nếu biến request.header.id không phân giải được, thì giá trị của biến đó sẽ được thay thế bằng giá trị unknown.

<Message>This is a test message. id = {request.header.id:unknown}</Message>

Bạn có thể chỉ định một giá trị mặc định chung cho tất cả các biến chưa phân giải bằng cách đặt thuộc tính defaultVariableValue trên phần tử Message:

<Message defaultVariableValue="unknown">This is a test message. id = {request.header.id}</Message>

Định cấu hình dịch vụ quản lý nhật ký của bên thứ ba

Chính sách MessageLogging cho phép bạn gửi thông báo nhật ký hệ thống đến các dịch vụ quản lý nhật ký của bên thứ ba, chẳng hạn như Splunk, Sumo Logic và Loggly. Nếu bạn muốn gửi nhật ký hệ thống đến một trong các dịch vụ đó, hãy xem tài liệu của dịch vụ đó để định cấu hình máy chủ, cổng và giao thức của dịch vụ, sau đó đặt phần tử Nhật ký hệ thống trong chính sách này cho phù hợp.

Xem tài liệu sau đây để biết cấu hình quản lý nhật ký của bên thứ ba:

Tham chiếu lỗi

Phần này mô tả các mã lỗi và thông báo lỗi được trả về, cũng như các biến lỗi do Edge đặt khi chính sách này kích hoạt lỗi. Thông tin này đóng vai trò quan trọng trong việc phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem Những điều bạn cần biết về lỗi chính sáchXử lý lỗi.

Lỗi thời gian chạy

Những lỗi này có thể xảy ra khi thực thi chính sách.

Mã lỗi Trạng thái HTTP Nguyên nhân
steps.messagelogging.StepDefinitionExecutionFailed 500 Xem chuỗi lỗi.

Lỗi triển khai

Những lỗi này có thể xảy ra khi bạn triển khai proxy chứa chính sách này.

Tên lỗi Nguyên nhân Khắc phục
InvalidProtocol Lỗi này có thể không triển khai được chính sách MessageLogging nếu giao thức được chỉ định trong phần tử <Protocol> không hợp lệ. Các giao thức hợp lệ là TCP và UDP. Để gửi thông báo nhật ký hệ thống qua TLS/SSL, chỉ TCP được hỗ trợ.
InvalidPort Quá trình triển khai chính sách MessageLogging có thể không thành công với lỗi này nếu số cổng không được chỉ định trong phần tử <Port> hoặc nếu số cổng không hợp lệ. Số cổng phải là một số nguyên lớn hơn 0.

Biến lỗi

Các biến này được đặt khi xảy ra lỗi thời gian chạy. Để biết thêm thông tin, hãy xem Những điều bạn cần biết về lỗi chính sách.

Biến Trong đó Ví dụ:
fault.name="fault_name" fault_name là tên của lỗi, như liệt kê trong bảng Lỗi thời gian chạy ở trên. Tên lỗi là phần cuối cùng của mã lỗi. fault.name Matches "StepDefinitionExecutionFailed"
messagelogging.policy_name.failed policy_name là tên của chính sách báo lỗi do người dùng chỉ định. messagelogging.ML-LogMessages.failed = true

Ví dụ về phản hồi lỗi

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.messagelogging.StepDefinitionExecutionFailed"
      },
      "faultstring":"Execution failed"
   }
}

Ví dụ về quy tắc lỗi

<FaultRule name="MessageLogging">
    <Step>
        <Name>ML-LogMessages</Name>
        <Condition>(fault.name Matches "StepDefinitionExecutionFailed") </Condition>
    </Step>
    <Condition>(messagelogging.ML-LogMessages.failed = true) </Condition>
</FaultRule>


Biến luồng

Các biến sau đây được điền sẵn khi lỗi chính sách.

  • messagelogging.failed
  • messagelogging.{stepdefinition-name}.failed

Chủ đề có liên quan