opentelemetry: add span event attributes #6531

v1v · 2023-05-17T21:02:03Z

SUMMARY

Enable populating span attributes to event attributes with OpenTelemetry in order to allow logs correlations with traces.

This is quite handy when the OTEL ventor does not show those details in the UI directly.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

opentelemetry

ADDITIONAL INFORMATION

#4175 was the original implementation.

Closes #6526

Given

---
- name: MyPlabook
  hosts: localhost
  connection: local

  roles:
  - role: myrole
  tasks:
  - name: MyTask2
    uri:
      url: https://www.elastic.co
      return_content: no
    register: webpage

And if I run with the logs:

OTEL_SERVICE_NAME=test-ansible \
OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4317 \
OTEL_EXPORTER_OTLP_INSECURE=true \
ansible-playbook -i hosts my-playbook.yml

Produces

And if I run setting the attributes in the logs to false:

OTEL_SERVICE_NAME=test-ansible \
OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4317 \
OTEL_EXPORTER_OTLP_INSECURE=true \
ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS=false \
ansible-playbook -i hosts my-playbook.yml

Produces

plugins/callback/opentelemetry.py

felixfontein

Thanks for your contribution!

changelogs/fragments/6531-opentelemetry-add-event-attributes.yml

v1v · 2023-05-30T20:14:02Z

I just refactored the span attributes to be able to populate the same attributes to the span events

Elastic specific view for the events

Jaeger specific view for the span/logs

felixfontein · 2023-05-31T06:17:19Z

@v1v do you want to make more changes, or is this ready for merging?

there are some vendors that might not require those attributes since those details are shown in the UI when accessing the spans, i.e.: jaeger

v1v · 2023-05-31T07:36:54Z

do you want to make more changes, or is this ready for merging?

I think It's now ready to be reviewed, I was not happy with the initial implementation, so there is a new flag to disable this behaviour. Some OTEL vendors might visualise the span attributes in the logs while others won't, hence the feature flag to disable when no needed.

Thanks for your review 🙏

plugins/callback/opentelemetry.py

Co-authored-by: Felix Fontein <felix@fontein.de>

gone-for-coding · 2023-06-01T10:48:10Z

This looks great @v1v! Looking forward to having it in the next release.

felixfontein

I glanced over the change, it looks good to me. If nobody objects I'll merge in a couple of days.

patchback · 2023-06-06T18:55:01Z

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/58958fc417c832d024c6a6e0ddf6f7ceaae656e6/pr-6531

Backported as #6631

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

* add span event attributes (task name and host name) * add fragment * refactor: use set_attributes * Add same span attributes to the event * chore: change description in the fragment * as mentioned in the code review * use flag to disable the attributes in logs there are some vendors that might not require those attributes since those details are shown in the UI when accessing the spans, i.e.: jaeger * Update plugins/callback/opentelemetry.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 58958fc)

felixfontein · 2023-06-06T18:55:11Z

@v1v thanks for your contribution!

