Skip to content

Commit a5e39f1

Browse files
committed
Enabled
1 parent 21b4940 commit a5e39f1

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

specification/logs/sdk.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -504,11 +504,19 @@ to make sure that they are not invoked concurrently.
504504

505505
**Status**: [Development](../document-status.md)
506506

507-
This is an implementation of `LogRecordProcessor` that filters log records based
508-
on minimum severity level and delegates to a downstream processor.
507+
This processor filters log records by minimum severity level.
509508

510-
Only log records with severity greater than or equal to the configured minimum
511-
are forwarded to the delegate processor.
509+
**Required operations:**
510+
511+
* [`Enabled`](#enabled-1) - Return `false` if the provided
512+
[Severity Number](./data-model.md#field-severitynumber) is below the
513+
configured `minimumSeverity`. Otherwise, forward to the delegate's
514+
`Enabled` method if available and return `true` if not available.
515+
* [`OnEmit`](#onemit) - If the log record's severity is below the configured
516+
`minimumSeverity`, do not forward it to the delegate. Otherwise, forward the
517+
log record to the delegate.
518+
* [`Shutdown`](#shutdown) - Forward to the delegate's `Shutdown` method.
519+
* [`ForceFlush`](#forceflush-1) - Forward to the delegate's `ForceFlush` method.
512520

513521
**Configurable parameters:**
514522

@@ -521,12 +529,19 @@ are forwarded to the delegate processor.
521529

522530
**Status**: [Development](../document-status.md)
523531

524-
This is an implementation of `LogRecordProcessor` that filters out log records
525-
associated with sampled out spans.
532+
This processor filters log records by span sampling status.
533+
534+
**Required operations:**
526535

527-
Log records not tied to any span (invalid span context) are not sampled out and
528-
are forwarded to the delegate processor. Log records that are associated with
529-
valid span contexts are only forwarded if the associated span is sampled in.
536+
* [`Enabled`](#enabled-1) - Return `false` if the current
537+
[Context](../context/README.md) contains a valid span context that is not
538+
sampled. Otherwise, forward to the delegate's `Enabled` method if available
539+
and return `true` if not available.
540+
* [`OnEmit`](#onemit) - If the log record is associated with a valid span
541+
context that is not sampled, do not forward it to the delegate. Otherwise,
542+
forward the log record to the delegate.
543+
* [`Shutdown`](#shutdown) - Forward to the delegate's `Shutdown` method.
544+
* [`ForceFlush`](#forceflush-1) - Forward to the delegate's `ForceFlush` method.
530545

531546
**Configurable parameters:**
532547

0 commit comments

Comments
 (0)