Support Hints per container input #3416

gizas · 2023-09-14T11:45:37Z

Enhancement

What does this PR do?

This PR is introrduces the functionality described in #3161!
In more details users provide the container name in the hint and this functionality is applied only to a specific container of the pod. When a pod has multiple containers, the settings are shared unless you put the container name in the hint.

For eg. co.elastic.hints.nginx/stream: stderr is an annotation (aka. hints) that will be applied to a container wtih name nginx

Why is it important?

It introduces a missing functionality that exists in Hints autodiscovry for beats as described in the Multiple Containers Section

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in ./changelog/fragments using the changelog tool
I have added an integration test or an E2E test

How to test this PR locally

Follow the same steps as desceibed in "How to test this PR locally" of Add support for processors in hints based k8s autodiscover #3107
Apply the nginx.yaml manifest that creates a pod with 2 containers

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: nginx
  name: nginx
  namespace: default
spec:
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
      annotations:
        co.elastic.hints/package: "container_logs"
        co.elastic.hints/processors.decode_json_fields.fields: "message"
        co.elastic.hints/processors.decode_json_fields.add_error_key: 'true'
        co.elastic.hints/processors.decode_json_fields.overwrite_keys: 'true'
        co.elastic.hints/processors.decode_json_fields.target: "team"
        co.elastic.hints.nginx/stream: stderr
        co.elastic.hints.nginx/processors.add_fields.fields.name: "myproject"
    spec:
      containers:
      - image: nginx
        name: nginx
      - image: training/webapp
        name: webapp

Exec into Elastic Agent

kubectl exec -ti -n kube-system elastic-agent-t95bj -- bash

/share/elastic-agent# elastic-agent inspect -v --variables --variables-wait 2s

Related issues

Relates Support hints Autodiscovery for input configs per container #3161

Logs

Output file generated with inspect command
agent.txt

id: hints-filestream-container-logs-a3263d2b196abc0695f1ba1767cce0d0d40cef186cce132d3b39dcfb84ec74a0-kubernetes-9b52738c-3366-4f86-8fb3-bfefddd65ef0.nginx
[output .truncated..]
- decode_json_fields:    < ----- added from co.elastic.hints/processors.decode_json_fields.* 
      add_error_key: "true"
      fields: message
      overwrite_keys: "true"
      target: team

#<----- Added only to this container from co.elastic.hints.nginx/processors.add_fields.fields.name: "myproject"
  - add_fields:   
      fields:
        name: myproject
  streams:
  - data_stream:
      dataset: kubernetes.container_logs
      type: logs
    parsers:
    - container:
        format: auto
        stream: stderr. <-- From co.elastic.hints.nginx/stream: stderr

....

id: hints-filestream-container-logs-c28563d37f000e2b7a31f014ba403a0bc16a94dafc63169bc0f98143fc96832c-kubernetes-9b52738c-3366-4f86-8fb3-bfefddd65ef0.webapp
- decode_json_fields: < ----- added from co.elastic.hints/processors.decode_json_fields.* of 
      add_error_key: "true"
      fields: message
      overwrite_keys: "true"
      target: team
  streams:
  - data_stream:
      dataset: kubernetes.container_logs
      type: logs
    parsers:
    - container:
        format: auto
        stream: all. <---- This did not chane to stderr
##<----- Did not affected from   co.elastic.hints.nginx/processors.add_fields.fields.name: "myproject"

mergify · 2023-09-14T11:46:12Z

This pull request does not have a backport label. Could you fix it @gizas? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-v./d./d./d is the label to automatically backport to the 8./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

gizas · 2023-09-14T11:47:44Z

Documentation updates will be handled in another PR (TBD)
I will need to do some manual tests with metrics
Probably to update the integration tests

elasticmachine · 2023-09-14T12:08:53Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2023-10-06T14:39:21.103+0000
Duration: 30 min 36 sec

Test stats 🧪

Test	Results
Failed	0
Passed	6489
Skipped	59
Total	6548

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages.
run integration tests : Run the Elastic Agent Integration tests.
run end-to-end tests : Generate the packages and run the E2E Tests.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

ChrsMark

I think this one would need some unit tests so as to ensure the added functionality.

internal/pkg/composable/providers/kubernetes/hints.go

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

elasticmachine · 2023-09-20T14:43:08Z

🌐 Coverage report

Name	Metrics % (`covered/total`)	Diff
Packages	98.78% (`81/82`)	👍
Files	67.003% (`199/297`)	👍
Classes	65.642% (`363/553`)	👍
Methods	52.974% (`1149/2169`)	👍 0.043
Lines	38.563% (`13128/34043`)	👍 0.094
Conditionals	100.0% (`0/0`)	💚

constanca-m · 2023-09-28T07:45:35Z

Great work @gizas !

I tested it with 1 pod running 2 nginx containers: one with port 80 and another with port 81.

I added the annotations to have the correct host for each container:

co.elastic.hints/package: nginx
co.elastic.hints/data_streams: stubstatus
co.elastic.hints.nginx-2/host: '${kubernetes.pod.ip}:81'
co.elastic.hints.nginx-1/host: '${kubernetes.pod.ip}:80'

And there it was (the barchart is for the unique count of container.name):

My two containers were there. I also tested with just one host, and it worked.

bartoszcisek · 2023-09-28T18:34:10Z

Great stuff! Can't wait for this one to be released ;-)

internal/pkg/composable/providers/kubernetes/hints.go

…e test

gizas · 2023-10-03T08:29:15Z

internal/pkg/composable/providers/kubernetes/hints_test.go

