## Provided Capabilities (1)

Name | Dynamic | Other provider points
--- | --- | ---
org.wildfly.undertow.host.access-log | true | none

## Attributes (10)

- directory - Directory in which to save logs

  Type | STRING
  Default Value | ${jboss.server.log.dir}
  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" : "STRING"
          },
          "description" : "Directory in which to save logs",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : {
              "EXPRESSION_VALUE" : "${jboss.server.log.dir}"
          },
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- extended - If the log uses the extended log file format

  Type | BOOLEAN
  Default Value | false
  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" : "If the log uses the extended log file format",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : false,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- pattern - The access log pattern.

  Type | STRING
  Default Value | common
  Is the attribute nillable? | 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" : "STRING"
          },
          "description" : "The access log pattern.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "default" : "common",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- predicate - Predicate that determines if the request should be logged

  Type | STRING
  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" : "STRING"
          },
          "description" : "Predicate that determines if the request should be logged",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- prefix - Prefix for the log file name.

  Type | STRING
  Default Value | access_log.
  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" : "STRING"
          },
          "description" : "Prefix for the log file name.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "access_log.",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- relative-to - The directory the path is relative to

  Type | STRING
  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" : "STRING"
          },
          "description" : "The directory the path is relative to",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- rotate - Rotate the access log every day.

  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" : "Rotate the access log every day.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- suffix - Suffix for the log file name.

  Type | STRING
  Default Value | log
  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" : "STRING"
          },
          "description" : "Suffix for the log file name.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "log",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- use-server-log - If the log should be written to the server log, rather than a separate file.

  Type | BOOLEAN
  Default Value | false
  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" : "If the log should be written to the server log, rather than a separate file.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : false,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- worker - Name of the worker to use for logging

  Type | STRING
  Default Value | default
  Is the attribute nillable? | 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" : "STRING"
          },
          "description" : "Name of the worker to use for logging",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "default" : "default",
          "capability-reference" : "org.wildfly.io.worker",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services"
      }

## Operations (2)

- add - Add access log configuration to this virtual server.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  directory | STRING | false | true | ${jboss.server.log.dir} | Directory in which to save logs
  extended | BOOLEAN | false | true | false | If the log uses the extended log file format
  pattern | STRING | false | false | common | The access log pattern.
  predicate | STRING | false | true |  | Predicate that determines if the request should be logged
  prefix | STRING | false | true | access_log. | Prefix for the log file name.
  relative-to | STRING | false | true |  | The directory the path is relative to
  rotate | BOOLEAN | false | true | true | Rotate the access log every day.
  suffix | STRING | false | true | log | Suffix for the log file name.
  use-server-log | BOOLEAN | false | true | false | If the log should be written to the server log, rather than a separate file.
  worker | STRING | false | false | default | Name of the worker to use for logging

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Add access log configuration to this virtual server.",
          "request-properties" : {
              "directory" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Directory in which to save logs",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : {
                      "EXPRESSION_VALUE" : "${jboss.server.log.dir}"
                  },
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "extended" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "If the log uses the extended log file format",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : false,
                  "stability" : "default"
              },
              "pattern" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The access log pattern.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "default" : "common",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "predicate" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Predicate that determines if the request should be logged",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              },
              "prefix" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Prefix for the log file name.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "access_log.",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "relative-to" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The directory the path is relative to",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "rotate" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Rotate the access log every day.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : true,
                  "stability" : "default"
              },
              "suffix" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Suffix for the log file name.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "log",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "use-server-log" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "If the log should be written to the server log, rather than a separate file.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : false,
                  "stability" : "default"
              },
              "worker" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Name of the worker to use for logging",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "default" : "default",
                  "capability-reference" : "org.wildfly.io.worker",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- remove - Remove access log configuration from this virtual server.

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Remove access log configuration from this virtual server.",
          "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.undertow.server.host.setting.access-log

      <feature spec="subsystem.undertow.server.host.setting.access-log">
        <param name="host" value="{resource name}"/>
        <param name="server" value="{resource name}"/>
        <param name="directory" value="{value}"/>
        <param name="extended" value="{value}"/>
        <param name="pattern" value="{value}"/>
        <param name="predicate" value="{value}"/>
        <param name="prefix" value="{value}"/>
        <param name="relative-to" value="{value}"/>
        <param name="rotate" value="{value}"/>
        <param name="suffix" value="{value}"/>
        <param name="use-server-log" value="{value}"/>
      <feature/>