Class BatchLogRecordProcessor

Hierarchy

BatchLogRecordProcessorBase<logs.BatchLogRecordProcessorOptions>
- BatchLogRecordProcessor

Index

Constructors

Methods

forceFlush onEmit onShutdown shutdown

Constructors

constructor

new BatchLogRecordProcessor(
options: logs.BatchLogRecordProcessorOptions,
): logs.BatchLogRecordProcessor
Parameters
- options: logs.BatchLogRecordProcessorOptions
Returns logs.BatchLogRecordProcessor
Inherited from BatchLogRecordProcessorBase<BatchLogRecordProcessorOptions>.constructor
- Defined in experimental/packages/sdk-logs/build/src/export/BatchLogRecordProcessorBase.d.ts:15

Methods

forceFlush

forceFlush(): Promise<void>
Forces to export all finished log records

Returns Promise<void>
Inherited from BatchLogRecordProcessorBase.forceFlush
- Defined in experimental/packages/sdk-logs/build/src/export/BatchLogRecordProcessorBase.d.ts:17

onEmit

onEmit(logRecord: logs.SdkLogRecord): void
Called when a LogRecord is emit
Parameters
- logRecord: logs.SdkLogRecord
  the ReadWriteLogRecord that just emitted.
Returns void
Inherited from BatchLogRecordProcessorBase.onEmit
- Defined in experimental/packages/sdk-logs/build/src/export/BatchLogRecordProcessorBase.d.ts:16

`Protected`onShutdown

onShutdown(): void
Returns void
Overrides BatchLogRecordProcessorBase.onShutdown
- Defined in experimental/packages/sdk-logs/build/src/platform/node/export/BatchLogRecordProcessor.d.ts:4

shutdown

shutdown(): Promise<void>
Shuts down the processor. Called when SDK is shut down. This is an opportunity for processor to do any cleanup required.

Returns Promise<void>
Inherited from BatchLogRecordProcessorBase.shutdown
- Defined in experimental/packages/sdk-logs/build/src/export/BatchLogRecordProcessorBase.d.ts:20