[receiver/windowseventlog] Add Windows Event Log Receiver #9228

armstrmi · 2022-04-12T15:21:33Z

Description:

Added Windows Event Logging Functionality based on the corresponding log-collection operator.

Link to tracking Issue:
(#9225)

Testing:
windowslog_test.go verifies that event logs can be read from the Windows API

Documentation:

(See README)

jpkrohling · 2022-04-12T15:55:51Z

This is still pending a sponsor.

djaglowski

Since this receiver can only run on windows, please add a dummy implementation for non-windows systems, to ensure users get a clear error message.

go.mod

receiver/windowslogreceiver/README.md

CHANGELOG.md

receiver/windowslogreceiver/README.md

go.mod

djaglowski · 2022-04-14T16:14:40Z

receiver/windowslogreceiver/testdata/simple.log

@@ -0,0 +1,3 @@
+2020-08-25 INFO Something routine


Is this file used?

receiver/windowslogreceiver/windowslog.go

receiver/windowslogreceiver/windowslog_test.go

armstrmi · 2022-04-15T18:04:38Z

Realize lots more files changed with this previous commit, will fix that momentarily

djaglowski

Code looks good, but I've recently learned that windows unit tests are not currently running by default. For now, can you add a dedicated step to the build-and-test-windows.yml, like https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/9334/files#diff-5ca69371a0b431061a0b1b145a164ac5797c6a8bd745fba6061e3afe213318fd?

armstrmi · 2022-04-22T18:38:52Z

Will be holding off on closing this PR due to the following reasons.

During integration tests, we noticed that certain fields of the Windows Event Log was not being populated by the receiver. Upon further inspection we notice that in our implemented code, to scrape some of the fields: message,level, opcode, etc. from the xml format, it would be under the header RenderingInfo. Unfortunately that RenderingInfo header only applies to events that have been collected by the Windows Event Collector, otherwise it simply does not exist in the XML of the log.

The underlying log-collection code that collects windows event logs should really collect from any service not just logs generated by the Windows Event Collector service. We have identified some changes we can make to the underlying code to make it more flexible.

We will be submitting an issue against the opentelemtry-log-collection repo detailing a proposed fix and work on the implementation.

This PR will be blocked by the above changes to the log-collection code.

djaglowski · 2022-05-24T17:11:06Z

@armstrmi, #10187 switched all of the other log-collection operators over to using pkg/stanza instead. Will you please update this PR to do the same?

djaglowski

Let's simplify the file organization. We should follow the typical naming convention for files differentiated by OS, which is to append _windows.go, _others.go, and correspondingly _windows_test.go and others_test.go.

I see that you've deduplicated some code by having windowslog.go for all OS's, but it's easier to understand the overall layout of the operator if these two sets of files are cleanly separated.

djaglowski

Aside from the file naming/organization changes and a couple nits, this looks good.

go.mod

cmd/configschema/go.mod

receiver/windowseventlogreceiver/windowslog_test.go

added functionality for windows-log-event

djaglowski · 2022-05-25T23:49:52Z

@armstrmi, looks good except a check is failing:

go.mod/go.sum deps changes detected, please run "make gotidy" and commit the changes in this PR.
Error: Process completed with exit code 1.

djaglowski

LGTM. Thanks @armstrmi!

…etry#9228) * initial commit added functionality for windows-log-event * fixed go.sum files * updated README * added windows event log to receivers_test * go mod tidy and added build flags * updated package name * dummy implementation created * updated versions.yaml and codeowners * updated logs received time * updated changelog with windoweventlogreceiver * cleaned up dependencies * initial commit added functionality for windows-log-event * fixed go.sum files * updated README * added windows event log to receivers_test * go mod tidy and added build flags * updated package name * updated xml_test to expect an array of interfaces * updated wait time for receiving event logs * fix winperfcounters * updated go.mod to point to latest otel-log-collection * removed otel log collection dependency * go mod tidy * added changes to go.sum and reordered file naming/organization * ran make gotidy * updated internal stanza version * updated pkg/stanza for WEL * added go.sum changes * make gotidy

armstrmi requested review from a team and jpkrohling April 12, 2022 15:21

github-actions bot assigned dashpole Apr 12, 2022

armstrmi force-pushed the windows-event-log branch from df4ee46 to d0fe705 Compare April 12, 2022 20:47

armstrmi requested a review from dmitryax as a code owner April 12, 2022 20:47

armstrmi force-pushed the windows-event-log branch from d0fe705 to fccc4fa Compare April 12, 2022 20:50

djaglowski changed the title ~~Windows event log~~ [receiver/windowslog] Add Windows Event Log Receiver Apr 14, 2022

djaglowski changed the title ~~[receiver/windowslog] Add Windows Event Log Receiver~~ [receiver/windowseventlog] Add Windows Event Log Receiver Apr 14, 2022

djaglowski reviewed Apr 14, 2022

View reviewed changes

armstrmi requested review from Aneurysm9, dashpole, jsuereth and punya as code owners April 15, 2022 18:02

djaglowski reviewed Apr 18, 2022

View reviewed changes

armstrmi mentioned this pull request Apr 26, 2022

Fix Windows Log Event XML parsing open-telemetry/opentelemetry-log-collection#476

Closed

armstrmi force-pushed the windows-event-log branch 2 times, most recently from e2fa721 to e2a33f4 Compare May 5, 2022 19:01

armstrmi mentioned this pull request May 9, 2022

[internal/stanza] Add support for []string in converter.go #9887

Merged

armstrmi requested a review from djaglowski May 10, 2022 17:17

armstrmi force-pushed the windows-event-log branch from 5bf91ff to f1f26e3 Compare May 10, 2022 19:20

armstrmi force-pushed the windows-event-log branch 3 times, most recently from 738744d to 58db7cc Compare May 20, 2022 13:20

armstrmi force-pushed the windows-event-log branch from 58db7cc to bff6453 Compare May 24, 2022 20:13

djaglowski reviewed May 25, 2022

View reviewed changes

go.mod Outdated Show resolved Hide resolved

cmd/configschema/go.mod Outdated Show resolved Hide resolved

receiver/windowseventlogreceiver/windowslog_test.go Outdated Show resolved Hide resolved

receiver/windowseventlogreceiver/windowslog_test.go Outdated Show resolved Hide resolved

armstrmi added 20 commits May 25, 2022 16:32

dummy implementation created

f2698ff

updated versions.yaml and codeowners

b1928f4

updated logs received time

1f7616f

updated changelog with windoweventlogreceiver

fbb9de2

cleaned up dependencies

d8c6391

initial commit

44cd3d7

added functionality for windows-log-event

fixed go.sum files

2d8f97d

updated README

ebbbaed

added windows event log to receivers_test

7850c6d

go mod tidy and added build flags

8fd88db

updated package name

3a5b465

updated xml_test to expect an array of interfaces

11b8fa8

updated wait time for receiving event logs

b3b9c1a

fix winperfcounters

a9f0e28

updated go.mod to point to latest otel-log-collection

133cc1f

removed otel log collection dependency

7badb46

go mod tidy

ad77599

added changes to go.sum and reordered file naming/organization

890851e

ran make gotidy

3017cb8

updated internal stanza version

d3ed683

armstrmi force-pushed the windows-event-log branch from 457c133 to d3ed683 Compare May 25, 2022 20:35

armstrmi added 2 commits May 25, 2022 16:38

updated pkg/stanza for WEL

a8b4e95

added go.sum changes

cd8dcbc

make gotidy

81f33cd

djaglowski approved these changes May 26, 2022

View reviewed changes

djaglowski merged commit cd59728 into open-telemetry:main May 26, 2022

armstrmi deleted the windows-event-log branch May 26, 2022 15:29

djaglowski mentioned this pull request Aug 15, 2022

New component: Windows Event Log Receiver #9225

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[receiver/windowseventlog] Add Windows Event Log Receiver #9228

[receiver/windowseventlog] Add Windows Event Log Receiver #9228

armstrmi commented Apr 12, 2022 •

edited by djaglowski

Loading

jpkrohling commented Apr 12, 2022

djaglowski left a comment

djaglowski Apr 14, 2022

armstrmi commented Apr 15, 2022

djaglowski left a comment

armstrmi commented Apr 22, 2022

djaglowski commented May 24, 2022

djaglowski left a comment •

edited

Loading

djaglowski left a comment

djaglowski commented May 25, 2022

djaglowski left a comment

[receiver/windowseventlog] Add Windows Event Log Receiver #9228

[receiver/windowseventlog] Add Windows Event Log Receiver #9228

Conversation

armstrmi commented Apr 12, 2022 • edited by djaglowski Loading

jpkrohling commented Apr 12, 2022

djaglowski left a comment

Choose a reason for hiding this comment

djaglowski Apr 14, 2022

Choose a reason for hiding this comment

armstrmi commented Apr 15, 2022

djaglowski left a comment

Choose a reason for hiding this comment

armstrmi commented Apr 22, 2022

djaglowski commented May 24, 2022

djaglowski left a comment • edited Loading

Choose a reason for hiding this comment

djaglowski left a comment

Choose a reason for hiding this comment

djaglowski commented May 25, 2022

djaglowski left a comment

Choose a reason for hiding this comment

armstrmi commented Apr 12, 2022 •

edited by djaglowski

Loading

djaglowski left a comment •

edited

Loading