cloudwatchlogs

package
v0.2.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 21, 2020 License: MIT Imports: 11 Imported by: 0

README

aws-sdk-go-v2-wrapper | Cloudwatch Logs

Quick Usage

import (
	"context"
	"encoding/json"
	"strings"

	"github.com/evalphobia/aws-sdk-go-v2-wrapper/cloudwatchlogs"
	"github.com/evalphobia/aws-sdk-go-v2-wrapper/config"
)

func main() {
	svc, err := cloudwatchlogs.New(config.Config{
		AccessKey: "<...>",
		SecretKey: "<...>",
	})
	if err != nil {
		panic(err)
	}
	ctx := context.Background()

	filterValues := []string{
		`fields @timestamp, @message, level`,
		`| filter level = "error"`,
		`| sort @timestamp asc`,
		`| limit 20`,
	}
	// fetch error level logs
	result, err := svc.XQueryResults(ctx, cloudwatchlogs.XQueryResultsRequest{
		LogGroupName: "/aws/lambda/my-lambda-func",
		QueryString:  strings.Join(filterValues, " "),
		StartTime:    time.Now().Add(-1 * 5 * time.Minute), // past 5 mins
		EndTime:      time.Now(),
	})
	switch {
	case err != nil:
		panic(err)
	case len(result.Results) == 0:
		fmt.Printf("No errors are detected.")
	default:
		byt, _ := json.Marshal(res.Results)
		fmt.Printf("Error Hits:[%d], Error Data:[%s]", len(res.Results), string(byt))
	}
	// ...
}

X API

Name Description
XQueryResults executes a query and waits for fetching complete results.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CloudwatchLogs 

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

CloudwatchLogs has CloudwatchLogs client.

func New 

func New(conf config.Config) (*CloudwatchLogs, error)

New returns initialized *CloudwatchLogs.

func (*CloudwatchLogs) Errorf 

func (svc *CloudwatchLogs) Errorf(format string, v ...interface{})

Errorf logging error information.

func (*CloudwatchLogs) GetClient 

func (svc *CloudwatchLogs) GetClient() *SDK.Client

GetClient gets original SDK client.

func (*CloudwatchLogs) GetQueryResults 

func (svc *CloudwatchLogs) GetQueryResults(ctx context.Context, r GetQueryResultsRequest) (*GetQueryResultsResult, error)

GetQueryResults executes `GetQueryResults` operation.

func (*CloudwatchLogs) Infof 

func (svc *CloudwatchLogs) Infof(format string, v ...interface{})

Infof logging information.

func (*CloudwatchLogs) RawAssociateKmsKey 

func (svc *CloudwatchLogs) RawAssociateKmsKey(ctx context.Context, in *SDK.AssociateKmsKeyInput) (*SDK.AssociateKmsKeyResponse, error)

RawAssociateKmsKey executes `AssociateKmsKey` raw operation.

func (*CloudwatchLogs) RawCancelExportTask 

func (svc *CloudwatchLogs) RawCancelExportTask(ctx context.Context, in *SDK.CancelExportTaskInput) (*SDK.CancelExportTaskResponse, error)

RawCancelExportTask executes `CancelExportTask` raw operation.

func (*CloudwatchLogs) RawCreateExportTask 

func (svc *CloudwatchLogs) RawCreateExportTask(ctx context.Context, in *SDK.CreateExportTaskInput) (*SDK.CreateExportTaskResponse, error)

RawCreateExportTask executes `CreateExportTask` raw operation.

func (*CloudwatchLogs) RawCreateLogGroup 

func (svc *CloudwatchLogs) RawCreateLogGroup(ctx context.Context, in *SDK.CreateLogGroupInput) (*SDK.CreateLogGroupResponse, error)

RawCreateLogGroup executes `CreateLogGroup` raw operation.

func (*CloudwatchLogs) RawCreateLogStream 

func (svc *CloudwatchLogs) RawCreateLogStream(ctx context.Context, in *SDK.CreateLogStreamInput) (*SDK.CreateLogStreamResponse, error)

RawCreateLogStream executes `CreateLogStream` raw operation.

func (*CloudwatchLogs) RawDeleteDestination 

func (svc *CloudwatchLogs) RawDeleteDestination(ctx context.Context, in *SDK.DeleteDestinationInput) (*SDK.DeleteDestinationResponse, error)

