# opentelemetry.sdk._logs package

class opentelemetry.sdk._logs.Logger(resource, multi_log_record_processor, instrumentation_scope)

  Bases: `Logger`

  emit(record=None, *, timestamp=None, observed_timestamp=None, context=None, severity_number=None, severity_text=None, body=None, attributes=None, event_name=None)

    Emits the `ReadWriteLogRecord` by setting instrumentation scope and forwarding to the processor.

    Return type:

      `None`

  property resource

class opentelemetry.sdk._logs.LoggerProvider(resource=None, shutdown_on_exit=True, multi_log_record_processor=None)

  Bases: `LoggerProvider`

  add_log_record_processor(log_record_processor)

    Registers a new `LogRecordProcessor` for this `LoggerProvider` instance.

    The log processors are invoked in the same order they are registered.

  force_flush(timeout_millis=30000)

    Force flush the log processors.

    Parameters:

      timeout_millis (`int`) – The maximum amount of time to wait for logs to be exported.

    Return type:

      `bool`

    Returns:

      True if all the log processors flushes the logs within timeout, False otherwise.

  get_logger(name, version=None, schema_url=None, attributes=None)

    Returns a `Logger` for use by the given instrumentation library.

    For any two calls with identical parameters, it is undefined whether the same or different `Logger` instances are returned.

    This function may return different `Logger` types (e.g. a no-op logger vs. a functional logger).

    Parameters:

      - name (`str`) –

        The name of the instrumenting module, package or class. This should not be the name of the module, package or class that is instrumented but the name of the code doing the instrumentation. E.g., instead of `"requests"`, use `"opentelemetry.instrumentation.requests"`.

        For log sources which define a logger name (e.g. logging.Logger.name) the Logger Name should be recorded as the instrumentation scope name.

      - version (`str` | `None`) – Optional. The version string of the instrumenting library. Usually this should be the same as `importlib.metadata.version(instrumenting_library_name)`.

      - schema_url (`str` | `None`) – Optional. Specifies the Schema URL of the emitted telemetry.

      - attributes (`Mapping`[`str`, `str` | `bool` | `int` | `float` | `bytes` | `Sequence`[AnyValue] | `Mapping`[`str`, AnyValue] | `None`] | `None`) – Optional. Specifies the instrumentation scope attributes to associate with emitted telemetry.

    Return type:

      `Logger`

  property resource
  shutdown()

    Shuts down the log processors.

class opentelemetry.sdk._logs.LoggingHandler(level=0, logger_provider=None)

  Bases: `Handler`

  A handler class which writes logging records, in OTLP format, to a network destination or file. Supports signals from the `logging` module. https://docs.python.org/3/library/logging.html

  emit(record)

    Emit a record. Skip emitting if logger is NoOp.

    The record is translated to OTel format, and then sent across the pipeline.

    Return type:

      `None`

  flush()

    Flushes the logging output. Skip flushing if logging_provider has no force_flush method.

    Return type:

      `None`

class opentelemetry.sdk._logs.LogLimits(max_attributes=None, max_attribute_length=None)

  Bases: `LogRecordLimits`

class opentelemetry.sdk._logs.LogRecordLimits(max_attributes=None, max_attribute_length=None)

  Bases: `object`

  This class is based on a SpanLimits class in the Tracing module.

  This class represents the limits that should be enforced on recorded data such as events, links, attributes etc.

  This class does not enforce any limits itself. It only provides a way to read limits from env, default values and from user provided arguments.

  All limit arguments must be either a non-negative integer or `None`.

  - All limit arguments are optional.

  - If a limit argument is not set, the class will try to read its value from the corresponding environment variable.

  - If the environment variable is not set, the default value, if any, will be used.

  Limit precedence:

  - If a model specific limit is set, it will be used.

  - Else if the corresponding global limit is set, it will be used.

  - Else if the model specific limit has a default value, the default value will be used.

  - Else if the global limit has a default value, the default value will be used.

  Parameters:

    - max_attributes (`int` | `None`) – Maximum number of attributes that can be added to a span, event, and link. Environment variable: `OTEL_ATTRIBUTE_COUNT_LIMIT` Default: {_DEFAULT_OTEL_ATTRIBUTE_COUNT_LIMIT}

    - max_attribute_length (`int` | `None`) – Maximum length an attribute value can have. Values longer than the specified length will be truncated.

class opentelemetry.sdk._logs.LogRecordProcessor

  Bases: `ABC`

  Interface to hook the log record emitting action.

  Log processors can be registered directly using `LoggerProvider.add_log_record_processor()` and they are invoked in the same order as they were registered.

  abstractmethod force_flush(timeout_millis=30000)

    Export all the received logs to the configured Exporter that have not yet been exported.

    Parameters:

      timeout_millis (`int`) – The maximum amount of time to wait for logs to be exported.

    Return type:

      `bool`

    Returns:

      False if the timeout is exceeded, True otherwise.

  abstractmethod on_emit(log_record)

    Emits the `ReadWriteLogRecord`

  abstractmethod shutdown()

    Called when a `opentelemetry.sdk._logs.Logger` is shutdown

exception opentelemetry.sdk._logs.LogDroppedAttributesWarning(**kwargs)

  Bases: `LogRecordDroppedAttributesWarning`

exception opentelemetry.sdk._logs.LogRecordDroppedAttributesWarning

  Bases: `UserWarning`

  Custom warning to indicate dropped log attributes due to limits.

  This class is used to filter and handle these specific warnings separately from other warnings, ensuring that they are only shown once without interfering with default user warnings.

class opentelemetry.sdk._logs.ReadableLogRecord(log_record, resource, instrumentation_scope=None, limits=None)

  Bases: `object`

  Readable LogRecord should be kept exactly in-sync with ReadWriteLogRecord, only difference is the frozen=True param.

  property dropped_attributes: int
  instrumentation_scope: `InstrumentationScope` | `None` = None
  limits: `LogRecordLimits` | `None` = None
  to_json(indent=4)
    Return type:

      `str`

  log_record: `LogRecord`
  resource: `Resource`

class opentelemetry.sdk._logs.ReadWriteLogRecord(log_record, resource=<opentelemetry.sdk.resources.Resource object>, instrumentation_scope=None, limits=<factory>)

  Bases: `object`

  A ReadWriteLogRecord instance represents an event being logged. ReadWriteLogRecord instances are created and emitted via `Logger` every time something is logged. They contain all the information pertinent to the event being logged.

  property dropped_attributes: int
  instrumentation_scope: `InstrumentationScope` | `None` = None
  resource: `Resource` | `None` = <opentelemetry.sdk.resources.Resource object>
  log_record: `LogRecord`
  limits: `LogRecordLimits`