…attributes (#6631) opentelemetry: add span event attributes (#6531) * add span event attributes (task name and host name) * add fragment * refactor: use set_attributes * Add same span attributes to the event * chore: change description in the fragment * as mentioned in the code review * use flag to disable the attributes in logs there are some vendors that might not require those attributes since those details are shown in the UI when accessing the spans, i.e.: jaeger * Update plugins/callback/opentelemetry.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 58958fc) Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com>

v1v · 2024-05-15T08:21:09Z

plugins/callback/opentelemetry.py

-        span.end(end_time=host_data.finish)
+            # This will avoid populating span attributes to the logs
+            span.add_event(task_data.dump, attributes={} if disable_attributes_in_logs else attributes)
+            span.end(end_time=host_data.finish)


This is a bug, I've just found

add span event attributes (task name and host name)

32dc58b

v1v changed the title ~~add span event attributes (task name and host name)~~ opentelemetry: add span event attributes (task name and host name) May 17, 2023

ansibullbot added WIP Work in progress callback callback plugin feature This issue/PR relates to a feature request plugins plugin (any type) small_patch Hopefully easy to review labels May 17, 2023

add fragment

06873c2

v1v marked this pull request as ready for review May 17, 2023 21:05

ansibullbot removed WIP Work in progress small_patch Hopefully easy to review labels May 17, 2023

v1v mentioned this pull request May 17, 2023

add more information to opentelemetry logs #6526

Closed

1 task

ansibullbot added has_issue needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels May 17, 2023

v1v commented May 18, 2023

View reviewed changes

plugins/callback/opentelemetry.py Outdated Show resolved Hide resolved

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-7 labels May 18, 2023

felixfontein reviewed May 18, 2023

View reviewed changes

changelogs/fragments/6531-opentelemetry-add-event-attributes.yml Outdated Show resolved Hide resolved

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label May 26, 2023

v1v added 3 commits May 30, 2023 21:58

refactor: use set_attributes

2a07a8c

Add same span attributes to the event

0b91b2a

chore: change description in the fragment

79c47be

v1v changed the title ~~opentelemetry: add span event attributes (task name and host name)~~ opentelemetry: add span event attributes May 30, 2023

as mentioned in the code review

7c0c909

ansibullbot removed the stale_ci CI is older than 7 days, rerun before merging label May 30, 2023

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label May 31, 2023

use flag to disable the attributes in logs

7f1bcf1

there are some vendors that might not require those attributes since those details are shown in the UI when accessing the spans, i.e.: jaeger

v1v commented May 31, 2023

View reviewed changes

plugins/callback/opentelemetry.py Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels May 31, 2023

Update plugins/callback/opentelemetry.py

417ffd9

Co-authored-by: Felix Fontein <felix@fontein.de>

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels May 31, 2023

felixfontein approved these changes Jun 4, 2023

View reviewed changes

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Jun 6, 2023

felixfontein merged commit 58958fc into ansible-collections:main Jun 6, 2023

patchback bot mentioned this pull request Jun 6, 2023

[PR #6531/58958fc4 backport][stable-7] opentelemetry: add span event attributes #6631

Merged

v1v commented May 15, 2024

View reviewed changes

v1v mentioned this pull request May 15, 2024

fix(opentelemetry): close span even if no logs are sent #8367

Merged

This was referenced May 19, 2024

[PR #8367/03240ad7 backport][stable-7] fix(opentelemetry): close span even if no logs are sent #8388

Merged

[PR #8367/03240ad7 backport][stable-8] fix(opentelemetry): close span even if no logs are sent #8389

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

opentelemetry: add span event attributes #6531

opentelemetry: add span event attributes #6531

v1v commented May 17, 2023 •

edited

Loading

felixfontein left a comment

v1v commented May 30, 2023

felixfontein commented May 31, 2023

v1v commented May 31, 2023

This comment was marked as outdated.

gone-for-coding commented Jun 1, 2023

felixfontein left a comment

patchback bot commented Jun 6, 2023 •

edited

Loading

felixfontein commented Jun 6, 2023

v1v May 15, 2024

opentelemetry: add span event attributes #6531

opentelemetry: add span event attributes #6531

Conversation

v1v commented May 17, 2023 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

felixfontein left a comment

Choose a reason for hiding this comment

v1v commented May 30, 2023

Elastic specific view for the events

Jaeger specific view for the span/logs

felixfontein commented May 31, 2023

v1v commented May 31, 2023

This comment was marked as outdated.

gone-for-coding commented Jun 1, 2023

felixfontein left a comment

Choose a reason for hiding this comment

patchback bot commented Jun 6, 2023 • edited Loading

Backport to stable-7: 💚 backport PR created

felixfontein commented Jun 6, 2023

v1v May 15, 2024

Choose a reason for hiding this comment

v1v commented May 17, 2023 •

edited

Loading

patchback bot commented Jun 6, 2023 •

edited

Loading