org.jboss.logmanager.handlers.SyslogHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-logmanager Show documentation
Show all versions of jboss-logmanager Show documentation
An implementation of java.util.logging.LogManager
The newest version!
/*
* JBoss, Home of Professional Open Source.
*
* Copyright 2018 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.logmanager.handlers;
import static java.security.AccessController.doPrivileged;
import static java.time.temporal.ChronoField.DAY_OF_MONTH;
import static java.time.temporal.ChronoField.HOUR_OF_DAY;
import static java.time.temporal.ChronoField.MILLI_OF_SECOND;
import static java.time.temporal.ChronoField.MINUTE_OF_HOUR;
import static java.time.temporal.ChronoField.MONTH_OF_YEAR;
import static java.time.temporal.ChronoField.SECOND_OF_MINUTE;
import static java.time.temporal.ChronoField.YEAR;
import java.io.Closeable;
import java.io.Flushable;
import java.io.IOException;
import java.io.OutputStream;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.nio.charset.StandardCharsets;
import java.security.PrivilegedAction;
import java.text.Normalizer;
import java.text.Normalizer.Form;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder;
import java.time.format.TextStyle;
import java.util.Collection;
import java.util.logging.ErrorManager;
import java.util.logging.Formatter;
import java.util.logging.Level;
import java.util.regex.Pattern;
import javax.net.SocketFactory;
import javax.net.ssl.SSLSocketFactory;
import org.jboss.logmanager.ExtHandler;
import org.jboss.logmanager.ExtLogRecord;
/**
* A syslog handler for logging to syslogd.
*
* This handler can write to syslog servers that accept the RFC3164
* and RFC5424 formats. Writes can be done via TCP, SSL over TCP or
* UDP protocols. You can also override the {@link #setOutputStream(OutputStream) output stream} if a custom
* protocol is needed.
*
*
*
*
*
*
* Configuration Properties:
*
*
*
*
* Property
* Description
* Type
* Default
*
*
* serverHostname
* The address of the syslog server
* {@link String String}
* localhost
*
*
* port
* The port of the syslog server
* int
* 514
*
*
* facility
* The facility used to calculate the priority of the log message
* {@link Facility Facility}
* {@link Facility#USER_LEVEL USER_LEVEL}
*
*
* appName
* The name of the application that is logging
* {@link String String}
* java
*
*
* hostname
* The name of the host the messages are being sent from. See {@link #setHostname(String)} for more
* details
* {@link String String}
* {@code
* null
* }
*
*
* syslogType
* The type of the syslog used to format the message
* {@link SyslogType SyslogType}
* {@link SyslogType#RFC5424 RFC5424}
*
*
* protocol
* The protocol to send the message over
* {@link Protocol Protocol}
* {@link Protocol#UDP UDP}
*
*
* delimiter
* The delimiter to use at the end of the message if {@link #setUseMessageDelimiter(boolean) useDelimiter}
* is set to {@code
* true
* }
* {@link String String}
* For {@link Protocol#UDP UDP} {@code
* null
* } - For {@link Protocol#TCP TCP} or {@link Protocol#SSL_TCP
* SSL_TCP} {@code \n}
*
*
* useDelimiter
* Whether or not the message should be appended with a {@link #setMessageDelimiter(String)
* delimiter}
* {@code boolean}
* For {@link Protocol#UDP UDP} {@code
* false
* } - For {@link Protocol#TCP TCP} or {@link Protocol#SSL_TCP
* SSL_TCP} {@code
* true
* }
*
*
* useCountingFraming
* Prefixes the size of the message, mainly used for {@link Protocol#TCP TCP} or {@link Protocol#SSL_TCP
* SSL_TCP}, connections to the message being sent to the syslog server. See http://tools.ietf.org/html/rfc6587
* for more details on framing types.
* {@code boolean}
* {@code
* false
* }
*
*
* truncate
* Whether or not a message, including the header, should truncate the message if the length in bytes is
* greater than the {@link #setMaxLength(int) maximum length}. If set to {@code
* false
* } messages will be split and sent
* with the same header values.
* {@code boolean}
* {@code
* true
* }
*
*
* maxLength
* The maximum length a log message, including the header, is allowed to be.
* {@code int}
* For {@link SyslogType#RFC3164 RFC3164} 1024 (1k) - For {@link SyslogType#RFC5424 RFC5424} 2048
* (2k)
*
*
*
* -
*
- FQDN *
- Static IP address *
- hostname *
- Dynamic IP address *
- {@code null} *
© 2015 - 2025 Weber Informatics LLC | Privacy Policy