Add LogProcessors implementation by srikanthccv · Pull Request #1916 · open-telemetry/opentelemetry-python

srikanthccv · 2021-06-18T17:28:31Z

Description

Part-4 of #1890. This PR adds support for log processors implementation.

Co-authored-by: alrex <alrex.boten@gmail.com>

…lemetry-python into logging-otlp-handler

ocelotl · 2021-06-24T15:31:37Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

+    """
+
+    def __init__(self):
+        # use a tuple to avoid race conditions when adding a new log and


Is the tuple what avoids race conditions or is it the lock in add_log_processor? A tuple is an ordered data structure, is the order meaningful for log processors? If not, I suggest this be a set, instead.

It's both tuple and the lock. We are trying to be consistent with span processors so the order is important here.

ocelotl · 2021-06-24T15:35:32Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

+            self._log_processors = self._log_processors + (log_processor,)
+
+    def emit(self, log_data: LogData) -> None:
+        for lp in self._log_processors:


Is a lock also necessary here?

No, we wouldn't want to hold the lock until all processors complete emit. This just iterates over the log processor available at the time of emitting and returns.

ocelotl · 2021-06-24T15:36:24Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

+
+    def shutdown(self) -> None:
+        """Shutdown the log processors one by one"""
+        for lp in self._log_processors:


Same as above

ocelotl · 2021-06-24T15:37:17Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

+            False otherwise.
+        """
+        deadline_ns = _time_ns() + timeout_millis * 1000000
+        for lp in self._log_processors:


ocelotl · 2021-06-24T15:40:19Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py


+class SynchronousMultiLogProcessor(LogProcessor):
+    """Implementation of class:`LogProcessor` that forwards all received
+    events to a list of log processors sequentially.


Should this class be named SequentialMultiLogProcessor?

I think the current name is more accurate as we are synchronously calling one log processor after other.

ocelotl · 2021-06-24T20:44:37Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

+            return False
+
+        for future in done_futures:
+            if not future.result():


Why is this necessary?

If any of the processors fails to flush within timeout this should return false.

ocelotl · 2021-06-24T20:47:34Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/export/__init__.py

        """
+
+
+class SimpleLogProcessor(LogProcessor):


Is Simple descriptive for this kind of processor?

This is from spec

Are you referring to the tracing spec? Are we trying to be consistent with tracing?

No, I am referring to logs spec(OTEP at this point) https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md#logprocessor.

Built-in implementations: SimpleLogProcessor, BatchLogProcessor.

And yes the Logs SDK tries to be consistent with tracing as much as possible.

https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md#motivation

The specification defines SDK elements that to some extent mirror the OpenTelemetry Trace SDK. This ensures uniformity and consistency of the OpenTelemetry specification and of the implementations across traces and logs. For additional clarity the definitions in this document refer to the Trace analogs where appropriate.

opentelemetry-sdk/src/opentelemetry/sdk/logs/export/__init__.py

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

lzchen · 2021-06-28T16:39:04Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

+        log_data = LogData(record, self._instrumentation_info)
+        self._multi_log_processor.emit(log_data)

    def flush(self):


Why does the LogEmitter have a flush method? Shouldn't the Provider be responsible for the processors?

Both provider and emitter can flush. This exists to complete the Appender/Handler like Interfaces/ABC. In our case, OTLPHandler has to implement two methods (emit and flush) after subclassing logging.Handler. Handler will have a access to Emitter (analogous to Tracer in instrumentation). So if .flush of the handler is called (by high-level call logging.shutdown() or any other manner) we make use of LogEmitter flush method to flush the logs. Does this explanation make it clear why there is a flush on the Emitter?

Spec https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md#logemitter.

The use case makes sense. However, I'm wondering what would happen if multiple LogEmitters are created via Provider but all sharing the same multilogprocessor. If flush is called for a specific LogEmitter, would we flush the entire queue in the multilogprocessor, which might contain log records from different sources -> different LogEmitters correct? I don't think we have this problem in tracing because only the TracerProvider is allowed to flush. Thoughts? Unless I am missing something.

