openecomp-be/lib/openecomp-logging-lib/openecomp-sdc-logging-core/src/main/java/org/openecomp/sdc/logging/Markers.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.logging;
  22
  23 import org.slf4j.Marker;
  24 import org.slf4j.MarkerFactory;
  25
  26 /**
  27  * <p>The list of markers that can be used for special logging such as metrics, audit, etc.</p>
  28  *
  29  * <p>Although markers can be easily instantiated whenever needed, having constants for them helps eliminate mistakes -
  30  * misspelling, using a marker that is not handled, etc.</p>
  31  *
  32  * <p>Usage:</p>
  33  *
  34  * <pre>
  35  *
  36  *     Logger log = LogFactory.getLogger(this.getClass());
  37  *     log.info(Markers.AUDIT, "User '{}' logged out", user);
  38  *
  39  * </pre>
  40  *
  41  * @author EVITALIY
  42  * @since 13/09/2016.
  43  *
  44  * @see Marker
  45  */
  46 public class Markers {
  47
  48     public static final Marker AUDIT = MarkerFactory.getMarker("AUDIT");
  49     public static final Marker METRICS = MarkerFactory.getMarker("METRICS");
  50 }