[receiver/filelog] Add settings to annotate file owner and group names #30776

tprelle · 2024-01-25T14:22:22Z

Description: When you want to filter log on a shared host with multiple user, you want to be able to add owner and group of the file log. Currenly this lookup it's not possible so it's hard to filter after.
If include_file_infos is true when reading a file on filelogreceiver, it will add the file owner as the attribute log.file.owner and the file group as the attribute log.file.group.
Link to tracking Issue: #30775

Testing: Add unity test

Documentation: Add documentation on file_input and file log receiver.

linux-foundation-easycla · 2024-01-25T14:22:26Z

The committers listed above are authorized under a signed CLA.

✅ login: tprelle / name: Thomas Prelle (2e6af9f, cb4691a, b626f84, 262b6c8, 7e9c730, 7f26aa4, 1e3b4cf, 459f97c, b575c05)

github-actions · 2024-02-09T05:19:20Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

djaglowski

I thought I had reviewed this earlier but must not have clicked submit. Sorry about that.

pkg/stanza/fileconsumer/attrs/attrs.go

receiver/otlpjsonfilereceiver/testdata/config.yaml

pkg/stanza/fileconsumer/attrs/attrs.go

receiver/filelogreceiver/README.md

pkg/stanza/fileconsumer/attrs/attrs.go

tprelle · 2024-02-26T21:31:59Z

Hi @djaglowski,
A windows test it's failling on var fileStat = fileInfo.Sys().(*syscall.Stat_t) (normal it's a linux call) but i never did this in go. Do you know a way to make it work both on linux and windows ?

djaglowski · 2024-02-26T21:37:55Z

A windows test it's failling on var fileStat = fileInfo.Sys().(*syscall.Stat_t) (normal it's a linux call) but i never did this in go. Do you know a way to make it work both on linux and windows ?

I don't know much about windows. If it doesn't work on windows, then I think it's ok to keep exclude the operating system:

When validating the config, error if either new flag is enabled and runtime.GOOS == "windows".
Skip the call to addOwnerInfo if runtime.GOOS == "windows"
Update the documentation for the new settings to indicate that it doesn't work on windows.

pkg/stanza/fileconsumer/attrs/ownerInfo_linux.go

pkg/stanza/fileconsumer/attrs/ownerInfo_other.go

pkg/stanza/fileconsumer/config.go

receiver/filelogreceiver/README.md

github-actions · 2024-03-16T05:19:57Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

tprelle · 2024-03-17T08:00:29Z

thanks @djaglowski for the review.
Sorry i was in 2 weeks vacation. I just push the changes.

pkg/stanza/fileconsumer/attrs/owner_windows.go

pkg/stanza/fileconsumer/config.go

pkg/stanza/fileconsumer/attrs/owner_other.go

djaglowski

Thanks @tprelle

open-telemetry#30776) **Description:** When you want to filter log on a shared host with multiple user, you want to be able to add owner and group of the file log. Currenly this lookup it's not possible so it's hard to filter after. If include_file_infos is true when reading a file on filelogreceiver, it will add the file owner as the attribute `log.file.owner` and the file group as the attribute `log.file.group`. **Link to tracking Issue:** open-telemetry#30775 **Testing:** Add unity test **Documentation:** Add documentation on file_input and file log receiver.

tprelle requested review from djaglowski and atoulme as code owners January 25, 2024 14:22

tprelle requested a review from a team January 25, 2024 14:22

github-actions bot assigned TylerHelmuth Jan 25, 2024

github-actions bot added pkg/stanza receiver/filelog receiver/otlpjsonfile labels Jan 25, 2024

tprelle force-pushed the add_include_file_infos branch from 2c5d76c to 1f028d4 Compare January 25, 2024 15:11

github-actions bot added the Stale label Feb 9, 2024

djaglowski reviewed Feb 9, 2024

View reviewed changes

pkg/stanza/fileconsumer/attrs/attrs.go Outdated Show resolved Hide resolved

receiver/otlpjsonfilereceiver/testdata/config.yaml Outdated Show resolved Hide resolved

