Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OpenTelemetry tracing #96

Merged
merged 18 commits into from
May 2, 2024

Conversation

andmat900
Copy link
Contributor

Applicable Issues

Description of the Change

This change adds OpenTelemetry instrumentation to etos-environment-provider.

Alternate Designs

Possible Drawbacks

Sign-off

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.

Signed-off-by: Andrei Matveyeu, [email protected]

@andmat900 andmat900 requested a review from a team as a code owner April 10, 2024 12:43
@andmat900 andmat900 requested review from t-persson and fredjn and removed request for a team April 10, 2024 12:43
src/environment_provider/environment.py Show resolved Hide resolved
src/environment_provider/environment.py Show resolved Hide resolved
src/environment_provider/environment.py Show resolved Hide resolved
Comment on lines 122 to 123
otel_span.set_attribute("request.headers", json.dumps(headers, indent=4))
otel_span.set_attribute("request.body", json.dumps(execution_spaces, indent=4))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we really indent the JSON here? It makes the request to the OTEL collector larger.
This comment applies to all indent=4 dumps

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this isn't done, the JSON is shown in Jaeger as a string without pretty formatting.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me that's OK. I usually pipe JSON into jq for prettifying. The problem I have with posting pretty-json is that it makes the request a lot larger for something that, to me, does not give that much of a benefit.
@fredjn can chime in on which way he leans on this :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm leaning towards keeping the amount of data down, and If we feel it's a problem to re-format the json (when/if we inspect it) we can re-evaluate and refactor.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty formatting is now removed.

setup.cfg Outdated Show resolved Hide resolved
src/iut_provider/utilities/external_provider.py Outdated Show resolved Hide resolved
src/environment_provider/environment_provider.py Outdated Show resolved Hide resolved
Comment on lines 122 to 123
otel_span.set_attribute("request.headers", json.dumps(headers, indent=4))
otel_span.set_attribute("request.body", json.dumps(execution_spaces, indent=4))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me that's OK. I usually pipe JSON into jq for prettifying. The problem I have with posting pretty-json is that it makes the request a lot larger for something that, to me, does not give that much of a benefit.
@fredjn can chime in on which way he leans on this :)

@fredjn fredjn self-requested a review April 26, 2024 12:43
@andmat900 andmat900 requested a review from fredjn May 2, 2024 07:23
@@ -114,8 +123,8 @@ def checkin(self, log_area: LogArea) -> None:
headers = {"X-ETOS-ID": self.identifier}
TraceContextTextMapPropagator().inject(headers)
otel_span = opentelemetry.trace.get_current_span()
otel_span.set_attribute("http.request.host", host)
otel_span.set_attribute("http.request.body", json.dumps(log_areas, indent=4))
otel_span.set_attribute(SpanAttributes.URL_FULL, host)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps rename to span to keep naming consistent?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed the name.

@andmat900 andmat900 force-pushed the 20240402_opentelemetry branch from b23aa80 to e53b984 Compare May 2, 2024 10:15
@andmat900 andmat900 force-pushed the 20240402_opentelemetry branch from b16540e to 8c5237d Compare May 2, 2024 10:33
@fredjn fredjn merged commit 0acdb8d into eiffel-community:main May 2, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants