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

Small improvements to logging and flares #1667

Merged
merged 8 commits into from
Apr 4, 2024
Merged

Small improvements to logging and flares #1667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a018a8c
improve service manager log gathering
directionless Apr 2, 2024
1814b78
don't log the full results. It's way too noisy
directionless Apr 2, 2024
34d24c9
fixee
directionless Apr 3, 2024
ad43c06
upgrade golang.org/x/net for vulnerability
directionless Apr 3, 2024
d7cfc76
Update ee/debug/checkups/services_windows.go
directionless Apr 4, 2024
4ac1048
Update ee/debug/checkups/services_windows.go
directionless Apr 4, 2024
73fc79b
capture stderr:
directionless Apr 4, 2024
453a523
go.sum merge strategy
directionless Apr 4, 2024
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
2 changes: 2 additions & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# set line endings got go files. Mostly needed for golang-ci
*.go text eol=lf

# go.sum merges can just concat. Cuts down on merge conflicts
go.sum merge=union
2 changes: 1 addition & 1 deletion ee/debug/checkups/init_logs_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
)

func writeInitLogs(ctx context.Context, logZip *zip.Writer) error {
cmdStr := `Get-WinEvent -FilterHashtable @{LogName='Application'; ProviderName='launcher'} | ForEach-Object { $_.Message }`
cmdStr := `Get-WinEvent -FilterHashtable @{LogName='Application'; ProviderName='launcher'} | ConvertTo-Json`
cmd, err := allowedcmd.Powershell(ctx, cmdStr)
if err != nil {
return fmt.Errorf("creating powershell command: %w", err)
Expand Down
45 changes: 41 additions & 4 deletions ee/debug/checkups/services_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ func (s *servicesCheckup) Run(ctx context.Context, extraWriter io.Writer) error
return fmt.Errorf("gathering service manager event logs: %w", err)
}

if err := gatherServiceManagerEvents(ctx, extraZip); err != nil {
return fmt.Errorf("gathering service manager events: %w", err)
}

return nil
}

Expand Down Expand Up @@ -228,15 +232,47 @@ func gatherServices(z *zip.Writer, serviceManager *mgr.Mgr) error {
return nil
}

// gatherServiceManagerEvents uses Get-WinEvent to fetch the service manager logs. This might be newer than Get-EventLog
func gatherServiceManagerEvents(ctx context.Context, z *zip.Writer) error {
out, err := z.Create("eventlog-Get-WinEvent.json")
if err != nil {
return fmt.Errorf("creating eventlog-Get-WinEvent.json: %w", err)
}

filterExpression := fmt.Sprintf(`@{LogName='System'; ProviderName='Service Control Manager'; Data='%s'}`, kolideSvcName)

cmdArgs := []string{
"Get-WinEvent",
"-MaxEvents 100",
"-FilterHashtable", filterExpression,
"|",
"ConvertTo-Json",
}
RebeccaMahany marked this conversation as resolved.
Show resolved Hide resolved

cmd, err := allowedcmd.Powershell(ctx, cmdArgs...)
if err != nil {
return fmt.Errorf("creating powershell command: %w", err)
}
hideWindow(cmd)
cmd.Stdout = out
cmd.Stderr = out
if err := cmd.Run(); err != nil {
return fmt.Errorf("running Get-WinEvent: error %w", err)
}

return nil
}

// gatherServiceManagerEventLogs uses Get-EventLog to getch service manager logs. This might be a legacy path
func gatherServiceManagerEventLogs(ctx context.Context, z *zip.Writer) error {
eventLogOut, err := z.Create("eventlog.txt")
eventLogOut, err := z.Create("eventlog-Get-EventLog.txt")
if err != nil {
return fmt.Errorf("creating eventlog.txt: %w", err)
return fmt.Errorf("creating eventlog-Get-EventLog.txt: %w", err)
}

cmdletArgs := []string{
"Get-EventLog",
"-Newest", "50",
"-Newest", "100",
"-LogName", "System",
"-Source", "\"Service Control Manager\"",
"-Message", fmt.Sprintf("*%s*", kolideSvcName),
Expand All @@ -249,7 +285,8 @@ func gatherServiceManagerEventLogs(ctx context.Context, z *zip.Writer) error {
return fmt.Errorf("creating powershell command: %w", err)
}
hideWindow(getEventLogCmd)
getEventLogCmd.Stdout = eventLogOut // write directly to zip
getEventLogCmd.Stdout = eventLogOut
getEventLogCmd.Stderr = eventLogOut
if err := getEventLogCmd.Run(); err != nil {
return fmt.Errorf("running Get-EventLog: error %w", err)
}
Expand Down
9 changes: 9 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,8 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
Expand Down Expand Up @@ -389,6 +391,8 @@ golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwY
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs=
golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
Expand Down Expand Up @@ -429,6 +433,8 @@ golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBc
golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
Expand All @@ -438,6 +444,9 @@ golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuX
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
golang.org/x/term v0.18.0 h1:FcHjZXDMxI8mM3nwhX9HlKop4C0YQvCVCdwYl2wOtE8=
golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
golang.org/x/term v0.15.0 h1:y/Oo/a/q3IXu26lQgl04j/gjuBDOBlx7X6Om1j2CPW4=
golang.org/x/term v0.15.0/go.mod h1:BDl952bC7+uMoWR75FIrCDx79TPU9oHkTZ9yRbYOrX0=
golang.org/x/term v0.18.0 h1:FcHjZXDMxI8mM3nwhX9HlKop4C0YQvCVCdwYl2wOtE8=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
Expand Down
9 changes: 8 additions & 1 deletion pkg/service/publish_results.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,11 @@ func (s *grpcServer) PublishResults(ctx context.Context, req *pb.ResultCollectio
func (mw logmw) PublishResults(ctx context.Context, nodeKey string, results []distributed.Result) (message, errcode string, reauth bool, err error) {
defer func(begin time.Time) {
resJSON, _ := json.Marshal(results)
resTruncated := string(resJSON[:200])
directionless marked this conversation as resolved.
Show resolved Hide resolved
if len(resJSON) > 200 {
resTruncated += "..."
}

uuid, _ := uuid.FromContext(ctx)

if message == "" {
Expand All @@ -197,7 +202,9 @@ func (mw logmw) PublishResults(ctx context.Context, nodeKey string, results []di
mw.knapsack.Slogger().Log(ctx, levelForError(err), message, // nolint:sloglint // it's fine to not have a constant or literal here
"method", "PublishResults",
"uuid", uuid,
"results", string(resJSON),
"results_truncated", resTruncated,
"result_count", len(results),
"result_size", len(resJSON),
"errcode", errcode,
"reauth", reauth,
"err", err,
Expand Down
Loading