RawDeleteDestination executes `DeleteDestination` raw operation.

func (*CloudwatchLogs) RawDeleteLogGroup 

func (svc *CloudwatchLogs) RawDeleteLogGroup(ctx context.Context, in *SDK.DeleteLogGroupInput) (*SDK.DeleteLogGroupResponse, error)

RawDeleteLogGroup executes `DeleteLogGroup` raw operation.

func (*CloudwatchLogs) RawDeleteLogStream 

func (svc *CloudwatchLogs) RawDeleteLogStream(ctx context.Context, in *SDK.DeleteLogStreamInput) (*SDK.DeleteLogStreamResponse, error)

RawDeleteLogStream executes `DeleteLogStream` raw operation.

func (*CloudwatchLogs) RawDeleteMetricFilter 

func (svc *CloudwatchLogs) RawDeleteMetricFilter(ctx context.Context, in *SDK.DeleteMetricFilterInput) (*SDK.DeleteMetricFilterResponse, error)

RawDeleteMetricFilter executes `DeleteMetricFilter` raw operation.

func (*CloudwatchLogs) RawDeleteQueryDefinition 

func (svc *CloudwatchLogs) RawDeleteQueryDefinition(ctx context.Context, in *SDK.DeleteQueryDefinitionInput) (*SDK.DeleteQueryDefinitionResponse, error)

RawDeleteQueryDefinition executes `DeleteQueryDefinition` raw operation.

func (*CloudwatchLogs) RawDeleteResourcePolicy 

func (svc *CloudwatchLogs) RawDeleteResourcePolicy(ctx context.Context, in *SDK.DeleteResourcePolicyInput) (*SDK.DeleteResourcePolicyResponse, error)

RawDeleteResourcePolicy executes `DeleteResourcePolicy` raw operation.

func (*CloudwatchLogs) RawDeleteRetentionPolicy 

func (svc *CloudwatchLogs) RawDeleteRetentionPolicy(ctx context.Context, in *SDK.DeleteRetentionPolicyInput) (*SDK.DeleteRetentionPolicyResponse, error)

RawDeleteRetentionPolicy executes `DeleteRetentionPolicy` raw operation.

func (*CloudwatchLogs) RawDeleteSubscriptionFilter 

func (svc *CloudwatchLogs) RawDeleteSubscriptionFilter(ctx context.Context, in *SDK.DeleteSubscriptionFilterInput) (*SDK.DeleteSubscriptionFilterResponse, error)

RawDeleteSubscriptionFilter executes `DeleteSubscriptionFilter` raw operation.

func (*CloudwatchLogs) RawDescribeDestinations 

func (svc *CloudwatchLogs) RawDescribeDestinations(ctx context.Context, in *SDK.DescribeDestinationsInput) (*SDK.DescribeDestinationsResponse, error)

RawDescribeDestinations executes `DescribeDestinations` raw operation.

func (*CloudwatchLogs) RawDescribeExportTasks 

func (svc *CloudwatchLogs) RawDescribeExportTasks(ctx context.Context, in *SDK.DescribeExportTasksInput) (*SDK.DescribeExportTasksResponse, error)

RawDescribeExportTasks executes `DescribeExportTasks` raw operation.

func (*CloudwatchLogs) RawDescribeLogGroups 

func (svc *CloudwatchLogs) RawDescribeLogGroups(ctx context.Context, in *SDK.DescribeLogGroupsInput) (*SDK.DescribeLogGroupsResponse, error)

RawDescribeLogGroups executes `DescribeLogGroups` raw operation.

func (*CloudwatchLogs) RawDescribeLogStreams 

func (svc *CloudwatchLogs) RawDescribeLogStreams(ctx context.Context, in *SDK.DescribeLogStreamsInput) (*SDK.DescribeLogStreamsResponse, error)

RawDescribeLogStreams executes `DescribeLogStreams` raw operation.

func (*CloudwatchLogs) RawDescribeMetricFilters 

func (svc *CloudwatchLogs) RawDescribeMetricFilters(ctx context.Context, in *SDK.DescribeMetricFiltersInput) (*SDK.DescribeMetricFiltersResponse, error)

RawDescribeMetricFilters executes `DescribeMetricFilters` raw operation.

func (*CloudwatchLogs) RawDescribeQueries 

