# Functions
CloudEventFromBuf will marshal a single cloud event from the provided buffer.
CloudEventFromFile will marshal a single cloud event from the provided file name.
ConvertArgs will convert the key/value pair args to a map.
CorrelationIdFromContext attempts to get the Correlation Id value from the context provided.
DefaultAuditConfig specifies a default AuditConfig.
DefaultAuditFilterOperations will return a map of the default AuditConfig.AuditFilters.
No description provided by the author
No description provided by the author
EventerFromContext attempts to get the eventer value from the context provided.
InitFallbackLogger will initialize the fallback logger for eventing.
InitSysEventer provides a mechanism to initialize a "system wide" eventer singleton for Boundary.
NewAuditConfig creates a new config starting with the DefaultAuditConfig() and applying options.
NewAuditEncryptFilter returns a new encrypt filter which is initialized for audit events.
NewCorrelationIdContext will return a context containing a value for the provided CorrelationId.
NewEventer creates a new Eventer using the config.
NewEventerContext will return a context containing a value of the provided Eventer.
NewHclogLogger creates a new hclog.Logger-compatible implementation that outputs to events.
NewId is a bit of a modified NewId has been done to stop a circular dependency with the errors package that is caused by importing boundary/internal/db.
NewRequestInfoContext will return a context containing a value for the provided RequestInfo.
RequestInfoFromContext attempts to get the RequestInfo value from the context provided.
SysEventer returns the "system wide" eventer for Boundary and can/will return a nil Eventer.
TestEventerConfig creates a test config and registers a cleanup func for its test tmp files.
TestGetEventerConfig is a test accessor for the eventer's config.
TestRequestInfo provides a test RequestInfo.
TestResetSysEventer will reset event.syseventer to an uninitialized state.
TestWithAuditSink is a test option.
TestWithBroker is an unexported and a test option for passing in an optional broker.
TestWithObservationSink is a test option.
TestWithoutEventing allows the caller to "disable" all eventing for a test.
TestWithStderrSink is a test option.
TestWithSysSink is a test option.
WithAllow is an optional set of allow filters.
WithAuditWrapper is an optional wrapper for audit events.
WithAuth allows an optional Auth.
WithDeny is an optional set of deny filters.
WithDetails allows an optional set of key/value pairs about an observation event at the detail level and observation events may have multiple "details".
WithEventer allows an optional eventer.
WithEventer allows an optional eventer config.
WithFilterOperations is an optional set of filter operations.
WithFlush allows an optional flush option.
WithGating starts the eventer in gated mode.
WithHclogLevel is an option to specify a log level if using the adapter.
WithHeader allows an optional set of key/value pairs about an event at the header level and observation events will only have one "header".
WithId allows an optional Id.
WithInfo allows an optional info key/value pairs about an error event.
WithInfoMsg allows an optional msg and optional info key/value pairs about an error event.
WithNoGateLocking is used when trawling through the existing queue to ensure we don't deadlock.
WithNow allows an option time.Time to represent now.
WithRequest allows an optional request.
WithRequestInfo allows an optional RequestInfo.
WithResponse allows an optional response.
WithSchema is an optional schema for the cloudevents.
WithTelemetry allows an optional telemetry option.
WriteAudit will write an audit event.
WriteError will write an error event.
WriteObservation will write an observation event.
WriteSysEvent will write a sysevent using the eventer from event.SysEventer() if no eventer can be found an hclog.Logger will be created and used.
# Constants
AllowFilter defines a filter type for "allow".
ApiRequest defines an API request audit event type.
AuditType represents audit events.
BestEffort means that a best effort will be made to deliver an event.
CreatedAtField in an event.
DefaultDeliveryGuarantee will be BestEffort.
DenyFilter defines a filter type for "deny".
Details field in an event.
EncryptOperation specifies an encryption operation.
Enforced means that a delivery guarantee is enforced.
ErrorType represents error events.
EveryType represents every (all) types of events.
FileSink is written to a file.
HeaderField in an event.
HmacSha256Operation specifies an hmac-sha256 operation.
IdField in an event.
No description provided by the author
JSONHclogSinkFormat means the event is formated as an hclog json entry.
JSONSinkFormat means the event is formatted as JSON.
MissingKey defines a key to be used as the "missing key" when ConvertArgs has an odd number of args (it's missing a key in its key/value pairs).
NoOperation specifies no operation.
ObservationType represents observation events.
OpField in an event.
PublicClassification declares a field as public data.
RedactOperation specifies an redaction operation.
Request field in an event.
RequestInfoField in an event.
Response field in an event.
SecretClassification declares a field as secret data.
SensitiveClassification declares a field as sensitive data.
ServerAddress: event source server address.
ServerName: event source server name.
StderrSink is written to stderr.
StorageType represents storage events.
SysType represents system events.
TelemetryType represents telemetry events.
TextHclogSinkFormat means the event is formatted as an hclog text entry.
TextSinkFormat means the event is formmatted as text.
TypeField in an event.
No description provided by the author
UnknownOperation specifies an unknown operation.
VersionField in an event.
WriterSink is written to an io.Writer.
# Variables
ErrInvalidOperation represents an error when an operation cannot be completed because the thing being operated on is in an invalid state.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AuditConfig defines the configuration required for audit events sinks.
No description provided by the author
Eventer provides a method to send events to pipelines of sinks.
EventerConfig supplies all the configuration needed to create/config an Eventer.
FileSinkTypeConfig contains configuration structures for file sink types.
No description provided by the author
No description provided by the author
HclogLoggerAdapter is used to provide an hclog-style interface to code that cannot natively handle eventing.
No description provided by the author
RequestInfo defines the fields captured about a Boundary request.
No description provided by the author
SinkConfig defines the configuration for a Eventer sink.
SinkFilter defines an event filter (allow or deny) for a sink.
StderrSinkTypeConfig contains configuration structures for file sink types.
No description provided by the author
No description provided by the author
UserInfo defines the fields captured about a user for a Boundary request.
WriterSinkTypeConfig contains configuration structures for writer sink types.
# Interfaces
EventListener is an interface for listening to events.
# Type aliases
AuditFilterOperation defines a map between DataClassifications and FilterOperations for audit filtering.
DataClassification defines a data classification (public, sensitive, secret, etc).
No description provided by the author
EventHandlerFunc is a function that handles an event.
FilterOperation defines a filter operation (none, redact, encrypt, etc).
FilterType defines a type for filters (allow or deny).
No description provided by the author
No description provided by the author
Option - how Options are passed as arguments.
No description provided by the author
No description provided by the author
Type represents the event's type.