logging

Documentation

Overview

Package logging contains utility functions for ECS logging.

Package logging contains utility functions for ECS logging.

Package logging contains utility functions for ECS logging.

Index

• func WriteHumanLogs(w io.Writer, logStringers []HumanJSONStringer) error
• func WriteJSONLogs(w io.Writer, logStringers []HumanJSONStringer) error
• type AppRunnerServiceLogger
  • func NewAppRunnerServiceLogger(opts *NewAppRunnerServiceLoggerOpts) (*AppRunnerServiceLogger, error)
  • func (s *AppRunnerServiceLogger) WriteLogEvents(opts WriteLogEventsOpts) error
• type ECSServiceLogger
  • func NewECSServiceClient(opts *NewWorkloadLoggerOpts) *ECSServiceLogger
  • func (s *ECSServiceLogger) WriteLogEvents(opts WriteLogEventsOpts) error
• type HumanJSONStringer
• type JobLogger
  • func NewJobLogger(opts *NewWorkloadLoggerOpts) *JobLogger
  • func (s *JobLogger) WriteLogEvents(opts WriteLogEventsOpts) error
• type NewAppRunnerServiceLoggerOpts
• type NewWorkloadLoggerOpts
• type TaskClient
  • func NewTaskClient(sess *session.Session, groupName string, tasks []*task.Task) *TaskClient
  • func (t *TaskClient) WriteEventsUntilStopped() error
• type TasksDescriber
• type WriteLogEventsOpts

Functions

func WriteHumanLogs

func WriteHumanLogs(w io.Writer, logStringers []HumanJSONStringer) error

WriteHumanLogs outputs CloudWatch logs in human-readable format.

func WriteJSONLogs

func WriteJSONLogs(w io.Writer, logStringers []HumanJSONStringer) error

WriteJSONLogs outputs CloudWatch logs in JSON format.

Types

type AppRunnerServiceLogger

type AppRunnerServiceLogger struct {
	// contains filtered or unexported fields
}

AppRunnerServiceLogger retrieves the logs of an AppRunner service.

func NewAppRunnerServiceLogger

func NewAppRunnerServiceLogger(opts *NewAppRunnerServiceLoggerOpts) (*AppRunnerServiceLogger, error)

NewAppRunnerServiceLogger returns an AppRunnerServiceLogger for the service under env and app.

func (*AppRunnerServiceLogger) WriteLogEvents

func (s *AppRunnerServiceLogger) WriteLogEvents(opts WriteLogEventsOpts) error

WriteLogEvents writes service logs.

type ECSServiceLogger

type ECSServiceLogger struct {
	// contains filtered or unexported fields
}

ECSServiceLogger retrieves the logs of an Amazon ECS service.

func NewECSServiceClient

func NewECSServiceClient(opts *NewWorkloadLoggerOpts) *ECSServiceLogger

NewECSServiceClient returns an ECSServiceClient for the service under env and app.

func (*ECSServiceLogger) WriteLogEvents

func (s *ECSServiceLogger) WriteLogEvents(opts WriteLogEventsOpts) error

WriteLogEvents writes service logs.

type HumanJSONStringer

type HumanJSONStringer interface {
	HumanString() string
	JSONString() (string, error)
}

HumanJSONStringer can output in both human-readable and JSON format.

type JobLogger

type JobLogger struct {
	// contains filtered or unexported fields
}

JobLogger retrieves the logs of a job.

func NewJobLogger

func NewJobLogger(opts *NewWorkloadLoggerOpts) *JobLogger

NewJobLogger returns an JobLogger for the job under env and app.

func (*JobLogger) WriteLogEvents

func (s *JobLogger) WriteLogEvents(opts WriteLogEventsOpts) error

WriteLogEvents writes job logs.

type NewAppRunnerServiceLoggerOpts

type NewAppRunnerServiceLoggerOpts struct {
	*NewWorkloadLoggerOpts
	ConfigStore describe.ConfigStoreSvc
}

NewAppRunnerServiceLoggerOpts contains fields that initiate AppRunnerServiceLoggerOpts struct.

type NewWorkloadLoggerOpts

type NewWorkloadLoggerOpts struct {
	App  string
	Env  string
	Name string
	Sess *session.Session
}

NewWorkloadLoggerOpts contains fields that initiate workloadLogger struct.

type TaskClient

type TaskClient struct {
	// contains filtered or unexported fields
}

TaskClient retrieves the logs of Amazon ECS tasks.

func NewTaskClient

func NewTaskClient(sess *session.Session, groupName string, tasks []*task.Task) *TaskClient

NewTaskClient returns a TaskClient that can retrieve logs from the given tasks under the groupName.

func (*TaskClient) WriteEventsUntilStopped

func (t *TaskClient) WriteEventsUntilStopped() error

WriteEventsUntilStopped writes tasks' events to a writer until all tasks have stopped.

type TasksDescriber

type TasksDescriber interface {
	DescribeTasks(cluster string, taskARNs []string) ([]*ecs.Task, error)
}

TasksDescriber describes ECS tasks.

type WriteLogEventsOpts

type WriteLogEventsOpts struct {
	Follow    bool
	Limit     *int64
	StartTime *int64
	EndTime   *int64
	// OnEvents is a handler that's invoked when logs are retrieved from the service.
	OnEvents func(w io.Writer, logs []HumanJSONStringer) error
	LogGroup string

	// Job specific options.
	IncludeStateMachineLogs bool
	// LogStreamLimit is an optional parameter for jobs and tasks to speed up CW queries
	// involving multiple log streams.
	LogStreamLimit int

	// ECS specific options.
	ContainerName string
	TaskIDs       []string
}

WriteLogEventsOpts wraps the parameters to call WriteLogEvents.