func (svc *CloudwatchLogs) RawDescribeQueries(ctx context.Context, in *SDK.DescribeQueriesInput) (*SDK.DescribeQueriesResponse, error)

RawDescribeQueries executes `DescribeQueries` raw operation.

func (*CloudwatchLogs) RawDescribeQueryDefinitions 

func (svc *CloudwatchLogs) RawDescribeQueryDefinitions(ctx context.Context, in *SDK.DescribeQueryDefinitionsInput) (*SDK.DescribeQueryDefinitionsResponse, error)

RawDescribeQueryDefinitions executes `DescribeQueryDefinitions` raw operation.

func (*CloudwatchLogs) RawDescribeResourcePolicies 

func (svc *CloudwatchLogs) RawDescribeResourcePolicies(ctx context.Context, in *SDK.DescribeResourcePoliciesInput) (*SDK.DescribeResourcePoliciesResponse, error)

RawDescribeResourcePolicies executes `DescribeResourcePolicies` raw operation.

func (*CloudwatchLogs) RawDescribeSubscriptionFilters 

func (svc *CloudwatchLogs) RawDescribeSubscriptionFilters(ctx context.Context, in *SDK.DescribeSubscriptionFiltersInput) (*SDK.DescribeSubscriptionFiltersResponse, error)

RawDescribeSubscriptionFilters executes `DescribeSubscriptionFilters` raw operation.

func (*CloudwatchLogs) RawDisassociateKmsKey 

func (svc *CloudwatchLogs) RawDisassociateKmsKey(ctx context.Context, in *SDK.DisassociateKmsKeyInput) (*SDK.DisassociateKmsKeyResponse, error)

RawDisassociateKmsKey executes `DisassociateKmsKey` raw operation.

func (*CloudwatchLogs) RawFilterLogEvents 

func (svc *CloudwatchLogs) RawFilterLogEvents(ctx context.Context, in *SDK.FilterLogEventsInput) (*SDK.FilterLogEventsResponse, error)

RawFilterLogEvents executes `FilterLogEvents` raw operation.

func (*CloudwatchLogs) RawGetLogEvents 

func (svc *CloudwatchLogs) RawGetLogEvents(ctx context.Context, in *SDK.GetLogEventsInput) (*SDK.GetLogEventsResponse, error)

RawGetLogEvents executes `GetLogEvents` raw operation.

func (*CloudwatchLogs) RawGetLogGroupFields 

func (svc *CloudwatchLogs) RawGetLogGroupFields(ctx context.Context, in *SDK.GetLogGroupFieldsInput) (*SDK.GetLogGroupFieldsResponse, error)

RawGetLogGroupFields executes `GetLogGroupFields` raw operation.

func (*CloudwatchLogs) RawGetLogRecord 

func (svc *CloudwatchLogs) RawGetLogRecord(ctx context.Context, in *SDK.GetLogRecordInput) (*SDK.GetLogRecordResponse, error)

RawGetLogRecord executes `GetLogRecord` raw operation.

func (*CloudwatchLogs) RawGetQueryResults 

func (svc *CloudwatchLogs) RawGetQueryResults(ctx context.Context, in *SDK.GetQueryResultsInput) (*SDK.GetQueryResultsResponse, error)

RawGetQueryResults executes `GetQueryResults` raw operation.

func (*CloudwatchLogs) RawListTagsLogGroup 

func (svc *CloudwatchLogs) RawListTagsLogGroup(ctx context.Context, in *SDK.ListTagsLogGroupInput) (*SDK.ListTagsLogGroupResponse, error)

RawListTagsLogGroup executes `ListTagsLogGroup` raw operation.

func (*CloudwatchLogs) RawPutDestination 

func (svc *CloudwatchLogs) RawPutDestination(ctx context.Context, in *SDK.PutDestinationInput) (*SDK.PutDestinationResponse, error)

RawPutDestination executes `PutDestination` raw operation.

func (*CloudwatchLogs) RawPutDestinationPolicy 

func (svc *CloudwatchLogs) RawPutDestinationPolicy(ctx context.Context, in *SDK.PutDestinationPolicyInput) (*SDK.PutDestinationPolicyResponse, error)

RawPutDestinationPolicy executes `PutDestinationPolicy` raw operation.

func (*CloudwatchLogs) RawPutLogEvents 

