Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

structured logs and logfile rollover features #2311

Merged
merged 7 commits into from
Dec 19, 2019
Merged

structured logs and logfile rollover features #2311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
60b3ed1
refactor seelog code and add new formatters (logfmt and json)
sparrc Dec 12, 2019
fe879f4
dep ensure
sparrc Dec 13, 2019
7dba0f4
Parse config variables
sparrc Dec 13, 2019
18bf788
Apply configuration to audit log
sparrc Dec 16, 2019
d25a549
Fix audit log path in functional tests
sparrc Dec 17, 2019
a10b413
unit test log formatter functions
sparrc Dec 18, 2019
2034013
Fix windows unit tests
sparrc Dec 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions agent/Gopkg.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion agent/Gopkg.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ required = ["github.com/golang/mock/mockgen/model"]

[[constraint]]
name = "github.com/cihub/seelog"
version ="2.6"
revision = "f561c5e57575bb1e0a2167028b7339b3a8d16fb4"

[[constraint]]
name = "github.com/containerd/cgroups"
Expand Down
17 changes: 7 additions & 10 deletions agent/acs/update_handler/updater.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import (
"github.com/aws/amazon-ecs-agent/agent/config"
"github.com/aws/amazon-ecs-agent/agent/engine"
"github.com/aws/amazon-ecs-agent/agent/httpclient"
"github.com/aws/amazon-ecs-agent/agent/logger"
"github.com/aws/amazon-ecs-agent/agent/sighandlers"
"github.com/aws/amazon-ecs-agent/agent/sighandlers/exitcodes"
"github.com/aws/amazon-ecs-agent/agent/statemanager"
Expand All @@ -40,8 +39,6 @@ import (
"github.com/cihub/seelog"
)

var log = logger.ForModule("updater")

const desiredImageFile = "desired-image"

// update describes metadata around an update 2-phase request
Expand Down Expand Up @@ -93,7 +90,7 @@ func (u *updater) stageUpdateHandler() func(req *ecsacs.StageUpdateMessage) {
defer u.Unlock()

if req == nil || req.MessageId == nil {
log.Error("Nil request to stage update or missing MessageID")
seelog.Error("Nil request to stage update or missing MessageID")
return
}

Expand All @@ -118,11 +115,11 @@ func (u *updater) stageUpdateHandler() func(req *ecsacs.StageUpdateMessage) {
return
}

log.Debug("Staging update", "update", req)
seelog.Debug("Staging update", "update", req)

if u.stage != updateNone {
if u.updateID != "" && u.updateID == *req.UpdateInfo.Signature {
log.Debug("Update already in progress, acking duplicate message", "id", u.updateID)
seelog.Debug("Update already in progress, acking duplicate message", "id", u.updateID)
// Acking here is safe as any currently-downloading update will already be holding
// the update lock. A failed download will nack and clear state (while holding the
// update lock) before this code is reached, meaning that the above conditional will
Expand Down Expand Up @@ -215,7 +212,7 @@ func (u *updater) performUpdateHandler(saver statemanager.Saver, taskEngine engi
u.Lock()
defer u.Unlock()

log.Debug("Got perform update request")
seelog.Debug("Got perform update request")

if !u.config.UpdatesEnabled {
reason := "Updates are disabled"
Expand All @@ -230,7 +227,7 @@ func (u *updater) performUpdateHandler(saver statemanager.Saver, taskEngine engi
}

if u.stage != updateDownloaded {
log.Error("Nacking PerformUpdate; not downloaded")
seelog.Error("Nacking PerformUpdate; not downloaded")
reason := "Cannot perform update; update not downloaded"
u.acs.MakeRequest(&ecsacs.NackRequest{
Cluster: req.ClusterArn,
Expand All @@ -248,9 +245,9 @@ func (u *updater) performUpdateHandler(saver statemanager.Saver, taskEngine engi

err := sighandlers.FinalSave(saver, taskEngine)
if err != nil {
log.Crit("Error saving before update exit", "err", err)
seelog.Critical("Error saving before update exit", "err", err)
} else {
log.Debug("Saved state!")
seelog.Debug("Saved state!")
}
u.fs.Exit(exitcodes.ExitUpdate)
}
Expand Down
19 changes: 8 additions & 11 deletions agent/engine/dockerstate/docker_task_engine_state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,9 @@ import (
apieni "github.com/aws/amazon-ecs-agent/agent/api/eni"
apitask "github.com/aws/amazon-ecs-agent/agent/api/task"
"github.com/aws/amazon-ecs-agent/agent/engine/image"
"github.com/aws/amazon-ecs-agent/agent/logger"
"github.com/cihub/seelog"
)

var log = logger.ForModule("dockerstate")

// TaskEngineState keeps track of all mappings between tasks we know about
// and containers docker runs
type TaskEngineState interface {
Expand Down Expand Up @@ -201,7 +198,7 @@ func (state *DockerTaskEngineState) ENIByMac(mac string) (*apieni.ENIAttachment,
// AddENIAttachment adds the eni into the state
func (state *DockerTaskEngineState) AddENIAttachment(eniAttachment *apieni.ENIAttachment) {
if eniAttachment == nil {
log.Debug("Cannot add empty eni attachment information")
seelog.Debug("Cannot add empty eni attachment information")
return
}

Expand All @@ -219,7 +216,7 @@ func (state *DockerTaskEngineState) AddENIAttachment(eniAttachment *apieni.ENIAt
// RemoveENIAttachment removes the eni from state and stop managing
func (state *DockerTaskEngineState) RemoveENIAttachment(mac string) {
if mac == "" {
log.Debug("Cannot remove empty eni attachment information")
seelog.Debug("Cannot remove empty eni attachment information")
return
}
state.lock.Lock()
Expand Down Expand Up @@ -326,13 +323,13 @@ func (state *DockerTaskEngineState) AddContainer(container *apicontainer.DockerC
state.lock.Lock()
defer state.lock.Unlock()
if task == nil || container == nil {
log.Crit("Addcontainer called with nil task/container")
seelog.Critical("Addcontainer called with nil task/container")
return
}

_, exists := state.tasks[task.Arn]
if !exists {
log.Debug("AddContainer called with unknown task; adding", "arn", task.Arn)
seelog.Debug("AddContainer called with unknown task; adding", "arn", task.Arn)
state.tasks[task.Arn] = task
}

Expand All @@ -357,11 +354,11 @@ func (state *DockerTaskEngineState) AddContainer(container *apicontainer.DockerC
// AddImageState adds an image.ImageState to be stored
func (state *DockerTaskEngineState) AddImageState(imageState *image.ImageState) {
if imageState == nil {
log.Debug("Cannot add empty image state")
seelog.Debug("Cannot add empty image state")
return
}
if imageState.Image.ImageID == "" {
log.Debug("Cannot add image state with empty image id")
seelog.Debug("Cannot add image state with empty image id")
return
}
state.lock.Lock()
Expand Down Expand Up @@ -455,15 +452,15 @@ func (state *DockerTaskEngineState) removeV3EndpointIDToTaskContainerUnsafe(v3En
// RemoveImageState removes an image.ImageState
func (state *DockerTaskEngineState) RemoveImageState(imageState *image.ImageState) {
if imageState == nil {
log.Debug("Cannot remove empty image state")
seelog.Debug("Cannot remove empty image state")
return
}
state.lock.Lock()
defer state.lock.Unlock()

imageState, ok := state.imageStates[imageState.Image.ImageID]
if !ok {
log.Debug("Image State is not found. Cannot be removed")
seelog.Debug("Image State is not found. Cannot be removed")
return
}
delete(state.imageStates, imageState.Image.ImageID)
Expand Down
6 changes: 3 additions & 3 deletions agent/functional_tests/tests/functionaltests_unix_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ func taskIAMRoles(networkMode string, agent *TestAgent, t *testing.T) {
require.Equal(t, 0, containerMetaData.State.ExitCode, fmt.Sprintf("Container exit code non-zero: %v", containerMetaData.State.ExitCode))

// Search the audit log to verify the credential request
err = utils.SearchStrInDir(filepath.Join(agent.TestDir, "log"), "audit.log.", *task.TaskArn)
err = utils.SearchStrInDir(filepath.Join(agent.TestDir, "log"), "audit.log", *task.TaskArn)
require.NoError(t, err, "Verify credential request failed")
}

Expand Down Expand Up @@ -807,8 +807,8 @@ func TestExecutionRole(t *testing.T) {
assert.Len(t, resp.Events, 1, fmt.Sprintf("Get unexpected number of log events: %d", len(resp.Events)))
assert.Equal(t, *resp.Events[0].Message, "hello world", fmt.Sprintf("Got log events message unexpected: %s", *resp.Events[0].Message))
// Search the audit log to verify the credential request from awslogs driver
err = utils.SearchStrInDir(filepath.Join(agent.TestDir, "log"), "audit.log.", "GetCredentialsExecutionRole")
err = utils.SearchStrInDir(filepath.Join(agent.TestDir, "log"), "audit.log.", *testTask.TaskArn)
err = utils.SearchStrInDir(filepath.Join(agent.TestDir, "log"), "audit.log", "GetCredentialsExecutionRole")
err = utils.SearchStrInDir(filepath.Join(agent.TestDir, "log"), "audit.log", *testTask.TaskArn)
require.NoError(t, err, "Verify credential request failed")
}

Expand Down
38 changes: 38 additions & 0 deletions agent/logger/audit/audit_log.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,23 @@ package audit

import (
"fmt"
"strconv"

"github.com/aws/amazon-ecs-agent/agent/config"
"github.com/aws/amazon-ecs-agent/agent/logger"
"github.com/aws/amazon-ecs-agent/agent/logger/audit/request"
)

type AuditLogger interface {
Log(r request.LogRequest, httpResponseCode int, eventType string)
GetContainerInstanceArn() string
GetCluster() string
}

type InfoLogger interface {
Info(i ...interface{})
}

type auditLog struct {
containerInstanceArn string
cluster string
Expand Down Expand Up @@ -62,3 +74,29 @@ func (a *auditLog) GetCluster() string {
func (a *auditLog) GetContainerInstanceArn() string {
return a.containerInstanceArn
}

func AuditLoggerConfig(cfg *config.Config) string {
config := `
<seelog type="asyncloop" minlevel="info">
<outputs formatid="main">
<console />`
if cfg.CredentialsAuditLogFile != "" {
if logger.Config.RolloverType == "size" {
config += `
<rollingfile filename="` + cfg.CredentialsAuditLogFile + `" type="size"
maxsize="` + strconv.Itoa(int(logger.Config.MaxFileSizeMB*1000000)) + `" archivetype="none" maxrolls="` + strconv.Itoa(logger.Config.MaxRollCount) + `" />`
} else {
config += `
<rollingfile filename="` + cfg.CredentialsAuditLogFile + `" type="date"
datepattern="2006-01-02-15" archivetype="none" maxrolls="` + strconv.Itoa(logger.Config.MaxRollCount) + `" />`
}
}
config += `
</outputs>
<formats>
<format id="main" format="%Msg%n" />
</formats>
</seelog>
`
return config
}
26 changes: 0 additions & 26 deletions agent/logger/audit/interface.go
View file
Open in desktop

This file was deleted.

35 changes: 0 additions & 35 deletions agent/logger/audit/seelog_config.go
View file
Open in desktop

This file was deleted.

Loading