org.ops4j.pax.logging.PaxLoggingConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pax-logging-api Show documentation
The Pax Logging API Library is to allow for the Pax Logging Service to be reloaded without stopping the many dependent bundles. It also contains the OSGi Log Service API and the Knopflerfish Log API.
There is a newer version: 2.2.7
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.ops4j.pax.logging;

import java.util.logging.LogManager;
import java.util.logging.LogRecord;

/**
 * Different constants used across Pax Logging.
 * Constants names use the following prefixes:

 *     {@code LOGGING_CFG_} - for system or context property names
 *     {@code PID_CFG_} - for property names found in {@code org.ops4j.pax.logging} PID
 *     {@code SERVICE_PROPERTY_} - for names of OSGi service properties
 * 

 */
public interface PaxLoggingConstants {

    /**
     * The Managed Service PID for logging configuration. Format is specific to chosen backend.
     */
    String LOGGING_CONFIGURATION_PID = "org.ops4j.pax.logging";

    /**
     * Each backend will register its service under these {@code objectClass} names.
     */
    String[] LOGGING_LOGSERVICE_NAMES = {
            org.osgi.service.log.LogService.class.getName(),
            org.knopflerfish.service.log.LogService.class.getName(),
            PaxLoggingService.class.getName()
    };

    /**
     * System or context (in that order) property that specifies service ranking for {@link PaxLoggingService}
     */
    String LOGGING_CFG_LOGSERVICE_RANKING = "org.ops4j.pax.logging.ranking";

    /**
     * System or context (in that order) property to skip Java Util Logging bridge registration.
     */
    String LOGGING_CFG_SKIP_JUL = "org.ops4j.pax.logging.skipJUL";

    /**
     * System or context (in that order) property to skip {@link LogManager#reset()} invocation when bridging JUL
     * to Pax Logging.
     */
    String LOGGING_CFG_SKIP_JUL_RESET = "org.ops4j.pax.logging.skipJULReset";

    /**
     * System or context (in that order) property to use single, synchronized {@link java.util.logging.SimpleFormatter}
     * in {@link org.ops4j.pax.logging.internal.JdkHandler#publish(LogRecord)} (which is the default) or new instance
     * should be used for each event (to prevent deadlocks in special circumstances).
     */
    String LOGGING_CFG_SKIP_JUL_SYNCHRONIZED_FORMATTER = "org.ops4j.pax.logging.syncJULFormatter";

    /**
     * System or context (in that order) property setting the threshold for framework/bundle/service events.
     * OSGi Compendium R6, 101.6 "Mapping of Events" defines levels for standard events and with this property we
     * can filter out some of them.
     */
    String LOGGING_CFG_FRAMEWORK_EVENTS_LOG_LEVEL = "org.ops4j.pax.logging.service.frameworkEventsLogLevel";

    /**
     * System or context (in that order) property that specifies threshold for fallback logger used behind all
     * facades, handled by pax-logging-api.
     */
    String LOGGING_CFG_DEFAULT_LOG_LEVEL = "org.ops4j.pax.logging.DefaultServiceLog.level";

    /**
     * System or context (in that order) property that selects buffering fallback logger.
     */
    String LOGGING_CFG_USE_BUFFERING_FALLBACK_LOGGER = "org.ops4j.pax.logging.useBufferingLogFallback";

    /**
     * System or context (in that order) property that selects file-based fallback logger. The value should be
     * writable filename. Turning on this logger will enable synchronization and register singleton stream
     * used by all instances of {@link org.ops4j.pax.logging.spi.support.FileServiceLog}.
     */
    String LOGGING_CFG_USE_FILE_FALLBACK_LOGGER = "org.ops4j.pax.logging.useFileLogFallback";

    /**
     * System property that specifies the TLS debug logging mode. The TLS records logging modes are:
     * 
     *     no_logging - TLS messages are not logged
     *     no_hex_dumps_logging - all messages except hex dumps are logged
     *     debug_logging - all messages are logged
     * 
     */
    String LOGGING_CFG_TLS_LOGGING_MODE = "org.ops4j.pax.logging.tlsdebug.loggingMode";

    /**
     * {@code org.osp4j.pax.logging} PID property to specify max size for
     * {@link org.osgi.service.log.LogReaderService}
     */
    String PID_CFG_LOG_READER_SIZE_LEGACY = "pax.logging.entries.size";

    /**
     * {@code org.osp4j.pax.logging} PID property to specify max size for
     * {@link org.osgi.service.log.LogReaderService}
     */
    String PID_CFG_LOG_READER_SIZE = "org.ops4j.pax.logging.logReaderServiceSize";

    /**
     * Service property to filter {@link org.ops4j.pax.logging.spi.PaxAppender} OSGi services
     */
    String SERVICE_PROPERTY_APPENDER_NAME_PROPERTY = "org.ops4j.pax.logging.appender.name";

    /**
     * Service property to filter {@link org.ops4j.pax.logging.spi.PaxLayout} OSGi services
     */
    String SERVICE_PROPERTY_LAYOUT_NAME_PROPERTY = "org.ops4j.pax.logging.layout.name";

    /**
     * Service property to filter {@link org.ops4j.pax.logging.spi.PaxFilter} OSGi services
     */
    String SERVICE_PROPERTY_FILTER_NAME_PROPERTY = "org.ops4j.pax.logging.filter.name";

    /**
     * Service property to filter {@link org.ops4j.pax.logging.spi.PaxErrorHandler} OSGi services
     */
    String SERVICE_PROPERTY_ERRORHANDLER_NAME_PROPERTY = "org.ops4j.pax.logging.errorhandler.name";

