NessLogging
Repository for configuration and testing of ness logs in java applications
Model Dependency
This dependency only contains the model schema and field setters. Use this dependency if your application will be handling its own publishing to Ness and only need your logs to match the required schema
<dependency>
<groupId>com.optum.eis</groupId>
<artifactId>ness-logging-model</artifactId>
<version>4.0.2</version>
</dependency>
Full Dependency
This dependency contains the full java package. This is the default dependency to use to aid in ingesting your logs to Ness.
<dependency>
<groupId>com.optum.eis</groupId>
<artifactId>ness-logging-package</artifactId>
<version>4.0.2</version>
</dependency>
Getting Started
Step 1: set the values in a config file. We provide you a sample config.properties
#Required fields:
askId=UHGWM110-000432
applicationName=SampleApp
deviceVendor=Optum
deviceProduct=Sample
logEventName=test-login
msg=sample message
#Example Optional Fields
outcome=SUCCESS
DestUserDataName=JohnDoe
applicationCI=CIXXXXX
Application team needs to put config such that it will send resourceId along with each log. It should be inside "additionalFields" key of ness format. For reference visit here
Step 2: Calling the main NessLogger class to create log events and pass in the required. Append optional fields to logevent using setters.
Here, we have used ThreadLocal to simulate a context like scenario and got the data from context, so it can be changed according to different requests.
new NessLogEvent(context.getReceivedTime(), context.getAskId(), context.getApplicationName(), context.getDeviceVendor(),
context.getDeviceProduct(), IpAddressUtil.convert(context.getIp4()),
context.getHostName(), message, context.getLogEventName(), context.getApplicationCI(), context.getDeviceVersion(),
context.getDeviceCI(), context.getDevicePid(), context.getDeviceProc(), context.getAddFieldsValue(), context.getTags()).toString();
This NessLogEvent class can be used with interceptors and custom logger wrappers and entirely depends on how the developers want to integrate it in their app.
Ness Setter Methods
Here are setters already built out that are available to set optional fields for the Ness schema
LogEvt Setters
setLogEvtLogClass //sets LogEvt Log Class (default is uncategorized)
setLogEvtSeverity //sets LogEvt Severity
setLogEvtClass //sets LogEvt Event Class
setLogEvtExternalId //sets LogEvt External Id
setLogEvtStart //sets LogEvt Start
setLogEvtEnd //sets LogEvt End
setLogEvtAct //sets LogEvt Act
setLogEvtOutcome //sets LogEvt Outcome
setLogEvtReason //sets LogEvt Reason
setLogEvtTxProto //sets LogEvt Tx Proto
setLogEvtTags //sets LogEvt Tags
setLogEvtAdditionalFields //sets LogEvt Additional Fields
Application Setters
setApplicationCI(String CI) // sets Application CI
Device Setters
setDeviceVersion(String version) // sets Device Version
setDeviceCI(String CI) // sets Device CI
setDevicePID(int PID) // sets Device PID
setDeviceProc(String Proc) // sets Device Proc
File Record Data Setters
setFileRecordName(String name) // sets File Record Name
setFileRecordOldName(String name) // sets File Record Old Name
setFileRecordId(String id) // sets File Record Id
setFileRecordOldId(String id) // sets File Record Old Id
setFileRecordDataType(dataType resultDataType) // sets File Record Data Type
setFileRecordOldDataType(oldDataType resultDataType) // sets File Record Old Data Type
setFileRecordDesc(String desc) // sets File Record Desc
setFileRecordOldDesc(String desc) // sets File Record Old Desc
setFileRecordCreateTime(long createTime) // sets File Record Create Time
setFileRecordOldCreateTime(long createTime) // sets File Record Old Create Time
setFileRecordModTime(long createTime) // sets File Record Mod Time
setFileRecordOldModTime(long createTime) // sets File Record Old Mod Time
setFileRecordPath(String path) // sets File Record Path
setFileRecordOldPath(String path) // sets File Record Old Path
setFileRecordPermission(String permission) // sets File Record Permission
setFileRecordOldPermission(String permission) // sets File Record Old Permission
setFileRecordType(String type) // sets File Record Type
setFileRecordOldType(String type) // sets File Record Old Type
setFileRecordTransaction(String transaction) // sets File Record Transaction
setFileRecordOperation(operation operationvalue) // sets File Record Operation
setFileRecordSize(long sizevalue) // sets File Record Size
setFileRecordOldSize(long sizevalue) // sets File Record Old Size
Request Setters
setRequestRequest(String request) // sets Request field
setRequestUserAgent(String userAgent) // sets Request User Agent
setRequestMethod(String method) // sets Request Method
setRequestCookies(String cookies) // sets Request Cookies
setRequestOptum_CID_Ext(String optum_cid_ext) // sets Request Optum_CID_Ext
setRequestReferer(String referer) // sets Request referer
setRequestIn(long in) // sets Request In
setRequestOut(long out) // sets Request Out
destHost Data Setters
setDHostDataHostName(String hostName) // sets DHost Host Name
setDHostDataDnsDomain(String dnsdomain) // sets DHost Dns Domain
setDHostDataNtDomain(String ntdomain) // sets DHost Nt Domain
setDHostDataIP4(long ip4) // sets DHost Data IP4
setDHostDataIP6(double ip6) // sets DHost IP6
setDHostDataProc(String proc) // sets DHost Data Proc
setDHostDataPid(int pid) // sets DHost Data Pid
setDHostDataPort(int port) // sets DHost Data Port
setDHostDataMac(String mac) // sets DHost Data Mac
setDHostDataFwdAddr(List<Long> fwdAddrArray) // sets DHost Data Fwd Addr
setDHostDataFwdPort(List<Integer> fwdPortArray) // sets DHost Fwd Port
sourceHost Data Setters
setSourceHostHostName(String hostname) // sets sourceHost Host Name
setSourceHostDnsDomain(String dnsdomain) // sets sourceHost Dns Domain
setSourceHostNtDomain(String ntdomain) // sets sourceHost Nt Domain
setSourceHostIP4(long ip4) // sets sourceHost Data IP4
setSourceHostIP6(double ip6) // sets sourceHost IP6
setSourceHostProc(String proc) // sets sourceHost Data Proc
setSourceHostPid(int pid) // sets sourceHost Data Pid
setSourceHostPort(int port) // sets sourceHost Data Port
setSourceHostMac(String mac) // sets sourceHost Data Mac
setSourceHostFwdAddr(List<Long> fwdAddrArray) // sets sourceHost Data Fwd Addr
setSourceHost****FwdPort(List<Integer> fwdPortArray) // sets sourceHost Fwd Port
sourceUser Data Setters
setSourceUserDataUid(String Uid) // sets sourceUser Data Uid
setSourceUserDataName(String name) // sets sourceUser Data Name
setSourceUserDataPriv(priv privresult) // sets sourceUser Data priv result
setSourceUserDataRole(String role) // sets sourceUser Data role
destUser Data Setters
setDestUserDataUid(String Uid) // sets destUser Data Uid
setDestUserDataName(String name) // sets destUser Data Name
setDestUserDataPriv(priv privresult) // sets destUser Data priv result
setDestUserDataRole(String role) // sets destUser Data role