Files
threshold/internal/observability/event/sink_config.go
T
hashicorp-copywrite[bot]andJohan Brandhorst-Satzkorn 29da0bcb92 [COMPLIANCE] License changes (#3567)
* Adding explicit MPL license for sub-package.

This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository.

* Adding explicit MPL license for sub-package

This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository.

* Updating the license from MPL to Business Source License

Going forward, this project will be licensed under the Business Source License v1.1. Please see our blog post for more details at https://hashi.co/bsl-blog, FAQ at www.hashicorp.com/licensing-faq, and details of the license at www.hashicorp.com/bsl.

* Update copyright file headers to BUS-1.1

* Rerun make gen

This will pick up the last of the license changes

* Revert "Rerun make gen"

This reverts commit dbe0968bffd92745d8663c6940debae098395a6b.

* Remove copywrite from generation script

The current version of copywrite is not sophisticated enough
to only apply the copywrite changes to certain subdirectories,
so to avoid accidentally relicensing our api and sdk modules,
we will stop running the copywrite script until such time
that it can do the right thing.

* License protobuf API as MPL

The protobuf API files are used to generate the SDK,
since we want the SDK to be MPL, the protobuf files
must also be MPL. This extends to all protobuf files
whose sources end up in the SDK directory, including:

- internal/proto/controller/api
- internal/proto/controller/custom_options
- internal/proto/plugin

It also includes the generated service directory in
internal/gen/controller/api/services, since they are
generated from the protobuf sources used for the SDK.

* Change website license file name

This makes the naming scheme consistent with the rest
of the repository.

* Add note on licensing to README

* Set copywrite license to BUSL

* Revert "Add note on licensing to README"

This reverts commit 4d865a91a7a4f11605f0dc4609355d7e3c3cfffe.

---------

Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com>
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
2023-08-11 10:31:53 -07:00

146 lines
6.6 KiB
Go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1
package event
import (
"fmt"
"io"
"time"
)
// SinkConfig defines the configuration for a Eventer sink
type SinkConfig struct {
Name string `hcl:"name"` // Name defines a name for the sink.
Description string `hcl:"description"` // Description defines a description for the sink.
EventTypes []Type `hcl:"event_types"` // EventTypes defines a list of event types that will be sent to the sink. See the docs for EventTypes for a list of accepted values.
EventSourceUrl string `hcl:"event_source_url"` // EventSource defines an optional event source URL for the sink. If not defined a default source will be composed of the https://hashicorp.com/boundary.io/ServerName/Path/FileName.
AllowFilters []string `hcl:"allow_filters"` // AllowFilters define a set predicates for including an event in the sink. If any filter matches, the event will be included. The filter should be in a format supported by hashicorp/go-bexpr.
DenyFilters []string `hcl:"deny_filters"` // DenyFilters define a set predicates for excluding an event in the sink. If any filter matches, the event will be excluded. The filter should be in a format supported by hashicorp/go-bexpr.
Format SinkFormat `hcl:"format"` // Format defines the format for the sink (JSONSinkFormat or TextSinkFormat).
Type SinkType `hcl:"type"` // Type defines the type of sink (StderrSink, FileSink, or WriterSink).
StderrConfig *StderrSinkTypeConfig `hcl:"stderr"` // StderrConfig defines parameters for a stderr output.
FileConfig *FileSinkTypeConfig `hcl:"file"` // FileConfig defines parameters for a file output.
WriterConfig *WriterSinkTypeConfig `hcl:"-"` // WriterConfig defines parameters for an io.Writer output. This is not available via HCL.
AuditConfig *AuditConfig `hcl:"audit_config"` // AuditConfig defines optional parameters for audit events (if EventTypes contains audit)
}
func (sc *SinkConfig) Validate() error {
const op = "event.(SinkConfig).Validate"
if err := sc.Type.Validate(); err != nil {
return fmt.Errorf("%s: %w", op, err)
}
if err := sc.Format.Validate(); err != nil {
return fmt.Errorf("%s: %w", op, err)
}
var foundSinkTypeConfigs int
if sc.StderrConfig != nil {
foundSinkTypeConfigs++
}
if sc.FileConfig != nil {
foundSinkTypeConfigs++
}
if sc.WriterConfig != nil {
foundSinkTypeConfigs++
}
if foundSinkTypeConfigs > 1 {
return fmt.Errorf("%s: too many sink type config blocks: %w", op, ErrInvalidParameter)
}
switch sc.Type {
case StderrSink:
// It's okay for StderrConfig to be nil if the type is stderr, but it's
// not okay for something else to be set
if foundSinkTypeConfigs == 1 && sc.StderrConfig == nil {
return fmt.Errorf("%s: mismatch between sink type and sink configuration block: %w", op, ErrInvalidParameter)
}
case FileSink:
// Unlike in the stderr case, this can't be nil, so if it's not nil
// we've now verified it's the only block populated
if sc.FileConfig == nil {
return fmt.Errorf(`%s: missing "file" block: %w`, op, ErrInvalidParameter)
}
if sc.FileConfig.FileName == "" {
return fmt.Errorf("%s: missing file name: %w", op, ErrInvalidParameter)
}
case WriterSink:
if sc.WriterConfig == nil {
return fmt.Errorf(`%s: missing writer config: %w`, op, ErrInvalidParameter)
}
if sc.WriterConfig.Writer == nil {
return fmt.Errorf("%s: missing writer: %w", op, ErrInvalidParameter)
}
}
if sc.Name == "" {
return fmt.Errorf("%s: missing sink name: %w", op, ErrInvalidParameter)
}
if len(sc.EventTypes) == 0 {
return fmt.Errorf("%s: missing event types: %w", op, ErrInvalidParameter)
}
for _, et := range sc.EventTypes {
if err := et.Validate(); err != nil {
return fmt.Errorf("%s: %w", op, err)
}
// well, if there's an event type of audit, we need to check the audit
// config, if it's optionally provided. We are intentionally only
// checking the FilterOverrides, because there's no way to specify the
// wrapper in a config.
if (et == AuditType || et == EveryType) && sc.AuditConfig != nil && sc.AuditConfig.FilterOverrides != nil {
if err := sc.AuditConfig.FilterOverrides.Validate(); err != nil {
return fmt.Errorf("%s: invalid audit config: %w", op, err)
}
}
}
return nil
}
// StderrSinkTypeConfig contains configuration structures for file sink types
type StderrSinkTypeConfig struct{}
// FileSinkTypeConfig contains configuration structures for file sink types
type FileSinkTypeConfig struct {
Path string `hcl:"path" mapstructure:"path"` // Path defines the file path for the sink
FileName string `hcl:"file_name" mapstructure:"file_name"` // FileName defines the file name for the sink
RotateBytes int `hcl:"rotate_bytes" mapstructure:"rotate_bytes"` // RotateBytes defines the number of bytes that should trigger rotation of a FileSink
RotateDuration time.Duration `mapstructure:"rotate_duration"` // RotateDuration defines how often a FileSink should be rotated
RotateDurationHCL string `hcl:"rotate_duration" json:"-"` // RotateDurationHCL defines hcl string version of RotateDuration
RotateMaxFiles int `hcl:"rotate_max_files" mapstructure:"rotate_max_files"` // RotateMaxFiles defines how may historical rotated files should be kept for a FileSink
}
// WriterSinkTypeConfig contains configuration structures for writer sink types
type WriterSinkTypeConfig struct {
Writer io.Writer `hcl:"-" mapstructure:"-"` // The writer to write to
}
// FilterType defines a type for filters (allow or deny)
type FilterType string
const (
AllowFilter FilterType = "allow" // AllowFilter defines a filter type for "allow"
DenyFilter FilterType = "deny" // DenyFilter defines a filter type for "deny"
)
// SinkFilter defines an event filter (allow or deny) for a sink
type SinkFilter struct {
Type FilterType `hcl:"type"` // Type of filter (allow or deny)
Filter string `hcl:"filter"` // Filter in a format supported by hashicorp/go-bexpr.
}
// Validate a SinkFilter
func (s SinkFilter) Validate() error {
const op = "event.(SinkFilter).Validate"
switch s.Type {
case AllowFilter, DenyFilter:
default:
return fmt.Errorf("%s: invalid filter type %s: %w", op, s.Type, ErrInvalidParameter)
}
_, err := newFilter(s.Filter)
if err != nil {
return fmt.Errorf("%s: invalid filter '%s': %w", op, s.Filter, err)
}
return nil
}