blob: cd53ccf91b58c1baba8e0c57d1243ec2a7d425aa (
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
51
52
53
54
55
56
57
58
59
60
61
62
|
/*
* ================================================================================
* Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*
*/
package org.onap.dcae.utils.eelf.logger.api.info;
import java.util.Date;
/**
* Captures fields required for message level logging. These fields are mostly derived fields. For example: creation
* timestamp can be auto generated based on system time, {@link RequestStatusCode} and {@link NagiosAlertLevel} can be
* derived based on {@link LogLevelCategory}
*
* @author Rajiv Singla
*/
public interface MessageLogInfo extends LogInfo {
/**
* Required field to capture when the message was created
* The value should be represented in UTC and formatted according to ISO 8601.
* <p>
* <b>Example: 2015-06-03T13:21:58+00:00</b>
* </p>
*
* @return message creation creationTimestamp
*/
Date getCreationTimestamp();
/**
* Required field contains a value of COMPLETE or ERROR to indicate high level success or failure of the
* request related activities.
*
* @return value to indicate high level success or failure of the request related activities
*/
RequestStatusCode getStatusCode();
/**
* Optional field for Nagios monitoring/alerting severity code
*
* @return nagios monitoring/alerting severity code
*/
NagiosAlertLevel getAlertSeverity();
}
|