github-actions bot removed the Stale label Feb 10, 2024

djaglowski added the enhancement New feature or request label Feb 13, 2024

tprelle force-pushed the add_include_file_infos branch 4 times, most recently from 776951b to cbc1cb9 Compare February 22, 2024 12:04

djaglowski added the Run Windows Enable running windows test on a PR label Feb 22, 2024

djaglowski reviewed Feb 22, 2024

View reviewed changes

tprelle force-pushed the add_include_file_infos branch 2 times, most recently from 1550dbb to bacf104 Compare February 23, 2024 19:39

djaglowski reviewed Feb 26, 2024

View reviewed changes

pkg/stanza/fileconsumer/attrs/attrs.go Outdated Show resolved Hide resolved

djaglowski changed the title ~~add include_file_infos on file log consumer~~ [receiver/filelog] Add settings to annotate file owner and group names Feb 26, 2024

tprelle force-pushed the add_include_file_infos branch 2 times, most recently from 0980e76 to 084209d Compare February 29, 2024 12:04

djaglowski reviewed Mar 1, 2024

View reviewed changes

github-actions bot added the Stale label Mar 16, 2024

tprelle force-pushed the add_include_file_infos branch 4 times, most recently from a990ab2 to 52eb76d Compare March 17, 2024 08:04

github-actions bot removed the Stale label Mar 18, 2024

djaglowski reviewed Mar 19, 2024

View reviewed changes

tprelle force-pushed the add_include_file_infos branch from 5da3b43 to b81b876 Compare March 25, 2024 14:42

djaglowski approved these changes Mar 25, 2024

View reviewed changes

tprelle added 7 commits March 27, 2024 08:48

add include_file_infos on file log consumer

7e9c730

split include_file_infos into include_file_owner and include_file_group

2e6af9f

refactor to do not reopen the file

1e3b4cf

make helper addOwnerInfo private

cb4691a

split owner info files in two for other system than linux

459f97c

only exclude windows and precise that it's the group owner

b626f84

refactor

7f26aa4

tprelle force-pushed the add_include_file_infos branch from b81b876 to 7f26aa4 Compare March 27, 2024 12:49

fix windows test

b575c05

tprelle force-pushed the add_include_file_infos branch from bd8f20f to b575c05 Compare March 27, 2024 14:59

fix lint

262b6c8

djaglowski approved these changes Mar 27, 2024

View reviewed changes

djaglowski merged commit fdaca38 into open-telemetry:main Mar 27, 2024
150 checks passed

github-actions bot added this to the next release milestone Mar 27, 2024

djaglowski mentioned this pull request Mar 29, 2024

Be able to include file owner and group as attribute on filelogreceiver #30775

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[receiver/filelog] Add settings to annotate file owner and group names #30776

[receiver/filelog] Add settings to annotate file owner and group names #30776

tprelle commented Jan 25, 2024 •

edited by djaglowski

Loading

linux-foundation-easycla bot commented Jan 25, 2024 •

edited

Loading

github-actions bot commented Feb 9, 2024

djaglowski left a comment

tprelle commented Feb 26, 2024

djaglowski commented Feb 26, 2024

github-actions bot commented Mar 16, 2024

tprelle commented Mar 17, 2024

djaglowski left a comment

[receiver/filelog] Add settings to annotate file owner and group names #30776

[receiver/filelog] Add settings to annotate file owner and group names #30776

Conversation

tprelle commented Jan 25, 2024 • edited by djaglowski Loading

linux-foundation-easycla bot commented Jan 25, 2024 • edited Loading

github-actions bot commented Feb 9, 2024

djaglowski left a comment

Choose a reason for hiding this comment

tprelle commented Feb 26, 2024

djaglowski commented Feb 26, 2024

github-actions bot commented Mar 16, 2024

tprelle commented Mar 17, 2024

djaglowski left a comment

Choose a reason for hiding this comment

tprelle commented Jan 25, 2024 •

edited by djaglowski

Loading

linux-foundation-easycla bot commented Jan 25, 2024 •

edited

Loading