[OTel] unittest coverage improvement by CagriYonca · Pull Request #603 · instana/python-sensor

CagriYonca · 2024-08-29T17:32:22Z

I worked on the modules below, increased existing unittests and created non-existing:

src/instana/collector/base.py (100% coverage)
src/instana/collector/helpers/runtime.py (97%)
src/instana/collector/host.py (96%)
src/instana/collector/utils.py (100%)
src/instana/propagators/base_propagator.py (96%)
src/instana/sampling.py (100%)
src/instana/util/traceutils.py (100%)

setup.py configuration to replace the dependency of OpenTracing with OpenTelemetry (OTel) and bump up to version 3.0.0. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Disabled all tests that are not necessary in the beginning of the migration. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

- Implement all the abstract methods provided by the OTel API - Adapt the existing code to OTel conventions. - Inherit OTel's SpanContext. - Comment out the usage of baggage. - Use time in nano seconds for start_time and end_time. - Initialization of Span's attributes, events, start_time, status, duration, and synthetic. - Add the duration, status, and parent_id properties. - Minor fixes to set values or get a dictionary value. Co-authored-by: Paulo Vital <paulo.vital@ibm.com> Signed-off-by: Varsha GS <varsha.gs@ibm.com>

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…olations. Used ruff (vscode) to: - Black-compatible code formatting. - fix all auto-fixable violations, like unused imports. - isort-compatible import sorting. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Co-authored-by: Varsha GS <varsha.gs@ibm.com> Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Used ruff (vscode) to: - Black-compatible code formatting. - fix all auto-fixable violations, like unused imports. - isort-compatible import sorting. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Signed-off-by: Varsha GS <varsha.gs@ibm.com>

- contextmanager for start_as_current_span(). - use trace_flags.sampled instead of sampled. - Add Instana specific attributes to SpanContext. - Add parent Span_Context class arguments as necessary arguments to fix the serialization of binary objects. - Use format_span_id() for both representation of the trace_id and span_id since Instana uses 64-bit integers. Co-authored-by: Paulo Vital <paulo.vital@ibm.com> Signed-off-by: Varsha GS <varsha.gs@ibm.com>

- Refactor InstanaTracerProvider class for better performance. - Add the missing add_span_processor() method for InstanaTracerProvider. - Refactor InstanaTracer constructor removing all Optional arguments. - Fix the start_span() method to handle the root SpanContext properly. - Use TraceFlags as trace_flags arguments in new SpanContext objects. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Following the OpenTelemetry API, guarantee Traces and Spans IDs are now 64-bit integers instead of strings. The data transmited to the Instana Agents or Backend are still 16HEXDIG strings. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Disabled the load of the auto instrumentation for tests and the load of the instana package from the beginning of test execution. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Adds a pytest.mark.skipif running on macOS to avoid the raise of a NotImplementedError when calling multiprocessing.Queue.qsize(). Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

(cherry picked from commit 6ff67a143cd0eecf45dceb9bc9b25c84a47f3c66) Signed-off-by: Varsha GS <varsha.gs@ibm.com>

GSVarsha · 2024-09-19T04:41:54Z

This file is outdated. Please take a look at src/instana/span folder if you want to make some changes.

👆🏻 this!

GSVarsha

Few requests ⬆️

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Remove the TestAgent and the if-blocks that check if running in a test environment from the production code. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

pvital

Few requests

pvital · 2024-09-20T14:07:13Z

👆🏻 this!

pvital · 2024-09-20T14:16:33Z

You are moving/renaming the __init__.py file from the old platforms directory to the collector, and letting the new agents directory without an init file.

I suggest you to:

First, rename the new agents dir name to agent - coherent with the same name in src/instana/

Second, create a new __init__.py file in the tests/collector folder and move this one to the new agent dir.

pvital · 2024-09-20T14:18:44Z

No need to have this if you are not setting up and tearing down the test execution.

pvital · 2024-09-20T14:19:11Z

