Management API Reference for subsystem=logging

Children (18)

• async-handler
• console-handler
• custom-formatter
• custom-handler
• file-handler
• filter
• json-formatter
• log-file
• logger
• logging-profile
• pattern-formatter
• periodic-rotating-file-handler
• periodic-size-rotating-file-handler
• root-logger
  • ROOT
• size-rotating-file-handler
• socket-handler
• syslog-handler
• xml-formatter

Attributes (2)

• add-logging-api-dependencies - Indicates whether or not logging API dependencies should be added to deployments during the deployment process. A value of true will add the dependencies to the deployment. A value of false will skip the deployment from being processed for logging API dependencies.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether or not logging API dependencies should be added to deployments during the deployment process. A value of true will add the dependencies to the deployment. A value of false will skip the deployment from being processed for logging API dependencies.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• use-deployment-logging-config - Indicates whether or not deployments should use a logging configuration file found in the deployment to configure the log manager. If set to true and a logging configuration file is found in the deployment's META-INF or WEB-INF/classes directory, then a log manager will be configured with those settings. If set to false, the server's logging configuration will be used regardless of any logging configuration files supplied in the deployment.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether or not deployments should use a logging configuration file found in the deployment to configure the log manager. If set to true and a logging configuration file is found in the deployment's META-INF or WEB-INF/classes directory, then a log manager will be configured with those settings. If set to false, the server's logging configuration will be used regardless of any logging configuration files supplied in the deployment.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (4)

• add - Add the logging subsystem.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  add-logging-api-dependencies	BOOLEAN	false	true	true	Indicates whether or not logging API dependencies should be added to deployments during the deployment process. A value of true will add the dependencies to the deployment. A value of false will skip the deployment from being processed for logging API dependencies.
  use-deployment-logging-config	BOOLEAN	false	true	true	Indicates whether or not deployments should use a logging configuration file found in the deployment to configure the log manager. If set to true and a logging configuration file is found in the deployment's META-INF or WEB-INF/classes directory, then a log manager will be configured with those settings. If set to false, the server's logging configuration will be used regardless of any logging configuration files supplied in the deployment.

  Raw DMR model

  { "operation-name" : "add", "description" : "Add the logging subsystem.", "request-properties" : { "add-logging-api-dependencies" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether or not logging API dependencies should be added to deployments during the deployment process. A value of true will add the dependencies to the deployment. A value of false will skip the deployment from being processed for logging API dependencies.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "use-deployment-logging-config" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether or not deployments should use a logging configuration file found in the deployment to configure the log manager. If set to true and a logging configuration file is found in the deployment's META-INF or WEB-INF/classes directory, then a log manager will be configured with those settings. If set to false, the server's logging configuration will be used regardless of any logging configuration files supplied in the deployment.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "all-services", "runtime-only" : false }

• list-log-files - Lists the log files in the jboss.server.log.dir directory that are defined on a file-handler, periodic-rotating-file-handler or size-rotating-file-handler.
  Deprecated Since 3.0.0

  Use the log-file resource to see the available log files.

  Reply properties

  Type

  LIST

  Value Type

  
  {
      "file-name" => {
          "type" => STRING,
          "description" => "The name of the file.",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "min-length" => 1,
          "max-length" => 2147483647,
          "stability" => "default"
      },
      "file-size" => {
          "type" => LONG,
          "description" => "The size of the log file in bytes.",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "stability" => "default"
      },
      "last-modified-date" => {
          "type" => STRING,
          "description" => "The date the file was last modified.",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "min-length" => 1,
          "max-length" => 2147483647,
          "stability" => "default"
      }
  }

  Raw DMR model

  { "operation-name" : "list-log-files", "description" : "Lists the log files in the jboss.server.log.dir directory that are defined on a file-handler, periodic-rotating-file-handler or size-rotating-file-handler.", "request-properties" : {}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "file-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the file.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "file-size" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The size of the log file in bytes.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "last-modified-date" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The date the file was last modified.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } }, "deprecated" : { "since" : "3.0.0", "reason" : "Use the log-file resource to see the available log files." }, "access-constraints" : {"sensitive" : {"view-server-logs" : {"type" : "logging"}}}, "stability" : "default", "read-only" : true, "runtime-only" : true }

• read-log-file - Reads the contents of a log file. The file must be in the jboss.server.log.dir and must be defined as a file-handler, periodic-rotating-file-handler or size-rotating-file-handler.
  Deprecated Since 3.0.0

  Use the log-file resource to read the log file.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  name	STRING	true	true		The name of the log file to read. This file must exist in the jboss.server.log.dir.
  encoding	STRING	false	true		The character encoding used to read the file.
  lines	INT	false	true	10	The number of lines to read from the file. A value of -1 will read all log lines.
  skip	INT	false	true	0	The number of lines to skip before reading.
  tail	BOOLEAN	false	true	true	Reads from the end of the file.

  Reply properties

  Type

  LIST

  Value Type

  
  STRING

  Raw DMR model

  { "operation-name" : "read-log-file", "description" : "Reads the contents of a log file. The file must be in the jboss.server.log.dir and must be defined as a file-handler, periodic-rotating-file-handler or size-rotating-file-handler.", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the log file to read. This file must exist in the jboss.server.log.dir.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The character encoding used to read the file.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "lines" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of lines to read from the file. A value of -1 will read all log lines.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10, "min" : -1, "max" : 2147483647, "stability" : "default" }, "skip" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of lines to skip before reading.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "min" : 0, "max" : 2147483647, "stability" : "default" }, "tail" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Reads from the end of the file.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "deprecated" : { "since" : "3.0.0", "reason" : "Use the log-file resource to read the log file." }, "access-constraints" : {"sensitive" : {"view-server-logs" : {"type" : "logging"}}}, "stability" : "default", "read-only" : true, "runtime-only" : true }

• remove - Remove the logging subsystem.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove the logging subsystem.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "all-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.logging

          
  <feature spec="subsystem.logging">
    <param name="add-logging-api-dependencies" value="{value}"/>
    <param name="use-deployment-logging-config" value="{value}"/>
  <feature/>
          
        

  📋