Document navigation

Log Server

Overview

ZStack Cloud allows you to add a log server to the cloud. With the log server, you can collect management node logs and quickly locate problems, thereby improving the cloud O&M efficiency.

Inventory

Properties

Name Description Optional Valid Values Starting Version
uuid The resource UUID. 5.3.28
name The resource name. 5.3.28
description The resource description. 5.3.28
configuration The log configruation. 5.3.28
category The log category. 5.3.28
type The log type. 5.3.28
level The log severity level. 5.3.28
createDate The creation time. 5.3.28
lastOpDate The last operation time. 5.3.28
tagUuid The tag UUID list. 5.3.28
userTags The user tags. 5.3.28
systemTags The system tags. 5.3.28
groupBy 5.3.28

Operations

AddLogServer

Adds a log server. For example,
AddLogServer name=example category=ManagementNodeLog type=log4j2 level=ALL configuration={\n\"appenderType\": \"Syslog\",\n\"configuration\": {\n\"hostname\": \"192.168.0.11\",\n\"port\": \"514\",\n\"protocol\": \"UDP\",\n\"facility\": \"LOCAL5\"\n}\n}

Parameters

Name Description Optional Valid Values Starting Version
name The resource name. 5.3.28
description The resource description. Yes 5.3.28
category The log category (ManagementNodeLog; PlatformOperationLog; SnatLog).
Note: When category is SnatLog, type must be FluentBit, and the output type in configuration must be Syslog.
  • ManagementNodeLog
  • PlatformOperationLog
  • SnatLog
5.3.28
type The log type.
  • Log4j2
  • FluentBit
5.3.28
level The log severity level. Yes
  • OFF
  • FATAL
  • ERROR
  • WARN
  • INFO
  • DEBUG
  • TRACE
  • ALL
5.3.28
configuration The log configurations. 5.3.28
resourceUuid The resource UUID. Yes 5.3.28
tagUuids The tag UUID list. Yes 5.3.28
userTags The user tags. See CreateUserTag Yes 5.3.28
systemTags The system tags. See CreateSystemTag Yes 5.3.28
timeout Yes

DeleteLogSever

Deletes a log server. For example,
DeleteLogSever uuid=cdc213d6ba25367ea6c4d201491d900c

Parameters

Name Description Optional Valid Values Starting Version
uuid The resource UUID. 5.3.28
userTags The user tags. See CreateUserTag Yes 5.3.28
systemTags The system tags. See CreateSystemTag Yes 5.3.28
timeout Yes

QueryLogServer

Queries a log server. For example,
QueryLogServer uuid=c1a0038cfc004f59bf7a56c6da8d856b

Primitive Fields of Query

See LogServer Inventory.

UpdateLogServer

Updates a log server. For example,
UpdateLogServer uuid=cdc213d6ba25367ea6c4d201491d900c name=example

Parameters

Name Description Optional Valid Values Starting Version
uuid The resource UUID. 5.3.28
name The resource name. Yes 5.3.28
description The resource description. Yes 5.3.28
userTags The user tags. See CreateUserTag Yes 5.3.28
systemTags The system tags. See CreateSystemTag Yes 5.3.28
timeout Yes
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center