org.apache.hadoop.fs.s3a.audit.impl

Class LoggingAuditor

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.fs.s3a.audit.impl.AbstractOperationAuditor

org.apache.hadoop.fs.s3a.audit.impl.LoggingAuditor

All Implemented Interfaces:

Closeable, AutoCloseable, OperationAuditor, org.apache.hadoop.fs.statistics.IOStatisticsSource, org.apache.hadoop.fs.store.audit.AuditSpanSource<AuditSpanS3A>, org.apache.hadoop.service.Service

@InterfaceAudience.Private
public class LoggingAuditor
extends AbstractOperationAuditor

The LoggingAuditor logs operations at DEBUG (in SDK Request) and in span lifecycle and S3 request class construction at TRACE. The context information is added as the HTTP referrer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields inherited from class org.apache.hadoop.fs.s3a.audit.impl.AbstractOperationAuditor

BASE

Constructor Summary

Constructors

Constructor and Description
LoggingAuditor() Create the auditor.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String key, String value) Add an attribute.
AuditSpanS3A	createSpan(String operation, String path1, String path2)
String	getLastHeader() Get the last header used.
AuditSpanS3A	getUnbondedSpan() Get the unbonded span to use after deactivating an active span.
protected void	serviceInit(org.apache.hadoop.conf.Configuration conf) Service init, look for jobID and attach as an attribute in log entries.
String	toString()

Methods inherited from class org.apache.hadoop.fs.s3a.audit.impl.AbstractOperationAuditor

createSpanID, getAuditorId, getIOStatistics, getOptions, init

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceStart, serviceStop, setConfig, start, stop, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.fs.s3a.audit.OperationAuditor

checkAccess, noteSpanReferenceLost

Methods inherited from interface org.apache.hadoop.service.Service

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop

Constructor Detail

LoggingAuditor

public LoggingAuditor()

Create the auditor. The UGI current user is used to provide the principal; this will be cached and provided in the referrer header.

Method Detail

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration conf)
                    throws Exception

Service init, look for jobID and attach as an attribute in log entries. This is where the warning span is created, so the relevant attributes (and filtering options) are applied.

Overrides:

serviceInit in class org.apache.hadoop.service.AbstractService

Parameters:

conf - configuration

Throws:

Exception - failure

toString

public String toString()

Overrides:

toString in class org.apache.hadoop.service.AbstractService

createSpan

public AuditSpanS3A createSpan(String operation,
                               @Nullable
                               String path1,
                               @Nullable
                               String path2)

addAttribute

public final void addAttribute(String key,
                               String value)

Add an attribute.

Parameters:

key - key

value - value

getUnbondedSpan

public AuditSpanS3A getUnbondedSpan()

Description copied from interface: OperationAuditor

Get the unbonded span to use after deactivating an active span.

Returns:

a span.

getLastHeader

public String getLastHeader()

Get the last header used.

Returns:

the last referrer header generated.