@InterfaceAudience.LimitedPrivate(value="S3A auditing extensions") @InterfaceStability.Unstable

Package org.apache.hadoop.fs.s3a.audit

Support for auditing and ultimately tracing operations.

See: Description

Interface Summary

Interface	Description
AuditManagerS3A	Interface for Audit Managers auditing operations through the AWS libraries.
AuditSpanS3A	An Audit Span with S3A integration, specifically callbacks from the AWS client SDK.
AWSAuditEventCallbacks	Callbacks for audit spans.
OperationAuditor	Interfaces for audit services to implement.

Class Summary

Class	Description
AuditIntegration	Support for integrating auditing within the S3A code.
AWSRequestAnalyzer	Extract information from a request.
AWSRequestAnalyzer.RequestInfo	Info about a request.
OperationAuditorOptions	Options for the OperationAuditor.
S3AAuditConstants
S3LogParser	Class to help parse AWS S3 Logs.
S3LogVerbs	Various verbs in the S3 logs.

Exception Summary

Exception	Description
AuditFailureException	This is in the AWS exception tree so that exceptions raised in the AWS SDK are correctly reported up.
AuditOperationRejectedException	The auditor has rejected the operation as forbidden/unavailable.

Package org.apache.hadoop.fs.s3a.audit Description

Support for auditing and ultimately tracing operations. This is a public API for extension points, e.g. opentracing. However, it is very unstable as we evolve how best to audit/trace operation. An audit service is instantiated when an S3A Filesystem is initialized during creation. The choice of service is determined in the configuration option S3AAuditConstants.AUDIT_SERVICE_CLASSNAME. The service MUST implement the interface OperationAuditor to provide an AuditSpan whenever an operation is started through a public FileSystem API call (+some other operations).