Missing type annotation.

Signed-off-by: Varsha GS <varsha.gs@ibm.com> (cherry picked from commit 8ab3210a92502253876f91213009c287167f6790)

(cherry picked from commit 126e4ec09440509da867e7b7aa49dfaf0c8a867d) Signed-off-by: Varsha GS <varsha.gs@ibm.com>

Signed-off-by: Varsha GS <varsha.gs@ibm.com>

CagriYonca added the enhancement label Aug 29, 2024

CagriYonca added this to the H2-2024 milestone Aug 29, 2024

CagriYonca requested review from GSVarsha and pvital August 29, 2024 17:32

CagriYonca self-assigned this Aug 29, 2024

CagriYonca added the OTel_migration Migration the code dependency from OpenTracing to OpenTelemetry label Aug 30, 2024

pvital force-pushed the otel_migration branch from 7ec6824 to 3746294 Compare September 2, 2024 11:38

CagriYonca force-pushed the otel/unittest_coverage branch 4 times, most recently from f5d8227 to 80ddc10 Compare September 4, 2024 08:38

GSVarsha reviewed Sep 5, 2024

View reviewed changes

Comment thread src/instana/propagators/base_propagator.py Outdated

CagriYonca force-pushed the otel/unittest_coverage branch 2 times, most recently from 43dead3 to 9bd8989 Compare September 5, 2024 09:24

CagriYonca requested a review from GSVarsha September 5, 2024 09:24

pvital and others added 15 commits September 12, 2024 15:10

feat(OTel): Initial commit to migrate to OpenTelemetry.

cd6059a

setup.py configuration to replace the dependency of OpenTracing with OpenTelemetry (OTel) and bump up to version 3.0.0. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

test(OTel): Remove opentracing tests and disable tests.

d27de2b

Disabled all tests that are not necessary in the beginning of the migration. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

ci(OTel): Adapt CircleCI to OTel and set to run only on master branch.

f285f84

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

feat(OTel): Remove dependency of basictracer.

c937148

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

style: Format recorder.py and test_host_collector.py, and fix lint vi…

193a2dc

…olations. Used ruff (vscode) to: - Black-compatible code formatting. - fix all auto-fixable violations, like unused imports. - isort-compatible import sorting. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

feat(OTel): Add Sampler abstract class and adapt InstanaSampler class.

0f5d0fa

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

refactor(tracer): Tracer migration to use OTel.

c3877cf

Co-authored-by: Varsha GS <varsha.gs@ibm.com> Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

style: format singletons.py, tracer.py and tests/helpers.py

808ef70

Used ruff (vscode) to: - Black-compatible code formatting. - fix all auto-fixable violations, like unused imports. - isort-compatible import sorting. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

fix: handle circular imports caused by singletons.env_is_test

384be66

Signed-off-by: Varsha GS <varsha.gs@ibm.com>

refactor: Tracer and Span ID generation.

c89fd9d

Following the OpenTelemetry API, guarantee Traces and Spans IDs are now 64-bit integers instead of strings. The data transmited to the Instana Agents or Backend are still 16HEXDIG strings. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

test(OTel): Disable auto instrumentation.

6c22d20

Disabled the load of the auto instrumentation for tests and the load of the instana package from the beginning of test execution. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

fix(test): Skip test_stan_recorder.py on macOS.

ef6bd51

Adds a pytest.mark.skipif running on macOS to avoid the raise of a NotImplementedError when calling multiprocessing.Queue.qsize(). Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

GSVarsha and others added 5 commits September 17, 2024 11:00

sanic: use the lightweight sanic_testing module

b3c35b3

(cherry picked from commit 6ff67a143cd0eecf45dceb9bc9b25c84a47f3c66) Signed-off-by: Varsha GS <varsha.gs@ibm.com>

refactor(couchbase): added otel instrumentation of couchbase

1188af2

unittests(couchbase): added unittests of couchbase instrumentation

8dee449

refactor(cassandra): added cassandra otel instrumentation