func (svc *CloudwatchLogs) RawPutLogEvents(ctx context.Context, in *SDK.PutLogEventsInput) (*SDK.PutLogEventsResponse, error)

RawPutLogEvents executes `PutLogEvents` raw operation.

func (*CloudwatchLogs) RawPutMetricFilter 

func (svc *CloudwatchLogs) RawPutMetricFilter(ctx context.Context, in *SDK.PutMetricFilterInput) (*SDK.PutMetricFilterResponse, error)

RawPutMetricFilter executes `PutMetricFilter` raw operation.

func (*CloudwatchLogs) RawPutQueryDefinition 

func (svc *CloudwatchLogs) RawPutQueryDefinition(ctx context.Context, in *SDK.PutQueryDefinitionInput) (*SDK.PutQueryDefinitionResponse, error)

RawPutQueryDefinition executes `PutQueryDefinition` raw operation.

func (*CloudwatchLogs) RawPutResourcePolicy 

func (svc *CloudwatchLogs) RawPutResourcePolicy(ctx context.Context, in *SDK.PutResourcePolicyInput) (*SDK.PutResourcePolicyResponse, error)

RawPutResourcePolicy executes `PutResourcePolicy` raw operation.

func (*CloudwatchLogs) RawPutRetentionPolicy 

func (svc *CloudwatchLogs) RawPutRetentionPolicy(ctx context.Context, in *SDK.PutRetentionPolicyInput) (*SDK.PutRetentionPolicyResponse, error)

RawPutRetentionPolicy executes `PutRetentionPolicy` raw operation.

func (*CloudwatchLogs) RawPutSubscriptionFilter 

func (svc *CloudwatchLogs) RawPutSubscriptionFilter(ctx context.Context, in *SDK.PutSubscriptionFilterInput) (*SDK.PutSubscriptionFilterResponse, error)

RawPutSubscriptionFilter executes `PutSubscriptionFilter` raw operation.

func (*CloudwatchLogs) RawStartQuery 

func (svc *CloudwatchLogs) RawStartQuery(ctx context.Context, in *SDK.StartQueryInput) (*SDK.StartQueryResponse, error)

RawStartQuery executes `StartQuery` raw operation.

func (*CloudwatchLogs) RawStopQuery 

func (svc *CloudwatchLogs) RawStopQuery(ctx context.Context, in *SDK.StopQueryInput) (*SDK.StopQueryResponse, error)

RawStopQuery executes `StopQuery` raw operation.

func (*CloudwatchLogs) RawTagLogGroup 

func (svc *CloudwatchLogs) RawTagLogGroup(ctx context.Context, in *SDK.TagLogGroupInput) (*SDK.TagLogGroupResponse, error)

RawTagLogGroup executes `TagLogGroup` raw operation.

func (*CloudwatchLogs) RawTestMetricFilter 

func (svc *CloudwatchLogs) RawTestMetricFilter(ctx context.Context, in *SDK.TestMetricFilterInput) (*SDK.TestMetricFilterResponse, error)

RawTestMetricFilter executes `TestMetricFilter` raw operation.

func (*CloudwatchLogs) RawUntagLogGroup 

func (svc *CloudwatchLogs) RawUntagLogGroup(ctx context.Context, in *SDK.UntagLogGroupInput) (*SDK.UntagLogGroupResponse, error)

RawUntagLogGroup executes `UntagLogGroup` raw operation.

func (*CloudwatchLogs) SetLogger 

func (svc *CloudwatchLogs) SetLogger(logger log.Logger)

SetLogger sets logger.

func (*CloudwatchLogs) StartQuery 

func (svc *CloudwatchLogs) StartQuery(ctx context.Context, r StartQueryRequest) (*StartQueryResult, error)

StartQuery executes `StartQuery` operation.

func (*CloudwatchLogs) StopQuery 

func (svc *CloudwatchLogs) StopQuery(ctx context.Context, r StopQueryRequest) (*StopQueryResult, error)

StopQuery executes `StopQuery` operation.

func (*CloudwatchLogs) XQueryResults 

func (svc *CloudwatchLogs) XQueryResults(ctx context.Context, r XQueryResultsRequest) (*GetQueryResultsResult, error)

XQueryResults executes a query and waits for fetching complete results.

type GetQueryResultsRequest 

type GetQueryResultsRequest struct {
	QueryID string
}

