googlecloud

Documentation

Index

• type Client
• type ClientBuilder
• type EntryBuilder
• type GoogleCloudOutput
  • func (g *GoogleCloudOutput) Process(ctx context.Context, e *entry.Entry) error
  • func (g *GoogleCloudOutput) Start() error
  • func (g *GoogleCloudOutput) Stop() error
• type GoogleCloudOutputConfig
  • func NewGoogleCloudOutputConfig(operatorID string) *GoogleCloudOutputConfig
  • func (c GoogleCloudOutputConfig) Build(bc operator.BuildContext) ([]operator.Operator, error)
• type GoogleEntryBuilder
  • func (g *GoogleEntryBuilder) Build(entry *entry.Entry) (*logging.LogEntry, error)
• type GoogleRequestBuilder
  • func (g *GoogleRequestBuilder) Build(entries []*entry.Entry) []*logging.WriteLogEntriesRequest
• type RequestBuilder
• type ResourceKey
• type ResourceType

Types

type Client

type Client interface {
	WriteLogEntries(ctx context.Context, req *logging.WriteLogEntriesRequest, opts ...gax.CallOption) (*logging.WriteLogEntriesResponse, error)
	Close() error
}

Client is an interface for writing entries to google cloud logging

type ClientBuilder

type ClientBuilder = func(ctx context.Context, opts ...option.ClientOption) (Client, error)

ClientBuilder is a function that builds a client

type EntryBuilder

type EntryBuilder interface {
	Build(entry *entry.Entry) (*logging.LogEntry, error)
}

EntryBuilder is an interface for building google cloud logging entries

type GoogleCloudOutput

type GoogleCloudOutput struct {
	helper.OutputOperator
	// contains filtered or unexported fields
}

GoogleCloudOutput is an operator that sends logs to google cloud logging.

func (*GoogleCloudOutput) Process

func (g *GoogleCloudOutput) Process(ctx context.Context, e *entry.Entry) error

Process adds an incoming entry to the buffer

func (*GoogleCloudOutput) Start

func (g *GoogleCloudOutput) Start() error

Start will start the google cloud operator

func (*GoogleCloudOutput) Stop

func (g *GoogleCloudOutput) Stop() error

Stop will stop the google cloud operator

type GoogleCloudOutputConfig

type GoogleCloudOutputConfig struct {
	helper.OutputConfig `yaml:",inline"`
	BufferConfig        buffer.Config   `json:"buffer,omitempty" yaml:"buffer,omitempty"`
	FlusherConfig       flusher.Config  `json:"flusher,omitempty" yaml:"flusher,omitempty"`
	Credentials         string          `json:"credentials,omitempty"      yaml:"credentials,omitempty"`
	CredentialsFile     string          `json:"credentials_file,omitempty" yaml:"credentials_file,omitempty"`
	ProjectID           string          `json:"project_id"                 yaml:"project_id"`
	LogNameField        *entry.Field    `json:"log_name_field,omitempty"   yaml:"log_name_field,omitempty"`
	LocationField       *entry.Field    `json:"location_field,omitempty"   yaml:"location_field,omitempty"`
	TraceField          *entry.Field    `json:"trace_field,omitempty"      yaml:"trace_field,omitempty"`
	SpanIDField         *entry.Field    `json:"span_id_field,omitempty"    yaml:"span_id_field,omitempty"`
	Timeout             helper.Duration `json:"timeout,omitempty"          yaml:"timeout,omitempty"`
	UseCompression      bool            `json:"use_compression,omitempty"  yaml:"use_compression,omitempty"`
	MaxEntrySize        helper.ByteSize `json:"max_entry_size"             yaml:"max_entry_size"`
	MaxRequestSize      helper.ByteSize `json:"max_request_size"           yaml:"max_request_size"`
}

GoogleCloudOutputConfig is the configuration of a google cloud output operator.

func NewGoogleCloudOutputConfig

func NewGoogleCloudOutputConfig(operatorID string) *GoogleCloudOutputConfig

NewGoogleCloudOutputConfig creates a new google cloud output config with default

func (GoogleCloudOutputConfig) Build

func (c GoogleCloudOutputConfig) Build(bc operator.BuildContext) ([]operator.Operator, error)

Build will build a google cloud output operator.

type GoogleEntryBuilder

type GoogleEntryBuilder struct {
	MaxEntrySize  int
	ProjectID     string
	LogNameField  *entry.Field
	LocationField *entry.Field
	TraceField    *entry.Field
	SpanIDField   *entry.Field
}

GoogleEntryBuilder is used to build google cloud logging entries

func (*GoogleEntryBuilder) Build

func (g *GoogleEntryBuilder) Build(entry *entry.Entry) (*logging.LogEntry, error)

Build builds a google cloud logging entry from a stanza entry. The size of the resulting entry is also returned.

type GoogleRequestBuilder

type GoogleRequestBuilder struct {
	MaxRequestSize int
	ProjectID      string
	EntryBuilder   EntryBuilder
	*zap.SugaredLogger
}

GoogleRequestBuilder builds google cloud logging requests

func (*GoogleRequestBuilder) Build

func (g *GoogleRequestBuilder) Build(entries []*entry.Entry) []*logging.WriteLogEntriesRequest

Build builds a series of write requests from stanza entries

type RequestBuilder

type RequestBuilder interface {
	Build(entries []*entry.Entry) []*logging.WriteLogEntriesRequest
}

RequestBuilder is an interface for creating requests to the google logging API

type ResourceKey

type ResourceKey = string

ResourceKey is a key used to distinguish a resource

type ResourceType

type ResourceType = string

ResourceType is a monitored resource type