aboutsummaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-core/src/main/java/org/openecomp/sdc/logging/slf4j/Markers.java
blob: 2225f60a1a26d76c0aee2e284b102336cc070e35 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/*
 * Copyright © 2016-2017 European Support Limited
 *
 * 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.openecomp.sdc.logging.slf4j;

import org.onap.logging.ref.slf4j.ONAPLogConstants;
import org.slf4j.Marker;
import org.slf4j.MarkerFactory;

/**
 * <p>The list of markers that can be used for special logging such as metrics, audit, etc.</p>
 *
 * <p>Although markers can be easily instantiated whenever needed, having constants for them helps eliminate mistakes -
 * misspelling, using a marker that is not handled, etc.</p>
 *
 * <p>Usage:</p>
 *
 * <pre>
 *
 *     Logger log = LogFactory.getLogger(this.getClass());
 *     log.info(Markers.AUDIT, "User '{}' logged out", user);
 *
 * </pre>
 *
 * @author EVITALIY
 * @see Marker
 * @since 13/09/2016.
 */
public class Markers {

    public static final Marker ENTRY = MarkerFactory.getMarker(ONAPLogConstants.Markers.ENTRY.getName());
    public static final Marker EXIT = MarkerFactory.getMarker(ONAPLogConstants.Markers.EXIT.getName());
    public static final Marker METRICS = MarkerFactory.getMarker("METRICS");

    private Markers() {
        // prevent instantiation
    }
}