Initial commit for setting up a new component: k8slog receiver #24439

h0cheung · 2023-07-24T08:05:18Z

Description:

k8slog receiver provides full functionality to collect logs in k8s containers. It is an all-in-one solution, which supports to:

collect logs from files inside k8s containers via daemonset
support docker and cri-containerd
support many docker graph drivers / snapshotters
collect logs from stdout of k8s containers via daemonset
filter containers by metadata
extract metadata of containers
collect file logs in k8s containers via sidecar

If we want to collect logs from k8s, we can use this component.

Link to tracking Issue:

#23339

Testing:

Tests for unmarshaling configuration have been added.

Documentation:

Docs for configurations and overall design has been added.

github-actions · 2023-08-08T05:20:07Z

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

h0cheung · 2023-08-08T13:34:58Z

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

remove stale

dmitryax · 2023-08-14T20:55:50Z

receiver/k8slogreceiver/config.go

+)
+
+// Config is the configuration of a k8s input operator
+type Config struct {


Are all of the configuration options required for the initial implementation? Can you remove them for now and add them along with the functionality using them going forward?

I agree, starting small will make things easier to review and get started and we can always add them in the future.

TylerHelmuth

@h0cheung I am very excited about this component, sorry I didn't see your proposal sooner. @dmitryax thanks for pointing it out.

TylerHelmuth · 2023-08-14T21:22:59Z

receiver/k8slogreceiver/config.go

+
+	// Expr represents the rules to filter containers based on a custom expression.
+	// TODO: define the values passed to expr.
+	Expr string `mapstructure:"expr"`


Lets not introduce expr filtering to start. The other filter options you've provided are quite extensive. For expression language filtering I'd prefer we use OTTL.

receiver/k8slogreceiver/config.go

TylerHelmuth · 2023-08-14T21:28:38Z

receiver/k8slogreceiver/metadata.yaml

+  stability:
+    development: [logs]
+  codeowners:
+    active: [h0cheung]


You can add me here as well

OK, I will do it soon.

Hey @TylerHelmuth @h0cheung , I will be more than happy to help reviewing/testing and maintaining this component. In this, feel free to add me into the list as well if that's ok already.

TylerHelmuth · 2023-08-14T21:29:42Z

receiver/k8slogreceiver/config.go

+)
+
+// Config is the configuration of a k8s input operator
+type Config struct {


I agree, starting small will make things easier to review and get started and we can always add them in the future.

receiver/k8slogreceiver/config.go

h0cheung · 2023-09-04T02:42:50Z

@TylerHelmuth @dmitryax I've simplified the configs and added Tyler Helmuth to the code owner. Could you please have a look at this?

TylerHelmuth · 2023-09-06T22:35:27Z

receiver/k8slogreceiver/config.go

+	// Env represents the rules to extract from container environment variables.
+	Env []FieldExtractConfig `mapstructure:"env"`
+
+	// OtelEnv represents the rules to extract from environment variables of otel itself.
+	OtelEnv []FieldExtractConfig `mapstructure:"otel_env"`


I don't think we should allow extracting from env variables, that feels like a security risk.

OtelEnv has been removed.
However, Env is needed in some cases. For example, if there are some environment variables in the docker image, there is no other way to get it.
Is this really risky? resourcedetection supports it, and this component gets k8s node name from environment variables, too.

Using an env var to filter feels ok. But this section is for taking fields from the pod and adding them as resource attributes to the log right?

Getting attributes from environment variables is useful, and many components support it such as resoucedetection

Are there any reports of security risks associated with reading environment variables as strings and adding them to data?

The risk is exposing apikey/password information, but that risk is lowered if the config only allows static strings. If we do allow this I think we can do all env vars with 1 config option, no need to split out OTel env vars.

By default, the env config is empty, and no variable will be exposed. When a user set this, he should know what he is doing.

It seems that otel_env is necessary, so I've removed it in the latest commit.

@dmitryax do you have an opinion?

Any updates for this?

Lets move forward with this allowed as we've discussed.

I also find it useful to have the option to collect ENV_VAR information from the Pods.
That would give us important information about OTEL specific info like OTEL_SERVICE_NAME.
Having service.name populated in log records collected by the k8slog receiver is quite important since it will allow us to correlate logs with traces using the service.name value.

receiver/k8slogreceiver/config.go

h0cheung · 2024-07-08T01:36:47Z

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

Remove stale

h0cheung · 2024-07-14T17:38:42Z

@ChrsMark please take a look at the failing CLA

Can we just temporarily drop his changes to get this merged?

ChrsMark · 2024-07-14T19:13:40Z

@h0cheung I have fixed the CLA issues on my side. At least I haven't got any errors the past 2 weeks on PRs/commits.
Can you try to rebase the PR?

In any case, I think there are still major open questions on this PR.

mx-psi · 2024-07-22T08:40:00Z

/easycla

paramsdas-generali · 2024-09-12T05:50:48Z

@atoulme Are there any plans to integrate the k8slog receiver into the splunk-otel-collector after it becomes available through this merge request?

atoulme · 2024-09-19T16:15:36Z

.github/CODEOWNERS

-reports/distributions/core.yaml    @open-telemetry/collector-contrib-approvers 
-reports/distributions/contrib.yaml @open-telemetry/collector-contrib-approvers 
+reports/distributions/core.yaml    @open-telemetry/collector-contrib-approvers
+reports/distributions/contrib.yaml @open-telemetry/collector-contrib-approvers


 ## UNMAINTAINED components

-receiver/googlecloudspannerreceiver/                                @open-telemetry/collector-contrib-approvers 
+receiver/googlecloudspannerreceiver/                                @open-telemetry/collector-contrib-approvers


you should not have manual edits to this file.

regenerated

Co-authored-by: Chris Mark <chrismarkou92@gmail.com>

h0cheung requested review from a team and kovrus July 24, 2023 08:05

github-actions bot assigned bogdandrutu Jul 24, 2023

h0cheung force-pushed the feat/k8slog-setup branch from 4858200 to 3e05fa1 Compare July 24, 2023 10:02

github-actions bot added the Stale label Aug 8, 2023

h0cheung force-pushed the feat/k8slog-setup branch from 3e05fa1 to ea3a841 Compare August 8, 2023 13:42

github-actions bot removed the Stale label Aug 9, 2023

h0cheung force-pushed the feat/k8slog-setup branch 6 times, most recently from 951c26c to 04d4b40 Compare August 10, 2023 06:39

dmitryax mentioned this pull request Aug 14, 2023

Improve Kubernetes Logs Collection Experience #25251

Closed

dmitryax reviewed Aug 14, 2023

View reviewed changes

TylerHelmuth reviewed Aug 14, 2023

View reviewed changes

TylerHelmuth removed the request for review from kovrus August 14, 2023 21:32

dmitryax mentioned this pull request Aug 28, 2023

New component: Kubernetes api logs receiver #24641

Closed

h0cheung force-pushed the feat/k8slog-setup branch from 04d4b40 to 6eb08af Compare September 1, 2023 12:39

h0cheung requested a review from atoulme as a code owner September 1, 2023 12:39

github-actions bot added the cmd/githubgen label Sep 1, 2023

h0cheung force-pushed the feat/k8slog-setup branch 2 times, most recently from 82afa36 to 5fde154 Compare September 1, 2023 13:06

TylerHelmuth reviewed Sep 6, 2023

View reviewed changes

h0cheung force-pushed the feat/k8slog-setup branch 3 times, most recently from 132b260 to 8256f32 Compare September 8, 2023 12:35

github-actions bot added the Stale label Jun 27, 2024

atoulme added never stale Issues marked with this label will be never staled and automatically removed and removed Stale labels Jul 8, 2024

h0cheung force-pushed the feat/k8slog-setup branch 5 times, most recently from b37ab49 to 1c6b049 Compare July 26, 2024 06:49

h0cheung force-pushed the feat/k8slog-setup branch from 1c6b049 to 9a9717a Compare August 8, 2024 03:33

h0cheung force-pushed the feat/k8slog-setup branch 3 times, most recently from 09fca1f to cb65319 Compare September 19, 2024 12:05

h0cheung requested a review from a team as a code owner September 19, 2024 12:05

atoulme reviewed Sep 19, 2024

View reviewed changes

h0cheung and others added 7 commits September 20, 2024 10:44

feat: initial commit for k8slog receiver

1e746b9

mod: only try to connect to cri by default

7074549

mod: update README to respect the code changes

6c0ef64

docs (receiver/k8slog): describe detailed design for each mode.

337c5fb

feat (receiver/k8slog): update dependencies.

94a52f5

docs(receiver/k8slog): fix typo

b054d38

Co-authored-by: Chris Mark <chrismarkou92@gmail.com>

(receiver/k8slog): sync dependencies.

a7203bd

h0cheung force-pushed the feat/k8slog-setup branch from cb65319 to a7203bd Compare September 20, 2024 02:45

h0cheung added 2 commits September 23, 2024 20:22

Merge branch 'main' into feat/k8slog-setup

a66fb06

Merge branch 'main' into feat/k8slog-setup

076dead

h0cheung force-pushed the feat/k8slog-setup branch from c02d865 to 076dead Compare September 24, 2024 02:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial commit for setting up a new component: k8slog receiver #24439

Initial commit for setting up a new component: k8slog receiver #24439

h0cheung commented Jul 24, 2023

github-actions bot commented Aug 8, 2023

h0cheung commented Aug 8, 2023

dmitryax Aug 14, 2023

TylerHelmuth Aug 14, 2023

TylerHelmuth left a comment

TylerHelmuth Aug 14, 2023

TylerHelmuth Aug 14, 2023

h0cheung Aug 20, 2023 •

edited

Loading

ChrsMark Apr 2, 2024

TylerHelmuth Aug 14, 2023

h0cheung commented Sep 4, 2023

TylerHelmuth Sep 6, 2023

h0cheung Sep 8, 2023

TylerHelmuth Sep 11, 2023

h0cheung Sep 17, 2023

TylerHelmuth Sep 18, 2023

h0cheung Sep 21, 2023

TylerHelmuth Sep 21, 2023

h0cheung Sep 28, 2023

TylerHelmuth Oct 17, 2023

ChrsMark Jan 18, 2024

h0cheung commented Jul 8, 2024

h0cheung commented Jul 14, 2024

ChrsMark commented Jul 14, 2024

mx-psi commented Jul 22, 2024

paramsdas-generali commented Sep 12, 2024

atoulme Sep 19, 2024

h0cheung Sep 20, 2024

Initial commit for setting up a new component: k8slog receiver #24439

Are you sure you want to change the base?

Initial commit for setting up a new component: k8slog receiver #24439

Conversation

h0cheung commented Jul 24, 2023

github-actions bot commented Aug 8, 2023

h0cheung commented Aug 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TylerHelmuth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

h0cheung Aug 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

h0cheung commented Sep 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

h0cheung commented Jul 8, 2024

h0cheung commented Jul 14, 2024

ChrsMark commented Jul 14, 2024

mx-psi commented Jul 22, 2024

paramsdas-generali commented Sep 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

h0cheung Aug 20, 2023 •

edited

Loading