    /**
     * EventAdmin topic name to publish events related to (re)configuration of logging backend.
     */
    String EVENT_ADMIN_CONFIGURATION_TOPIC = "org/ops4j/pax/logging/Configuration";

    /**
     * Context property that switches from private {@code ch.qos.logback.classic.LoggerContext} to one
     * managed by {@code org.slf4j.impl.StaticLoggerBinder#defaultLoggerContext} (where {@code StaticLoggerBinder}
     * is the one available in logback-classic).
     */
    String LOGGING_CFG_LOGBACK_USE_STATIC_CONTEXT = "org.ops4j.pax.logging.StaticLogbackContext";

    /**
     * System or context (in that order) property that sets Logback configuration file (not generic URI - just a path).
     * See https://logback.qos.ch/manual/configuration.html
     */
    String LOGGING_CFG_LOGBACK_CONFIGURATION_FILE = "org.ops4j.pax.logging.StaticLogbackFile";

    /**
<<<<<<< HEAD
     * System or context property that can indicate alternative file with properties used instead of
     * the properties from Configuration Admin. Useful in tests probably.
     * Currently this is handled only by pax-logging-log4j2.
=======
     * System or context property that can indicate alternative file in format specific to the backend used instead of
     * the properties from Configuration Admin. Useful in tests or in environment without Configuration Admin.
>>>>>>> 49f9846b... [PAXLOGGING-308] Allow to use logging backends without Configuration Admin
     */
    String LOGGING_CFG_PROPERTY_FILE = "org.ops4j.pax.logging.property.file";

    /**
     * System or context property that can indicate whether to throw exceptions from log4j2 configuration
     * methods when ERROR occurs. Normally ERRORs are only printed to org.apache.logging.log4j.status.StatusLogger
     * so by default this value is {@code false}.
     */
    String LOGGING_CFG_LOG4J2_ERRORS_AS_EXCEPTION = "org.ops4j.pax.logging.log4j2.errorsAsExceptions";

    /**
     * {@code org.osp4j.pax.logging} PID property to specify XML file with Logback configuration
     */
    String PID_CFG_LOGBACK_CONFIG_FILE = "org.ops4j.pax.logging.logback.config.file";

    /**
     * {@code org.osp4j.pax.logging} PID property to specify XML (or any supported) file (not URL)
     * with Log4J2 configuration. Can be comma-separated and compliant to Log4J2's {@code log4j.configurationFile}
     */
    String PID_CFG_LOG4J2_CONFIG_FILE = "org.ops4j.pax.logging.log4j2.config.file";

    /**
     * {@code org.osp4j.pax.logging} PID property to specify properties file with default Log4J2 configuration
     * that may be overriden by further configuration in PID file.
     */
    String PID_CFG_LOG4J2_DEFAULTS_FILE = "org.ops4j.pax.logging.log4j2.defaults.file";

    /**
     * {@code org.osp4j.pax.logging} PID property to specify whether async context should be used. Used both
     * for case where properties are taken directly from PID configuration or when
     * {@link #PID_CFG_LOG4J2_CONFIG_FILE} is used.
     */
    String PID_CFG_LOG4J2_ASYNC = "org.ops4j.pax.logging.log4j2.async";

    /**
     * {@code org.osp4j.pax.logging} PID property to specify whether to use locks during (re)configuration.
     * By default, log operations use locks to prevent reconfiguration during actual logging. But
     * there are special cases (see: https://ops4j1.jira.com/browse/PAXLOGGING-191) when reconfiguration may lead
     * to calling custom appender code, which start some threads that call yet another code which call log statements.
     * This option may be turned off (value: {@code false}) to disable locks.
     */
    String PID_CFG_USE_LOCKS = "org.ops4j.pax.logging.useLocks";

    /**
     * System or context property to configure locking just like {@link #PID_CFG_USE_LOCKS}.
     */
    String LOGGING_CFG_USE_LOCKS = PID_CFG_USE_LOCKS;

    /**
     * System property to disable (because its enabled by default) thread map inheritance in {@link PaxContext}
     */
    String LOGGING_CFG_INHERIT_THREAD_CONTEXT_MAP = "org.ops4j.pax.logging.threadContextMapInheritable";

    /**
     * Private key to pass original Log4j2 {@code org.apache.logging.log4j.message.Message}
     * if it's going to be used by Log4j2 backend (see https://ops4j1.jira.com/browse/PAXLOGGING-302)
     */
    String _LOG4J2_MESSAGE = ".log4j2_message";

    /**
     * Default file looked up during startup to override Configuration Admin config
     */
    String PAX_LOGGING_PROPERTY_FILE = "pax-logging.properties";

    /**
     * System or context property to disable (because its enabled by default) Event Admin support (even if it's
     * available). If not specified, it is assumed that Event Admin is enabled.
     */
    String LOGGING_CFG_ENABLE_EVENT_ADMIN = "org.ops4j.pax.logging.eventAdminEnabled";

    /**
     * System or context property to disable (because its enabled by default)
     * {@link org.osgi.service.log.LogReaderService} registration. If not specified, it is assumed that
     * this service is registered. This is mandated by OSGi CMPN Log Specification, but impacts performance.
     * So it can be disabled if needed.
     */
    String LOGGING_CFG_ENABLE_LOG_READER_SERVICE = "org.ops4j.pax.logging.logReaderEnabled";

}