Generic log fields

The following fields are displayed for all logs generated by Stormshield KMaaS in SaaS mode, in the order shown in the table.

  • Mandatory fields are systematically present in logs for successful requests, but may be absent for unsuccessful requests.

  • Optional fields can be present or absent in both cases.

Field

Description

Type

Mandatory/Optional

timestamp

 

Date and time at which the log was created. In UTC format.

Example: "2023-12-05T09:27:58.936Z"

 String in ISO 8601 format Mandatory

severity

Level of severity of the log.

Prescribed values:

  • emerg: The system is unusable,

  • alert: The problem must be fixed immediately,

  • crit: Critical error,

  • err: Non-critical error,

  • warning: The operation was successful but generated a warning,

  • notice: Unusual event not requiring corrective action,

  • info: Normal operation information message,

  • debug: Information useful to developers for troubleshooting the application.

String

Mandatory

application_version

Application version.

Example: "4.3.0.2354"

   Mandatory

kind

Log family to which the log belongs.

Prescribed values:

  • domain: Stormshield KMaaS business operation logs.

  • system: Logs relating to the operations concerning the environment.

  • http: Logs relating to the HTTP operations of the Stormshield KMaaS.

String

 Mandatory

category

Log category.

Examples of possible values:

  • cse: Logs of business requests issued by the Stormshield KMaaS.

  • authentication: Logs of authentication token verification actions.

String

Mandatory
action

Event that occurred.

Examples of possible values:

  • unwrap,

  • privilegedwrap,

  • takeout,

  • privilegedunwrap,

  • rewrap,

  • digest,

  • certs,

  • wrapprivatekey,

  • privatekeysign,

  • privatekeydecrypt,

  • privilegedprivatekeydecrypt

String

 Mandatory

log_version

Current version of log format.

Prescribed value: 2

Integer

Mandatory

hostname

Host name.

Example: MyCSEServer

String

Mandatory
process_id

Process ID.

Example: 4031

 Integer Mandatory
correlation_id

Unique identifier linking all logs relating to the same request or event.

Example: "146f73b6-c15d-4488-984c-97726cf86587"

 String Mandatory

The fields in the error block described below are displayed for all logs generated by the Stormshield KMaaS in the event of an error when executing the action:

Field

Description

Type

Mandatory/Optional

code

Error number.

Example: 2006003

 Integer Mandatory

message

Error message.

Example: Unauthorized request

 String Mandatory