| 
6 | 6 | /**  | 
7 | 7 |  * Utility class that provides predefined SLF4J {@link Marker} instances used in logging  | 
8 | 8 |  * operations within the application. <br>  | 
9 |  | - * This class is not intended to be instantiated.  | 
 | 9 | + * This class is not intended to be instantiated, but is open for extension.  | 
10 | 10 |  */  | 
11 | 11 | public class LoggingMarkers {  | 
12 | 12 | 
 
  | 
13 | 13 | 	/**  | 
14 |  | -	 * Marker instance representing Personally Identifiable Information (PII) used in  | 
15 |  | -	 * logging operations to classify or tag log entries for sensitive data. This can be  | 
16 |  | -	 * utilized to allow selective filtering, handling, or analysis of log messages  | 
17 |  | -	 * containing PII.  | 
 | 14 | +	 * Marker used to identify log statements associated with <strong>sensitive  | 
 | 15 | +	 * data</strong>, such as:  | 
 | 16 | +	 * <ul>  | 
 | 17 | +	 * <li>Internal business information</li>  | 
 | 18 | +	 * <li>Employee data</li>  | 
 | 19 | +	 * <li>Customer non-regulated data</li>  | 
 | 20 | +	 * <li>Business processes and logic</li>  | 
 | 21 | +	 * <li>etc.</li>  | 
 | 22 | +	 * </ul>  | 
 | 23 | +	 * Typically, logging this information should be avoided  | 
18 | 24 | 	 */  | 
19 |  | -	public static final Marker PII_MARKER = MarkerFactory.getMarker("PII");  | 
 | 25 | +	public static final Marker SENSITIVE_DATA_MARKER = MarkerFactory.getMarker("SENSITIVE");  | 
20 | 26 | 
 
  | 
21 |  | -	private LoggingMarkers() {  | 
22 |  | -		// Prevent instantiation of this utility class  | 
23 |  | -	}  | 
 | 27 | +	/**  | 
 | 28 | +	 * Marker used to identify log statements associated with <strong>restricted  | 
 | 29 | +	 * data</strong>, such as:  | 
 | 30 | +	 * <ul>  | 
 | 31 | +	 * <li>Authentication credentials</li>  | 
 | 32 | +	 * <li>Keys and secrets</li>  | 
 | 33 | +	 * <li>Core intellectual property</li>  | 
 | 34 | +	 * <li>Critical security configs</li>  | 
 | 35 | +	 * <li>Trade secrets</li>  | 
 | 36 | +	 * <li>etc.</li>  | 
 | 37 | +	 * </ul>  | 
 | 38 | +	 * Logging of such information is usually prohibited in any circumstances  | 
 | 39 | +	 */  | 
 | 40 | +	public static final Marker RESTRICTED_DATA_MARKER = MarkerFactory.getMarker("RESTRICTED");  | 
 | 41 | + | 
 | 42 | +	/**  | 
 | 43 | +	 * Marker used to identify log statements associated with <strong>regulated  | 
 | 44 | +	 * data</strong>, such as:  | 
 | 45 | +	 * <ul>  | 
 | 46 | +	 * <li>PCI (credit card data)</li>  | 
 | 47 | +	 * <li>PHI (health information)</li>  | 
 | 48 | +	 * <li>PII (personally identifiable info)</li>  | 
 | 49 | +	 * <li>Financial records</li>  | 
 | 50 | +	 * <li>Compliance-controlled data</li>  | 
 | 51 | +	 * <li>etc.</li>  | 
 | 52 | +	 * </ul>  | 
 | 53 | +	 * Logging of such information should be avoided  | 
 | 54 | +	 */  | 
 | 55 | +	public static final Marker REGULATED_DATA_MARKER = MarkerFactory.getMarker("REGULATED");  | 
 | 56 | + | 
 | 57 | +	/**  | 
 | 58 | +	 * Marker used to identify log statements associated with <strong>public  | 
 | 59 | +	 * data</strong>, such as:  | 
 | 60 | +	 * <ul>  | 
 | 61 | +	 * <li>Public documentation</li>  | 
 | 62 | +	 * <li>Marketing materials</li>  | 
 | 63 | +	 * <li>etc.</li>  | 
 | 64 | +	 * </ul>  | 
 | 65 | +	 * There are no restriction for  | 
 | 66 | +	 */  | 
 | 67 | +	public static final Marker PUBLIC_DATA_MARKER = MarkerFactory.getMarker("PUBLIC");  | 
24 | 68 | 
 
  | 
25 | 69 | }  | 
0 commit comments