54340c1

unittest(cassandra): added unittests of cassandra otel instrumentation

fd43a53

CagriYonca force-pushed the otel/unittest_coverage branch 2 times, most recently from ca256ee to 27b3398 Compare September 18, 2024 09:31

GSVarsha reviewed Sep 19, 2024

View reviewed changes

Comment thread src/instana/collector/base.py Outdated

GSVarsha reviewed Sep 19, 2024

View reviewed changes

Comment thread src/instana/span_context.py Outdated

GSVarsha reviewed Sep 19, 2024

View reviewed changes

GSVarsha requested changes Sep 19, 2024

View reviewed changes

CagriYonca and others added 5 commits September 19, 2024 09:55

refactor(redis): added instrumentation of redis

f6bf1b1

unittest(redis): added unittests for redis

d087f7a

refactor: Pika instrumentation.

f64b24e

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

tests(pika): adapt tests to OTel usage.

b55e3fe

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

refactor: Remove TestAgent from the production code.

c66ce2c

Remove the TestAgent and the if-blocks that check if running in a test environment from the production code. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

CagriYonca force-pushed the otel/unittest_coverage branch from 27b3398 to e50ea19 Compare September 20, 2024 14:06

pvital requested changes Sep 20, 2024

View reviewed changes

CagriYonca and others added 9 commits September 20, 2024 17:30

refactor(sqlalchemy): added sqlalchemy otel instrumentation

8400110

unittest(sqlalchemy): added unittests of sqlalchemy otel instrumentation

81c7df2

added cassandra instrumentation

0a63b0b

refactor: pyramid tween instrumentation

4de8c0c

Signed-off-by: Varsha GS <varsha.gs@ibm.com> (cherry picked from commit 8ab3210a92502253876f91213009c287167f6790)

pyramid: adapt tests after refactor

d219b58

(cherry picked from commit 126e4ec09440509da867e7b7aa49dfaf0c8a867d) Signed-off-by: Varsha GS <varsha.gs@ibm.com>

pyramid: enable auto-instrumentation

480ff09

Signed-off-by: Varsha GS <varsha.gs@ibm.com>

pyramid: change from sdk span (http) to registered entry span (wsgi)

863cf9b

Signed-off-by: Varsha GS <varsha.gs@ibm.com>

unittest: updated test folder structure

64e1e0b

unittest(redis): fix unittests and annotation

aca41fe

CagriYonca force-pushed the otel/unittest_coverage branch from e50ea19 to aca41fe Compare September 23, 2024 07:49

pvital force-pushed the otel_migration branch from e3eb9a0 to fd82b29 Compare September 25, 2024 09:49

CagriYonca closed this Sep 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OTel] unittest coverage improvement#603

[OTel] unittest coverage improvement#603
CagriYonca wants to merge 172 commits into
otel_migrationfrom
otel/unittest_coverage

CagriYonca commented Aug 29, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GSVarsha Sep 19, 2024

Uh oh!

pvital Sep 20, 2024

Uh oh!

GSVarsha left a comment

Uh oh!

pvital left a comment

Uh oh!

Uh oh!

pvital Sep 20, 2024

Uh oh!

pvital Sep 20, 2024

Uh oh!

pvital Sep 20, 2024

Uh oh!

pvital Sep 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

CagriYonca commented Aug 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GSVarsha Sep 19, 2024

Choose a reason for hiding this comment

Uh oh!

pvital Sep 20, 2024

Choose a reason for hiding this comment

Uh oh!

GSVarsha left a comment

Choose a reason for hiding this comment

Uh oh!

pvital left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pvital Sep 20, 2024

Choose a reason for hiding this comment

Uh oh!

pvital Sep 20, 2024

Choose a reason for hiding this comment

Uh oh!

pvital Sep 20, 2024

Choose a reason for hiding this comment

Uh oh!

pvital Sep 20, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CagriYonca commented Aug 29, 2024 •

edited

Loading