GetQueryResultsRequest has parameters for `GetQueryResults` operation.

func (GetQueryResultsRequest) ToInput 

func (r GetQueryResultsRequest) ToInput() *SDK.GetQueryResultsInput

type GetQueryResultsResult 

type GetQueryResultsResult struct {
	Results                  QueryResults
	StatisticsBytesScanned   float64
	StatisticsRecordsMatched float64
	StatisticsRecordsScanned float64
	Status                   QueryStatus
}

func NewGetQueryResultsResult 

func NewGetQueryResultsResult(o *SDK.GetQueryResultsResponse) *GetQueryResultsResult

type QueryResults 

type QueryResults struct {
	List [][]ResultField
}

QueryResults contains results of GetQueryREsults.

func NewQueryResults 

func NewQueryResults(list [][]SDK.ResultField) QueryResults

func (QueryResults) FilterFieldContains 

func (r QueryResults) FilterFieldContains(s string) [][]ResultField

FilterFieldContains filters the result whose field equals given string.

func (QueryResults) FilterFieldEqual 

func (r QueryResults) FilterFieldEqual(s string) [][]ResultField

FilterFieldEqual filters the result whose field equals given string.

func (QueryResults) FilterValueContains 

func (r QueryResults) FilterValueContains(s string) [][]ResultField

FilterValueContains filters the result whose value equals given string.

func (QueryResults) FilterValueEqual 

func (r QueryResults) FilterValueEqual(s string) [][]ResultField

FilterValueEqual filters the result whose value equals given string.

type QueryStatus 

type QueryStatus string
const (
	QueryStatusScheduled QueryStatus = QueryStatus(SDK.QueryStatusScheduled)
	QueryStatusRunning   QueryStatus = QueryStatus(SDK.QueryStatusRunning)
	QueryStatusComplete  QueryStatus = QueryStatus(SDK.QueryStatusComplete)
	QueryStatusFailed    QueryStatus = QueryStatus(SDK.QueryStatusFailed)
	QueryStatusCancelled QueryStatus = QueryStatus(SDK.QueryStatusCancelled)
)

func (QueryStatus) IsCancelled 

func (v QueryStatus) IsCancelled() bool

func (QueryStatus) IsComplete 

func (v QueryStatus) IsComplete() bool

func (QueryStatus) IsFailed 

func (v QueryStatus) IsFailed() bool

func (QueryStatus) IsRunning 

func (v QueryStatus) IsRunning() bool

func (QueryStatus) IsScheduled 

func (v QueryStatus) IsScheduled() bool

type ResultField 

type ResultField struct {
	Field string
	Value string
}

func NewResultField 

func NewResultField(o SDK.ResultField) ResultField

func NewResultFieldList 

func NewResultFieldList(list []SDK.ResultField) []ResultField

type StartQueryRequest 

type StartQueryRequest struct {
	QueryString  string
	StartTime    time.Time
	StartTimeInt int64
	EndTime      time.Time
	EndTimeInt   int64

	// optional
	Limit         int64
	LogGroupName  string
	LogGroupNames []string
}

StartQueryRequest has parameters for `StartQuery` operation.

func (StartQueryRequest) ToInput 

func (r StartQueryRequest) ToInput() *SDK.StartQueryInput

type StartQueryResult 

type StartQueryResult struct {
	QueryID string
}

func NewStartQueryResult 

func NewStartQueryResult(o *SDK.StartQueryResponse) *StartQueryResult

type StopQueryRequest 

type StopQueryRequest struct {
	QueryID string
}

StopQueryRequest has parameters for `StopQuery` operation.

func (StopQueryRequest) ToInput 

func (r StopQueryRequest) ToInput() *SDK.StopQueryInput

type StopQueryResult 

type StopQueryResult struct {
	Success bool
}

func NewStopQueryResult 

func NewStopQueryResult(o *SDK.StopQueryResponse) *StopQueryResult

type XQueryResultsRequest 

type XQueryResultsRequest struct {
	QueryString  string
	StartTime    time.Time
	StartTimeInt int64
	EndTime      time.Time
	EndTimeInt   int64

	// optional
	Limit         int64
	LogGroupName  string
	LogGroupNames []string

	// extension
	MaxRetry int         // default=5
	WaitFunc func(i int) // waiting strategy, default=exponential backoff with full jitter from 1sec
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.