example: add kubernetes logs example #2606

sumo-drosiek · 2021-03-08T13:34:53Z

Description:
This PR adds example configuration to handle kubernetes container logs using filelog receiver
This depends on the #2564

Link to tracking Issue:
#2266

Testing:
N/A
tests which were performed to get results are going to be issued in another PR

Documentation:
README.md

codecov · 2021-03-08T13:49:22Z

Codecov Report

Merging #2606 (b85326c) into main (6566113) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2606      +/-   ##
==========================================
- Coverage   91.37%   91.35%   -0.02%     
==========================================
  Files         431      431              
  Lines       21461    21461              
==========================================
- Hits        19609    19605       -4     
- Misses       1387     1390       +3     
- Partials      465      466       +1

Flag	Coverage Δ
integration	`69.18% <ø> (-0.07%)`	⬇️
unit	`90.25% <ø> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...rometheusexecreceiver/subprocessmanager/manager.go	`70.00% <0.00%> (-6.00%)`	⬇️
processor/groupbytraceprocessor/event.go	`95.96% <0.00%> (-0.81%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6566113...b85326c. Read the comment docs.

sumo-drosiek · 2021-03-08T20:47:07Z

I messed up sth with rebasing

examples/kubernetes/README.md

examples/kubernetes/otel-collector-config.yml

tigrannajaryan · 2021-03-08T21:38:13Z

examples/kubernetes/otel-collector-config.yml

+          k8s.container.name: 'EXPR($.container_name)'
+          k8s.namespace.name: 'EXPR($.namespace)'
+          k8s.pod.name: 'EXPR($.pod_name)'
+          run_id: 'EXPR($.run_id)'


What is run_id? Is it something that requires a semantic convention in Otel spec?

I'm not sure if its really needed. It defines from which run of a pod logs are coming. In case pod is restarted the run_id is incremented. It could be sth like k8s.container.run_number, k8s.container.run_id

Even more like container.* as specified in semantic conventions

Can you please create an issue for this and for stream and add to Basic Logs milestone in this repo so that we can decide what to do about it.

tigrannajaryan · 2021-03-08T21:42:01Z

examples/kubernetes/otel-collector-config.yml

+      # Move out attributes to Attributes
+      - type: metadata
+        attributes:
+          stream: 'EXPR($.stream)'


Do we need to keep stream as an attribute? It seems like is it only marginally useful. If we want to have it we need to come up with some idea for a semantic convention. Otel spec spec does not encourage attribute names like that: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/attribute-and-label-naming.md#recommendations-for-opentelemetry-authors

Is there any semantic convention for file_path, file_name and so on? I think stream should be added there. I consider it rather important. As end user I would like to be able to manage logs differently depending on a stream type

No, I don't think we have semantic conventions like that. Can you please open an issue here in this repo to decide what we want to do with this attribute and we can address it in a future PR.

tigrannajaryan · 2021-03-09T16:49:05Z

@sumo-drosiek we can merge this example as is and work on improvements later. If you prefer this approach please create new issues for each unresolved comment and I will merge the PR.

Signed-off-by: Dominik Rosiek <drosiek@sumologic.com> Co-authored-by: Patryk Małek <69143962+pmalek-sumo@users.noreply.github.com>

Signed-off-by: Dominik Rosiek <drosiek@sumologic.com>

sumo-drosiek · 2021-03-10T08:23:02Z

I added daemonest configuration in another commit, and created PR issue for attribute names

examples/kubernetes/otel-collector-config.yml

tigrannajaryan · 2021-03-11T23:24:24Z

examples/kubernetes/otel-collector-config.yml

+          k8s.container.name: 'EXPR($.container_name)'
+          k8s.namespace.name: 'EXPR($.namespace)'
+          k8s.pod.name: 'EXPR($.pod_name)'
+          run_id: 'EXPR($.run_id)'


Can you please create an issue for this and for stream and add to Basic Logs milestone in this repo so that we can decide what to do about it.

examples/kubernetes/otel-collector.yaml

tigrannajaryan · 2021-03-11T23:26:20Z

@sumo-drosiek I left a couple more comments to do some final touches and we can merge it. This is great.

…logs Signed-off-by: Dominik Rosiek <drosiek@sumologic.com>

tigrannajaryan · 2021-03-16T15:19:38Z

@sumo-drosiek please create issues to decide what we do with stream and run_id fields (whether we want to have Otel semantic conventions) and add the issues to Basic Log Collection milestone.

This PR looks good, I will merge it now. Thanks.

sumo-drosiek · 2021-03-16T15:30:49Z

@tigrannajaryan I already created issue: #2628

**Description:** This PR adds example configuration to handle kubernetes container logs using filelog receiver This depends on the #2564 **Link to tracking Issue:** #2266 **Testing:** N/A tests which were performed to get results are going to be issued in another PR **Documentation:** README.md

* add env support for otel_span configuration Signed-off-by: Cuichen Li <cuichli@cisco.com> * update changelog * update changelog and some logic based on comment * Update CHANGELOG.md Co-authored-by: Anthony Mirabella <a9@aneurysm9.com> * add document about retrieve value from environment variable Signed-off-by: Cuichen Li <cuichli@cisco.com> * remove trailing whitespace Signed-off-by: Cuichen Li <cuichli@cisco.com> * parse environment variable before apply the options * Update CHANGELOG.md Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> * Update sdk/trace/provider_test.go Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> * Update CHANGELOG.md Co-authored-by: Anthony Mirabella <a9@aneurysm9.com> Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

sumo-drosiek requested a review from a team March 8, 2021 13:34

github-actions bot assigned bogdandrutu Mar 8, 2021

sumo-drosiek mentioned this pull request Mar 8, 2021

Add performance test for filelog based kubernetes container logs receiver #2564

Merged

sumo-drosiek closed this Mar 8, 2021

sumo-drosiek force-pushed the drosiek-kubernetes-example branch from fd61823 to a7fbb60 Compare March 8, 2021 20:37

sumo-drosiek reopened this Mar 8, 2021

sumo-drosiek force-pushed the drosiek-kubernetes-example branch from 8e09454 to c2c6989 Compare March 8, 2021 20:49

tigrannajaryan reviewed Mar 8, 2021

View reviewed changes

Dominik Rosiek and others added 2 commits March 10, 2021 08:59

example: add example for parsing kubernetes logs

5758105

Signed-off-by: Dominik Rosiek <drosiek@sumologic.com> Co-authored-by: Patryk Małek <69143962+pmalek-sumo@users.noreply.github.com>

example: kubernetes: add result of performance test to README

90c9a13

Signed-off-by: Dominik Rosiek <drosiek@sumologic.com>

sumo-drosiek force-pushed the drosiek-kubernetes-example branch from c2c6989 to 4f577dc Compare March 10, 2021 07:59

example: kubernetes: add example daemonset

21c5fb8

Signed-off-by: Dominik Rosiek <drosiek@sumologic.com>

sumo-drosiek force-pushed the drosiek-kubernetes-example branch from 4f577dc to 21c5fb8 Compare March 10, 2021 08:05

sumo-drosiek mentioned this pull request Mar 10, 2021

Clarify kubernetes logs attributes names #2628

Closed

tigrannajaryan reviewed Mar 11, 2021

View reviewed changes

examples: kubernetes: add more explanation about inclusion/exclusion …

b85326c

…logs Signed-off-by: Dominik Rosiek <drosiek@sumologic.com>

sumo-drosiek force-pushed the drosiek-kubernetes-example branch from 481d59a to b85326c Compare March 15, 2021 09:25

tigrannajaryan approved these changes Mar 16, 2021

View reviewed changes

tigrannajaryan merged commit 3cf9d87 into open-telemetry:main Mar 16, 2021

sumo-drosiek deleted the drosiek-kubernetes-example branch March 16, 2021 15:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

example: add kubernetes logs example #2606

example: add kubernetes logs example #2606

sumo-drosiek commented Mar 8, 2021

codecov bot commented Mar 8, 2021 •

edited

Loading

sumo-drosiek commented Mar 8, 2021

tigrannajaryan Mar 8, 2021

sumo-drosiek Mar 9, 2021 •

edited

Loading

tigrannajaryan Mar 11, 2021

tigrannajaryan Mar 8, 2021

sumo-drosiek Mar 9, 2021

tigrannajaryan Mar 9, 2021

tigrannajaryan commented Mar 9, 2021

sumo-drosiek commented Mar 10, 2021 •

edited

Loading

tigrannajaryan Mar 11, 2021

tigrannajaryan commented Mar 11, 2021

tigrannajaryan commented Mar 16, 2021

sumo-drosiek commented Mar 16, 2021

example: add kubernetes logs example #2606

example: add kubernetes logs example #2606

Conversation

sumo-drosiek commented Mar 8, 2021

codecov bot commented Mar 8, 2021 • edited Loading

Codecov Report

sumo-drosiek commented Mar 8, 2021

tigrannajaryan Mar 8, 2021

Choose a reason for hiding this comment

sumo-drosiek Mar 9, 2021 • edited Loading

Choose a reason for hiding this comment

tigrannajaryan Mar 11, 2021

Choose a reason for hiding this comment

tigrannajaryan Mar 8, 2021

Choose a reason for hiding this comment

sumo-drosiek Mar 9, 2021

Choose a reason for hiding this comment

tigrannajaryan Mar 9, 2021

Choose a reason for hiding this comment

tigrannajaryan commented Mar 9, 2021

sumo-drosiek commented Mar 10, 2021 • edited Loading

tigrannajaryan Mar 11, 2021

Choose a reason for hiding this comment

tigrannajaryan commented Mar 11, 2021

tigrannajaryan commented Mar 16, 2021

sumo-drosiek commented Mar 16, 2021

codecov bot commented Mar 8, 2021 •

edited

Loading

sumo-drosiek Mar 9, 2021 •

edited

Loading

sumo-drosiek commented Mar 10, 2021 •

edited

Loading