Right, how could one avoid it and only flush the logs from one lib, except when we create a new pipeline for each source? (that doesn't sound like a good idea). On the other hand provider flush does the same thing just flush everything out. Do you see any potential problems? This is probably worth sharing with logs SIG and see what they have to say about it?

Yeah we should probably bring it up. I'll be out this week so if you could bring it up during the SIG and relay what is discussed that would be great.

For now, I don't think this should block the PR, maybe just put a TODO next to flush ?

lzchen · 2021-06-28T17:51:11Z

opentelemetry-sdk/src/opentelemetry/sdk/logs/export/__init__.py

+        self.num_log_records = 0
+
+
+class BatchLogProcessor(LogProcessor):


I don't think I quite understand the logic flow. How do the handlers (that pick up logging messages from the Python logger) communicate with the Processor? Are handlers added to the root log handler?

Are handlers added to the root log handler?

Correct. End-user will have to attach the OTLPHandler to the root logger.

How do the handlers (that pick up logging messages from the Python logger) communicate with the Processor

Every log statement from the logging lib will be propagated to the root logger. Users can attach any number of Handlers with a logger instance. They may already be using out-of-box handlers from stdlib. OTLPHandler is such which sends the log data in OTLP data model format to configured destination (could be n/w destination or file etc...).

The logic flow is Logger -> Handler -> LogEmitter -> LogProcessor -> LogExporter. Think of Handler as Instrumentation and LogEmitter as Tracer from tracing SDK (kind of inaccurate but helps in visualizing things). Does it make sense now?

Ahh I see, each handler SHOULD have a reference to a log emitter. We would expect users to possible create their own Handlers correct? Maybe it would be good to have another abstraction layer on top of logging.Handler specific for OpenTelemetry log handlers (similar to BaseInstrumentor). Thoughts?

We would expect users to possible create their own Handlers correct?

They don't need another handler for the same logging lib but they can create Handler like hooks for other third-party logging libs (as recommended by the same module for example structlog has concept called Processors equivalent to logging.Handler).

Maybe it would be good to have another abstraction layer on top of logging.Handler specific for OpenTelemetry log handlers (similar to BaseInstrumentor).

Yeah, thought about it but couldn't come up with anything meaningful. Do you have any rough idea in your head how you would like it to be?

Nothing big for now, but similarly to instrumentations, BaseInstrumentor was needed eventually as we found more commonalities and functions between instrumentations. If a custom Handler is created for OpenTelemetry, maybe we need to it have an emitter?

Also probably not blocking the PR, just something to note if we ever get confusion on HOW a handler should look like.

Co-authored-by: Leighton Chen <lechen@microsoft.com>

…emetry-python into logs-processor-impl

This reverts commit 0367af1.

srikanthccv · 2021-07-10T10:24:08Z

The failing tests are not related to this PR. The fix has been merged in this open-telemetry/opentelemetry-python-contrib#560 but if I update the SHA there will be more failures because logs branch is behind main. I think this can get in.

lzchen · 2021-07-12T17:06:07Z

@lonewolf3739
There are a couple of things we can do:

Remove instrumentation tests from tox build for logs branch
Create a logs feature branch in contrib and run tests against that
Keep logs branch up to date with main, fixing all tests along the way

What do you suggest?

srikanthccv · 2021-07-12T18:21:53Z

The first one looks good to me. We can update the https://github.com/lonewolf3739/opentelemetry-python/blob/logs-processor-impl/.github/workflows/test.yml to not run contrib-bulid tests, what do you think?

lzchen · 2021-07-12T18:56:32Z

@lonewolf3739
I'm leaning more towards (2). It is the same thing we are doing for metrics, it gives us a clear separation of the features as well we don't have to keep track of different testing matrices. If you agree then I can go ahead and create that branch for you in contrib.

* Add initial overall structure and classes for logs sdk (#1894) * Add global LogEmitterProvider and convenience function get_log_emitter (#1901) * Add OTLPHandler for standard library logging module (#1903) * Add LogProcessors implementation (#1916) * Fix typos in test_handler.py (#1953) * Add support for OTLP Log exporter (#1943) * Add support for user defined attributes in OTLPHandler (#1952) * use timeout in force_flush (#2118) * use timeout in force_flush * fix lint * Update opentelemetry-sdk/src/opentelemetry/sdk/logs/export/__init__.py Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com> * fix lint Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com> * add a ConsoleExporter for logging (#2099) Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com> * Update SDK docs and Add example with OTEL collector logging (debug) exporter (#2050) * Fix exception in severity number transformation (#2208) * Fix exception with warning message transformation * Fix lint * Fix lint * fstring * Demonstrate how to set the Resource for LogEmitterProvider (#2209) * Demonstrate how to set the Resource for LogEmitterProvider Added a Resource to the logs example to make it more complete. Previously it was using the built-in Resource. Now it adds the service.name and service.instance.id attributes. The resulting emitted log records look like this: ``` Resource labels: -> telemetry.sdk.language: STRING(python) -> telemetry.sdk.name: STRING(opentelemetry) -> telemetry.sdk.version: STRING(1.5.0) -> service.name: STRING(shoppingcart) -> service.instance.id: STRING(instance-12) InstrumentationLibraryLogs #0 InstrumentationLibrary __main__ 0.1 LogRecord #0 Timestamp: 2021-10-14 18:33:43.425820928 +0000 UTC Severity: ERROR ShortName: Body: Hyderabad, we have a major problem. Trace ID: ce1577e4a703f42d569e72593ad71888 Span ID: f8908ac4258ceff6 Flags: 1 ``` * Fix linting * Use batch processor in example (#2225) * move logs to _logs (#2240) * move logs to _logs * fix lint * move log_exporter to _log_exporter as it's still experimental (#2252) Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com> Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com> Co-authored-by: Leighton Chen <lechen@microsoft.com> Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com> Co-authored-by: Owais Lone <owais@users.noreply.github.com>

srikanthccv and others added 16 commits June 10, 2021 00:42

Add global LogEmitterProvider and convenience function get_log_emitter

43c79ae

Add license

b88bb2a

Add OTLPHandler for logging module

8a071fe

Update handler

a10ccb8

fix lint

c31d36a

Update handler tests

c1d3eb6

Fix tests

0f6f3b4

Fix merge conflicts

3756f2d

Add CHANGELOG entry

287719c

Update opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

0dc7318

Co-authored-by: alrex <alrex.boten@gmail.com>

Review changes

ef20aee

Merge branch 'logging-otlp-handler' of github.com:lonewolf3739/opente…

ff0f491

…lemetry-python into logging-otlp-handler

Add link to log levels

3806614

WIP: Log Processor

2b3a582

Add log processors and in memory exporter

ab7ca56

Resolve merge conflicts

5470481

srikanthccv requested review from codeboten and ocelotl June 22, 2021 15:04

srikanthccv marked this pull request as ready for review June 22, 2021 15:04

srikanthccv requested a review from a team June 22, 2021 15:04

ocelotl reviewed Jun 24, 2021

View reviewed changes

Add review suggestion

cc624ed

lzchen reviewed Jun 28, 2021

View reviewed changes

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py Outdated Show resolved Hide resolved

lzchen reviewed Jun 28, 2021

View reviewed changes

opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py Show resolved Hide resolved

lzchen reviewed Jun 28, 2021

View reviewed changes

srikanthccv and others added 3 commits June 29, 2021 02:12

Update opentelemetry-sdk/src/opentelemetry/sdk/logs/__init__.py

eb04171

Co-authored-by: Leighton Chen <lechen@microsoft.com>

Fix lint and add TODO not for flush

5eb6097

Merge branch 'logs-processor-impl' of github.com:lonewolf3739/opentel…

f391246

…emetry-python into logs-processor-impl

lzchen approved these changes Jun 29, 2021

View reviewed changes

ocelotl approved these changes Jul 1, 2021

View reviewed changes

srikanthccv added 3 commits July 7, 2021 21:17

Fix lint

156ccf5

Update contrib SHA

0367af1

Revert "Update contrib SHA"

c66f345

This reverts commit 0367af1.

Merge branch 'logs' into logs-processor-impl

56d0110

lzchen merged commit 196a19c into open-telemetry:logs Jul 13, 2021

srikanthccv deleted the logs-processor-impl branch September 24, 2021 08:39

lzchen pushed a commit to lzchen/opentelemetry-python that referenced this pull request Oct 15, 2021

Add LogProcessors implementation (open-telemetry#1916)

e2963d2

codeboten pushed a commit that referenced this pull request Oct 29, 2021

Add LogProcessors implementation (#1916)

03f0ed2

codeboten pushed a commit to codeboten/opentelemetry-python that referenced this pull request Nov 3, 2021

Add LogProcessors implementation (open-telemetry#1916)

b296c55

lzchen pushed a commit that referenced this pull request Nov 4, 2021

Add LogProcessors implementation (#1916)

3273aa6

tigrannajaryan mentioned this pull request Feb 14, 2022

Is LogEmitter.flush necessary? open-telemetry/opentelemetry-specification#2342

Closed

pranavmarla mentioned this pull request Jul 26, 2022

Remove flush method on LogEmitter #2584

Closed

		self.num_log_records = 0


		class BatchLogProcessor(LogProcessor):

Conversation

srikanthccv commented Jun 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srikanthccv Jun 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srikanthccv commented Jul 10, 2021

Uh oh!

lzchen commented Jul 12, 2021

Uh oh!

srikanthccv commented Jul 12, 2021

Uh oh!

lzchen commented Jul 12, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

srikanthccv commented Jun 18, 2021 •

edited

Loading

srikanthccv Jun 29, 2021 •

edited

Loading