Add several community document files and a README explaining how to u…

…se and configure the log manager.

https://issues.redhat.com/browse/LOGMGR-309
https://issues.redhat.com/browse/LOGMGR-310
https://issues.redhat.com/browse/LOGMGR-311
https://issues.redhat.com/browse/LOGMGR-312
https://issues.redhat.com/browse/LOGMGR-313
Signed-off-by: James R. Perkins <[email protected]>

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+end_of_line = lf
+insert_final_newline = true

CODEOWNERS

@@ -0,0 +1,2 @@
+* @dmlloyd
+* @jamezp

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+James Perkins <[email protected]> and/or David Lloyd <[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.adoc

@@ -0,0 +1,65 @@
+:toc:
+
+= Contributing Guide
+
+Want to contribute to the jboss-logmanager? We try to make it easy, and all contributions, even the smaller ones,
+are more than welcome. This includes bug reports, fixes, documentation, etc. First though, please read this page
+(including the small print at the end).
+
+== Legal
+
+All original contributions to jboss-logmanager are licensed under the
+https://www.apache.org/licenses/LICENSE-2.0[ASL - Apache License], version 2.0 or later, or, if another license is
+specified as governing the file or directory being modified, such other license.
+
+All contributions are subject to the https://developercertificate.org/[Developer Certificate of Origin (DCO)].
+The DCO text is also included verbatim in the [dco.txt](dco.txt) file in the root directory of the repository.
+
+== Reporting an issue
+
+This project uses https://issues.redhat.com/browse/LOGMGR[JIRA] for filing issues.
+
+If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing and
+what you would expect to see.
+
+== Before you contribute
+
+To contribute, use GitHub Pull Requests, from your **own** fork.
+
+Also, make sure you have set up your Git authorship correctly:
+
+----
+git config --global user.name "Your Full Name"
+git config --global user.email [email protected]
+----
+
+If you use different computers to contribute, please make sure the name is the same on all your computers.
+
+We use this information to acknowledge your contributions in release announcements.
+
+== Setup
+
+If you have not done so on this machine, you need to:
+
+* Install Git and configure your GitHub access
+* Install Java SDK 11+ (OpenJDK recommended)
+
+=== IDE Config and Code Style
+
+jboss-logmanager has a strictly enforced code style. Code formatting is done by the Eclipse code formatter, using the config files
+found in the https://github.com/jboss-logging/logging-dev-tools/blob/main/ide-config/src/main/resources/[eclipse-code-formatter.xml]
+file. By default, when you run `mvn verify`, the code will be formatted automatically.
+When submitting a pull request the CI build will fail if running the formatter results in any code changes, so it is
+recommended that you always run a full Maven build before submitting a pull request.
+
+==== Eclipse Setup
+
+Open the *Preferences* window, and then navigate to _Java_ -> _Code Style_ -> _Formatter_. Click _Import_ and then
+select the `eclipse-code-formatter.xml` downloaded from the above link or clone the repository and navigate to the file.
+
+Next navigate to _Java_ -> _Code Style_ -> _Organize Imports_. Click _Import_ and select the `eclipse.importorder` file.
+
+==== IDEA Setup
+
+Install the https://plugins.jetbrains.com/plugin/6546-adapter-for-eclipse-code-formatter/[Adapter for Eclipse Code Formatter].
+See the https://github.com/krasa/EclipseCodeFormatter#instructions[documentation] on how to configure the plugin.

README.adoc

@@ -0,0 +1,141 @@
+= JBoss Log Manager
+
+The JBoss Log Manager is an extension of Java Util Logging (JUL). To use the log manager you must set the
+`java.util.logging.manager` system property to `org.jboss.logmanager.LogManager`.
+
+== Usage
+
+To use the project you must set the `java.util.logging.manager` system property to `org.jboss.logmanager.LogManager`
+and include the library on your class path.
+
+=== Maven
+[source,xml]
+----
+<dependency>
+    <groupId>org.jboss.logmanager</groupId>
+    <artifactId>jboss-logmanager</artifactId>
+    <version>${version.org.jboss.logmanager}</version>
+</dependency>
+----
+
+=== Logging Configuration
+
+==== `logging.properties` Configuration File
+
+* *Logger options*
+** loggers=<category>[,<category>,...] - Specify a comma-separated list of logger categories which will be configured. Any categories not listed here will not be configured from the following properties.
+** logger.<category>.level=<level> - Specify the level for a category. The level can be one of the valid <<log-levels,levels>>. If unspecified, the nearest parent's level will be inherited.
+** logger.<category>.handlers=<handler>[,<handler>,...] - Specify a comma-separated list of the handler names to attach to this logger. The handlers must be configured in the same properties file.
+** logger.<category>.filter=<filter> - Specify a filter for a category. See the <<filter-expressions, filter expressions>> for details on defining a filter.
+** logger.<category>.useParentHandlers=(true|false) - Specify whether log messages should cascade up to parent handlers. The default value is true.
+
+* *Handler options*
+** handler.<name>=<className> - [red]#(Required)# Specify the class name of the handler to instantiate.
+** handler.<name>.module=<moduleName> - Specify the module name where the handler to instantiate is located.
+** handler.<name>.level=<level> - Restrict the level of this handler. If unspecified, the default value of ALL is retained.
+** handler.<name>.encoding=<encoding> - Specify the character encoding, if it is supported by this handler type. If not specified, a handler-specific default is used.
+** handler.<name>.errorManager=<name> - Specify the name of the error manager to use. The error manager must be configured in the same properties file. If unspecified, no error manager is configured.
+** handler.<name>.filter=<name> - Specify a filter for a category. See the <<filter-expressions, filter expressions>> for details on defining a filter.
+** handler.<name>.formatter=<name> - Specify the name of the formatter to use, if it is supported by this handler type. The formatter must be configured in the same properties file. If not specified, messages will not be logged for most handler types.
+** handler.<name>.properties=<property>[,<property>,...] - Specify a list of JavaBean-style properties to additionally configure. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.
+** handler.<name>.constructorProperties=<property>[,<property>,...] - Specify a list of properties that should be used as construction parameters. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.
+** handler.<name>.<property>=<value> - Set the value of the named property. A POJO name can also be used as a value to use the instance of the <<pojo, POJO>> for the value of the property.
+
+* *Error manager options*
+** errorManager.<name>=<className> - [red]#(Required)# Specify the class name of the error manager to instantiate.
+** errorManager.<name>.module=<moduleName> - Specify the module name where the error manager to instantiate is located.
+** errorManager.<name>.properties=<property>[,<property>,...] - Specify a list of JavaBean-style properties to additionally configure. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.
+** errorManager.<name>.constructorProperties=<property>[,<property>,...] - Specify a list of properties that should be used as construction parameters. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.
+** errorManager.<name>.<property>=<value> - Set the value of the named property. A POJO name can also be used as a value to use the instance of the <<pojo, POJO>> for the value of the property.
+
+* *Formatter options*
+** formatter.<name>=<className> - [red]#(Required)# Specify the class name of the formatter to instantiate.
+** formatter.<name>.module=<moduleName> - Specify the module name where the formatter to instantiate is located.
+** formatter.<name>.properties=<property>[,<property>,...] - Specify a list of JavaBean-style properties to additionally configure. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.
+** formatter.<name>.constructorProperties=<property>[,<property>,...] - Specify a list of properties that should be used as construction parameters. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.
+** formatter.<name>.<property>=<value> - Set the value of the named property. A POJO name can also be used as a value to use the instance of the <<pojo, POJO>> for the value of the property.
+
+* [[pojo]]*POJO options*
+** pojo.<name>=<className> - [red]#(Required)# Specify the class name of the POJO to instantiate.
+** pojo.<name>.module=<moduleName> - Specify the module name where the POJO to instantiate is located.
+** pojo.<name>.properties=<property>[,<property>,...] - Specify a list of JavaBean-style properties to additionally configure. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.
+** pojo.<name>.constructorProperties=<property>[,<property>,...] - Specify a list of properties that should be used as construction parameters. A rudimentary type introspection is done to ascertain the appropriate conversion for the given property.
+** pojo.<name>.<property>=<value> - Set the value of the named property. A POJO name can also be used as a value to use the instance of the <<pojo, POJO>> for the value of the property.
+
+==== [[log-levels]] Log Levels
+
+* `ALL`
+* `FATAL`
+* `SEVERE`
+* `ERROR`
+* `WARNING`
+* `WARN`
+* `INFO`
+* `CONFIG`
+* `FINE`
+* `DEBUG`
+* `FINER`
+* `TRACE`
+* `FINEST`
+* `OFF`
+
+==== [[filter-expressions]] Filter Expressions
+
+[options="header"]
+|====
+| Filter Type | Expression | Description | Parameter(s)
+| accept | `accept` | Accepts all log messages. | None
+| deny | `deny` | enies all log messages. | None
+| not | `not(filterExpression)` | Accepts a filter as an argument and inverts the returned value. | The expression takes a single filter for it's argument.
+| all | `all(filterExpressions)` | A filter consisting of several filters in a chain. If any filter find the log message to be unloggable, the message will not be logged and subsequent filters will not be checked. | The expression takes a comma delimited list of filters for it's argument.
+| any | `any(filterExpressions)` | A filter consisting of several filters in a chain. If any filter fins the log message to be loggable, the message will be logged and the subsequent filters will not be checked. | The expression takes a comma delimited list of filters for it's argument.
+| levelChange | `levelChange(level)` | A filter which modifies the log record with a new level. | The expression takes a single string based level for it's argument.
+| levels | `levels(levels)` | A filter which includes log messages with a level that is listed in the list of levels. | The expression takes a comma delimited list of string based levels for it's argument.
+| levelRange | `levelRange([minLevel,maxLevel])` | A filter which logs records that are within the level range. | The filter expression uses a "[" to indicate a minimum inclusive level and a "]" to indicate a maximum inclusive level. Otherwise use "(" or ")" respectively indicate exclusive. The first argument for the expression is the minimum level allowed, the second argument is the maximum level allowed.
+| match | `match("pattern")` | A regular-expression based filter. The raw unformatted message is used against the pattern. | The expression takes a regular expression for it's argument.`
+| substitute | `substitute("pattern", "replacement value")` | A filter which replaces the first match to the pattern with the replacement value. | The first argument for the expression is the pattern the second argument is the replacement text.
+| substituteAll | `substituteAll("pattern", "replacement value")` | A filter which replaces all matches of the pattern with the replacement value. | The first argument for the expression is the pattern the second argument is the replacement text.
+|====
+
+==== Example configuration
+
+This is an example logging.properties that you can use to get started.
+
+----
+# Additional logger names to configure (root logger is always configured)
+loggers=org.foo.bar,org.foo.baz
+
+# Root logger level
+logger.level=DEBUG
+
+# Declare handlers for the root logger
+logger.handlers=CONSOLE,FILE
+
+# Declare handlers for additional loggers
+logger.org.foo.bar.handlers=FILE
+logger.org.foo.bar.useParentHandlers=false
+
+# Console handler configuration
+handler.CONSOLE=org.jboss.logmanager.handlers.ConsoleHandler
+handler.CONSOLE.properties=autoFlush
+handler.CONSOLE.level=INFO
+handler.CONSOLE.autoFlush=true
+handler.CONSOLE.formatter=PATTERN
+
+# File handler configuration
+handler.FILE=org.jboss.logmanager.handlers.FileHandler
+handler.FILE.level=DEBUG
+handler.FILE.properties=autoFlush,fileName
+handler.FILE.autoFlush=true
+handler.FILE.fileName=${jboss.server.log.dir}/project.log
+handler.FILE.formatter=PATTERN
+
+# The log format pattern for both logs
+formatter.PATTERN=org.jboss.logmanager.formatters.PatternFormatter
+formatter.PATTERN.properties=pattern
+formatter.PATTERN.pattern=%d{HH:mm:ss,SSS} %-5p [%c{1}] %m%n
+----
+
+== Contributing
+
+See the link:CONTRIBUTING.adoc[contributing guide].

security.txt

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Security Contacts and Procedures
+
+The RESTEasy community takes security very seriously, and we aim to take immediate action to address serious
+security-related problems that involve our products or services.
+
+Please report any suspected security vulnerability in this project to Red Hat Product Security at [email protected].
+You can use our GPG key to communicate with us securely.
+
+To report an issue in any Red Hat branded website or online service, please contact Red Hat Information Security at
+[email protected].
+https://access.redhat.com/security/team/contact