+// mappings.container.name = nginx defines the container we want to emmit the new configuration. Annotations for other containers like co.elastic.hints.webapp should be excluded
+func TestGenerateHintsMappingWithProcessorsForContainer(t *testing.T) {
+	logger := getLogger()
+	// pod := &kubernetes.Pod{


@constanca-m I commented out the pod section! Just kept it for reference with above tests.

Test is successful

Let me know if is ok or you think we can remove it?

It's ok with me

gizas · 2023-10-05T08:20:26Z

/test

gizas · 2023-10-05T13:50:43Z

/test

gizas · 2023-10-06T08:37:02Z

/test

gizas · 2023-10-06T09:12:34Z

/test

internal/pkg/composable/providers/kubernetes/hints.go

devamanv

LGTM, just left a couple of small comments.

Co-authored-by: Aman Verma <38116245+devamanv@users.noreply.github.com>

elastic-sonarqube · 2023-10-06T14:50:39Z

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

100.0% Coverage
0.0% Duplication

pchila

LGTM

gizas added 3 commits September 14, 2023 09:54

Adding updates for code to introduces hints per container

cf365a8

Fixing processors for specific container

4d32441

Removing unwanted if

ad54d8a

gizas requested a review from a team as a code owner September 14, 2023 11:45

gizas requested review from ChrsMark and devamanv September 14, 2023 11:45

mergify bot assigned gizas Sep 14, 2023

mergify bot added the backport-skip label Sep 14, 2023

gizas mentioned this pull request Sep 14, 2023

Support hints Autodiscovery for input configs per container #3161

Closed

Adding changelog fragment file

6b9e836

gizas requested a review from a team as a code owner September 14, 2023 11:54

gizas requested review from AndersonQ and pchila September 14, 2023 11:54

Fixing lint errors

4396a0b

Fixing comments

5b4fffc

ChrsMark requested changes Sep 19, 2023

View reviewed changes

gizas and others added 4 commits September 20, 2023 11:08

Update internal/pkg/composable/providers/kubernetes/hints.go

2e32781

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

Fixing checks for return variables

919fad9

Splitting functions for hints and processors

419d3a9

Adding test for specific container hints

c38405b

AndersonQ reviewed Sep 29, 2023

View reviewed changes

internal/pkg/composable/providers/kubernetes/hints.go Show resolved Hide resolved

Updating hints test by commenting pod part as it is not needed for th…

e954e4f

…e test

gizas commented Oct 3, 2023

View reviewed changes

constanca-m approved these changes Oct 3, 2023

View reviewed changes

ChrsMark approved these changes Oct 3, 2023

View reviewed changes

Fixing mispell

866288b

devamanv reviewed Oct 6, 2023

View reviewed changes

internal/pkg/composable/providers/kubernetes/hints.go Outdated Show resolved Hide resolved

devamanv reviewed Oct 6, 2023

View reviewed changes

internal/pkg/composable/providers/kubernetes/hints.go Outdated Show resolved Hide resolved

devamanv approved these changes Oct 6, 2023

View reviewed changes

gizas and others added 2 commits October 6, 2023 17:38

Update internal/pkg/composable/providers/kubernetes/hints.go

d594c60

Co-authored-by: Aman Verma <38116245+devamanv@users.noreply.github.com>

Update internal/pkg/composable/providers/kubernetes/hints.go

463f5b7

Co-authored-by: Aman Verma <38116245+devamanv@users.noreply.github.com>

pchila approved these changes Oct 6, 2023

View reviewed changes

AndersonQ approved these changes Oct 6, 2023

View reviewed changes

gizas merged commit 7a667da into main Oct 6, 2023
24 checks passed

gizas deleted the hintspercontainer branch October 6, 2023 17:36

gizas mentioned this pull request Nov 13, 2023

Updating doc for Hints Autodiscovery for multiple containers elastic/ingest-docs#503

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Hints per container input #3416

Support Hints per container input #3416

gizas commented Sep 14, 2023

mergify bot commented Sep 14, 2023

gizas commented Sep 14, 2023

elasticmachine commented Sep 14, 2023 •

edited

Build stats

Test stats 🧪

ChrsMark left a comment

elasticmachine commented Sep 20, 2023 •

edited

constanca-m commented Sep 28, 2023 •

edited

bartoszcisek commented Sep 28, 2023 •

edited

gizas Oct 3, 2023

constanca-m Oct 3, 2023

gizas commented Oct 5, 2023

gizas commented Oct 5, 2023

gizas commented Oct 6, 2023

gizas commented Oct 6, 2023

devamanv left a comment

elastic-sonarqube bot commented Oct 6, 2023

pchila left a comment

Support Hints per container input #3416

Support Hints per container input #3416

Conversation

gizas commented Sep 14, 2023

What does this PR do?

Why is it important?

Checklist

How to test this PR locally

Related issues

Logs

mergify bot commented Sep 14, 2023

gizas commented Sep 14, 2023

elasticmachine commented Sep 14, 2023 • edited

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

ChrsMark left a comment

Choose a reason for hiding this comment

elasticmachine commented Sep 20, 2023 • edited

🌐 Coverage report

constanca-m commented Sep 28, 2023 • edited

bartoszcisek commented Sep 28, 2023 • edited

gizas Oct 3, 2023

Choose a reason for hiding this comment

constanca-m Oct 3, 2023

Choose a reason for hiding this comment

gizas commented Oct 5, 2023

gizas commented Oct 5, 2023

gizas commented Oct 6, 2023

gizas commented Oct 6, 2023

devamanv left a comment

Choose a reason for hiding this comment

elastic-sonarqube bot commented Oct 6, 2023

pchila left a comment

Choose a reason for hiding this comment

elasticmachine commented Sep 14, 2023 •

edited

elasticmachine commented Sep 20, 2023 •

edited

constanca-m commented Sep 28, 2023 •

edited

bartoszcisek commented Sep 28, 2023 •

edited