BitLogger/docs/api/index.md

---
name: api-index
group: api
category: index
update-time: 20260512
description: API navigation index for BitLogger and bitlogger_async.
key-word:
    - api
    - index
    - logger
    - async
---

## Api-index

BitLogger API navigation.

## Target and verification

- [target-verification.md](./target-verification.md)

## Core logger

- [logger.md](./logger.md)
- [logger-new.md](./logger-new.md)
- [logger-with-target.md](./logger-with-target.md)
- [logger-child.md](./logger-child.md)
- [logger-with-min-level.md](./logger-with-min-level.md)
- [logger-with-timestamp.md](./logger-with-timestamp.md)
- [logger-with-context-fields.md](./logger-with-context-fields.md)
- [logger-bind.md](./logger-bind.md)
- [logger-with-filter.md](./logger-with-filter.md)
- [logger-with-patch.md](./logger-with-patch.md)
- [logger-with-queue.md](./logger-with-queue.md)

## Logger write APIs

- [logger-is-enabled.md](./logger-is-enabled.md)
- [logger-log.md](./logger-log.md)
- [logger-trace.md](./logger-trace.md)
- [logger-debug.md](./logger-debug.md)
- [logger-info.md](./logger-info.md)
- [logger-warn.md](./logger-warn.md)
- [logger-error.md](./logger-error.md)

## Global logger helpers

- [set-default-min-level.md](./set-default-min-level.md)
- [set-default-target.md](./set-default-target.md)
- [default-logger.md](./default-logger.md)
- [global-style-tag-registry.md](./global-style-tag-registry.md)
- [set-global-style-tag-registry.md](./set-global-style-tag-registry.md)
- [reset-global-style-tag-registry.md](./reset-global-style-tag-registry.md)
- [global-log.md](./global-log.md)
- [global-trace.md](./global-trace.md)
- [global-debug.md](./global-debug.md)
- [global-info.md](./global-info.md)
- [global-warn.md](./global-warn.md)
- [global-error.md](./global-error.md)

## Formatter and fields

- [field.md](./field.md)
- [field-type.md](./field-type.md)
- [field-with-value.md](./field-with-value.md)
- [record-formatter.md](./record-formatter.md)
- [color-mode.md](./color-mode.md)
- [color-support.md](./color-support.md)
- [style-markup-mode.md](./style-markup-mode.md)
- [text-style-type.md](./text-style-type.md)
- [text-style.md](./text-style.md)
- [style-tag-registry-type.md](./style-tag-registry-type.md)
- [style-tag-registry.md](./style-tag-registry.md)
- [style-tag-registry-set-tag.md](./style-tag-registry-set-tag.md)
- [style-tag-registry-get.md](./style-tag-registry-get.md)
- [style-tag-registry-contains.md](./style-tag-registry-contains.md)
- [style-tag-registry-define-alias.md](./style-tag-registry-define-alias.md)
- [default-style-tag-registry.md](./default-style-tag-registry.md)
- [text-formatter-type.md](./text-formatter-type.md)
- [text-formatter.md](./text-formatter.md)
- [text-formatter-with-style-markup.md](./text-formatter-with-style-markup.md)
- [text-formatter-without-style-markup.md](./text-formatter-without-style-markup.md)
- [text-formatter-with-target-style-markup.md](./text-formatter-with-target-style-markup.md)
- [text-formatter-with-fields-style-markup.md](./text-formatter-with-fields-style-markup.md)
- [text-formatter-with-color-support.md](./text-formatter-with-color-support.md)
- [text-formatter-with-style-tags.md](./text-formatter-with-style-tags.md)
- [format-text.md](./format-text.md)
- [format-json.md](./format-json.md)
- [text-formatter-config.md](./text-formatter-config.md)
- [default-text-formatter-config.md](./default-text-formatter-config.md)
- [text-formatter-config-to-formatter.md](./text-formatter-config-to-formatter.md)
- [text-formatter-config-to-json.md](./text-formatter-config-to-json.md)
- [stringify-text-formatter-config.md](./stringify-text-formatter-config.md)
- [color-support-label.md](./color-support-label.md)
- [style-markup-mode-label.md](./style-markup-mode-label.md)
- [color-mode-label.md](./color-mode-label.md)
- [fields.md](./fields.md)
- [text-formatter-config-type.md](./text-formatter-config-type.md)

## Record and level

- [record.md](./record.md)
- [record-new.md](./record-new.md)
- [record-copy.md](./record-copy.md)
- [record-with-target.md](./record-with-target.md)
- [record-with-message.md](./record-with-message.md)
- [record-with-fields.md](./record-with-fields.md)
- [level.md](./level.md)
- [level-priority.md](./level-priority.md)
- [level-label.md](./level-label.md)
- [level-enabled.md](./level-enabled.md)

## Sink and file

- [context-sink-type.md](./context-sink-type.md)
- [console-sink.md](./console-sink.md)
- [console-sink-type.md](./console-sink-type.md)
- [json-console-sink.md](./json-console-sink.md)
- [json-console-sink-type.md](./json-console-sink-type.md)
- [formatted-console-sink.md](./formatted-console-sink.md)
- [formatted-console-sink-type.md](./formatted-console-sink-type.md)
- [text-console-sink.md](./text-console-sink.md)
- [callback-sink.md](./callback-sink.md)
- [callback-sink-type.md](./callback-sink-type.md)
- [formatted-callback-sink.md](./formatted-callback-sink.md)
- [formatted-callback-sink-type.md](./formatted-callback-sink-type.md)
- [text-callback-sink.md](./text-callback-sink.md)
- [fanout-sink.md](./fanout-sink.md)
- [fanout-sink-type.md](./fanout-sink-type.md)
- [split-sink.md](./split-sink.md)
- [split-sink-type.md](./split-sink-type.md)
- [split-by-level.md](./split-by-level.md)
- [buffered-sink.md](./buffered-sink.md)
- [buffered-sink-type.md](./buffered-sink-type.md)
- [buffered-sink-pending-count.md](./buffered-sink-pending-count.md)
- [buffered-sink-flush.md](./buffered-sink-flush.md)
- [queued-sink.md](./queued-sink.md)
- [queued-sink-type.md](./queued-sink-type.md)
- [queued-sink-pending-count.md](./queued-sink-pending-count.md)
- [queued-sink-dropped-count.md](./queued-sink-dropped-count.md)
- [queued-sink-drain.md](./queued-sink-drain.md)
- [queued-sink-flush.md](./queued-sink-flush.md)
- [queue-overflow-policy.md](./queue-overflow-policy.md)
- [filter-sink.md](./filter-sink.md)
- [filter-sink-type.md](./filter-sink-type.md)
- [patch-sink.md](./patch-sink.md)
- [patch-sink-type.md](./patch-sink-type.md)
- [file-sink.md](./file-sink.md)
- [file-sink-available.md](./file-sink-available.md)
- [file-sink-flush.md](./file-sink-flush.md)
- [file-sink-close.md](./file-sink-close.md)
- [file-sink-append-mode.md](./file-sink-append-mode.md)
- [file-sink-path.md](./file-sink-path.md)
- [file-sink-auto-flush-enabled.md](./file-sink-auto-flush-enabled.md)
- [file-sink-rotation-enabled.md](./file-sink-rotation-enabled.md)
- [file-sink-rotation-config.md](./file-sink-rotation-config.md)
- [file-sink-set-append-mode.md](./file-sink-set-append-mode.md)
- [file-sink-set-auto-flush.md](./file-sink-set-auto-flush.md)
- [file-sink-set-policy.md](./file-sink-set-policy.md)
- [file-sink-clear-rotation.md](./file-sink-clear-rotation.md)
- [file-sink-set-rotation.md](./file-sink-set-rotation.md)
- [file-sink-policy-method.md](./file-sink-policy-method.md)
- [file-sink-default-policy.md](./file-sink-default-policy.md)
- [file-sink-policy-matches-default.md](./file-sink-policy-matches-default.md)
- [file-sink-state-method.md](./file-sink-state-method.md)
- [file-sink-rotation-failures.md](./file-sink-rotation-failures.md)
- [file-sink-open-failures.md](./file-sink-open-failures.md)
- [file-sink-write-failures.md](./file-sink-write-failures.md)
- [file-sink-flush-failures.md](./file-sink-flush-failures.md)
- [file-sink-reset-failure-counters.md](./file-sink-reset-failure-counters.md)
- [file-sink-reset-policy.md](./file-sink-reset-policy.md)
- [file-sink-reopen.md](./file-sink-reopen.md)
- [file-sink-reopen-with-current-policy.md](./file-sink-reopen-with-current-policy.md)
- [file-sink-reopen-append.md](./file-sink-reopen-append.md)
- [file-sink-reopen-truncate.md](./file-sink-reopen-truncate.md)
- [file-sink-type.md](./file-sink-type.md)
- [native-files-supported.md](./native-files-supported.md)
- [file-rotation.md](./file-rotation.md)
- [file-rotation-type.md](./file-rotation-type.md)
- [file-sink-policy-to-json.md](./file-sink-policy-to-json.md)
- [file-sink-policy.md](./file-sink-policy.md)
- [file-sink-policy-new.md](./file-sink-policy-new.md)
- [stringify-file-sink-policy.md](./stringify-file-sink-policy.md)
- [file-sink-state-new.md](./file-sink-state-new.md)
- [file-sink-state-to-json.md](./file-sink-state-to-json.md)
- [file-sink-state.md](./file-sink-state.md)
- [stringify-file-sink-state.md](./stringify-file-sink-state.md)
- [runtime-file-state-new.md](./runtime-file-state-new.md)
- [runtime-file-state-to-json.md](./runtime-file-state-to-json.md)
- [runtime-file-state.md](./runtime-file-state.md)
- [stringify-runtime-file-state.md](./stringify-runtime-file-state.md)
- [sink-config.md](./sink-config.md)
- [sink-config-to-json.md](./sink-config-to-json.md)
- [stringify-sink-config.md](./stringify-sink-config.md)

## Predicates and helpers

- [record-predicate.md](./record-predicate.md)
- [record-patch.md](./record-patch.md)
- [level-at-least.md](./level-at-least.md)
- [target-is.md](./target-is.md)
- [target-has-prefix.md](./target-has-prefix.md)
- [message-contains.md](./message-contains.md)
- [has-field.md](./has-field.md)
- [field-equals.md](./field-equals.md)
- [not.md](./not.md)
- [all-of.md](./all-of.md)
- [any-of.md](./any-of.md)
- [identity-patch.md](./identity-patch.md)
- [set-target.md](./set-target.md)
- [prefix-message.md](./prefix-message.md)
- [append-fields.md](./append-fields.md)
- [redact-field.md](./redact-field.md)
- [redact-fields.md](./redact-fields.md)
- [compose-patches.md](./compose-patches.md)

## Config build flow

- [config-error.md](./config-error.md)
- [sink-kind.md](./sink-kind.md)
- [file-rotation-config-to-json.md](./file-rotation-config-to-json.md)
- [queue-config-type.md](./queue-config-type.md)
- [queue-config.md](./queue-config.md)
- [queue-config-to-json.md](./queue-config-to-json.md)
- [stringify-queue-config.md](./stringify-queue-config.md)
- [sink-config-type.md](./sink-config-type.md)
- [default-sink-config.md](./default-sink-config.md)
- [logger-config.md](./logger-config.md)
- [logger-config-type.md](./logger-config-type.md)
- [default-logger-config.md](./default-logger-config.md)
- [logger-config-to-json.md](./logger-config-to-json.md)
- [stringify-logger-config.md](./stringify-logger-config.md)
- [parse-logger-config-text.md](./parse-logger-config-text.md)
- [build-logger.md](./build-logger.md)
- [parse-and-build-logger.md](./parse-and-build-logger.md)

## Presets

- [console.md](./console.md)
- [json-console.md](./json-console.md)
- [text-console.md](./text-console.md)
- [file.md](./file.md)
- [with-queue.md](./with-queue.md)
- [with-file-rotation.md](./with-file-rotation.md)

## Async logger

- [async-logger-type.md](./async-logger-type.md)
- [async-logger.md](./async-logger.md)
- [async-logger-run.md](./async-logger-run.md)
- [async-logger-log.md](./async-logger-log.md)
- [async-logger-trace.md](./async-logger-trace.md)
- [async-logger-debug.md](./async-logger-debug.md)
- [async-logger-info.md](./async-logger-info.md)
- [async-logger-warn.md](./async-logger-warn.md)
- [async-logger-error.md](./async-logger-error.md)

## Async composition

- [async-logger-with-target.md](./async-logger-with-target.md)
- [async-logger-child.md](./async-logger-child.md)
- [async-logger-with-min-level.md](./async-logger-with-min-level.md)
- [async-logger-with-timestamp.md](./async-logger-with-timestamp.md)
- [async-logger-with-context-fields.md](./async-logger-with-context-fields.md)
- [async-logger-with-filter.md](./async-logger-with-filter.md)
- [async-logger-with-patch.md](./async-logger-with-patch.md)

## Async lifecycle and state

- [async-logger-state-type.md](./async-logger-state-type.md)
- [async-logger-state-new.md](./async-logger-state-new.md)
- [async-logger-pending-count.md](./async-logger-pending-count.md)
- [async-logger-dropped-count.md](./async-logger-dropped-count.md)
- [async-logger-is-closed.md](./async-logger-is-closed.md)
- [async-logger-is-running.md](./async-logger-is-running.md)
- [async-logger-has-failed.md](./async-logger-has-failed.md)
- [async-logger-last-error.md](./async-logger-last-error.md)
- [async-logger-flush-policy.md](./async-logger-flush-policy.md)
- [async-logger-state.md](./async-logger-state.md)
- [async-logger-state-to-json.md](./async-logger-state-to-json.md)
- [stringify-async-logger-state.md](./stringify-async-logger-state.md)
- [async-logger-close.md](./async-logger-close.md)
- [async-logger-wait-idle.md](./async-logger-wait-idle.md)
- [async-logger-shutdown.md](./async-logger-shutdown.md)

## Async runtime and config

- [async-overflow-policy.md](./async-overflow-policy.md)
- [async-flush-policy.md](./async-flush-policy.md)
- [async-runtime-state-type.md](./async-runtime-state-type.md)
- [async-runtime-state-new.md](./async-runtime-state-new.md)
- [async-runtime-mode.md](./async-runtime-mode.md)
- [async-runtime-mode-label.md](./async-runtime-mode-label.md)
- [async-runtime-supports-background-worker.md](./async-runtime-supports-background-worker.md)
- [async-runtime-state.md](./async-runtime-state.md)
- [async-runtime-state-to-json.md](./async-runtime-state-to-json.md)
- [stringify-async-runtime-state.md](./stringify-async-runtime-state.md)
- [async-logger-config-type.md](./async-logger-config-type.md)
- [async-logger-config.md](./async-logger-config.md)
- [parse-async-logger-config-text.md](./parse-async-logger-config-text.md)
- [async-logger-config-to-json.md](./async-logger-config-to-json.md)
- [stringify-async-logger-config.md](./stringify-async-logger-config.md)
- [async-logger-build-config-type.md](./async-logger-build-config-type.md)
- [async-logger-build-config.md](./async-logger-build-config.md)
- [parse-async-logger-build-config-text.md](./parse-async-logger-build-config-text.md)
- [build-async-logger.md](./build-async-logger.md)
- [build-async-text-logger.md](./build-async-text-logger.md)
- [async-logger-build-config-to-json.md](./async-logger-build-config-to-json.md)
- [stringify-async-logger-build-config.md](./stringify-async-logger-build-config.md)

## Application and library facades

- [library-logger.md](./library-logger.md)
- [library-logger-new.md](./library-logger-new.md)
- [logger-to-library-logger.md](./logger-to-library-logger.md)
- [library-logger-to-logger.md](./library-logger-to-logger.md)
- [library-logger-with-target.md](./library-logger-with-target.md)
- [library-logger-child.md](./library-logger-child.md)
- [library-logger-with-context-fields.md](./library-logger-with-context-fields.md)
- [library-logger-bind.md](./library-logger-bind.md)
- [library-logger-is-enabled.md](./library-logger-is-enabled.md)
- [library-logger-log.md](./library-logger-log.md)
- [library-logger-info.md](./library-logger-info.md)
- [library-logger-warn.md](./library-logger-warn.md)
- [library-logger-error.md](./library-logger-error.md)
- [application-logger.md](./application-logger.md)
- [build-application-logger.md](./build-application-logger.md)
- [parse-and-build-application-logger.md](./parse-and-build-application-logger.md)
- [build-library-logger.md](./build-library-logger.md)
- [parse-and-build-library-logger.md](./parse-and-build-library-logger.md)
- [default-library-logger.md](./default-library-logger.md)
- [library-async-logger.md](./library-async-logger.md)
- [async-logger-to-library-async-logger.md](./async-logger-to-library-async-logger.md)
- [library-async-logger-to-async-logger.md](./library-async-logger-to-async-logger.md)
- [library-async-logger-new.md](./library-async-logger-new.md)
- [library-async-logger-with-target.md](./library-async-logger-with-target.md)
- [library-async-logger-child.md](./library-async-logger-child.md)
- [library-async-logger-with-context-fields.md](./library-async-logger-with-context-fields.md)
- [library-async-logger-bind.md](./library-async-logger-bind.md)
- [library-async-logger-is-enabled.md](./library-async-logger-is-enabled.md)
- [library-async-logger-log.md](./library-async-logger-log.md)
- [library-async-logger-info.md](./library-async-logger-info.md)
- [library-async-logger-warn.md](./library-async-logger-warn.md)
- [library-async-logger-error.md](./library-async-logger-error.md)
- [library-async-logger-run.md](./library-async-logger-run.md)
- [library-async-logger-shutdown.md](./library-async-logger-shutdown.md)
- [application-async-logger.md](./application-async-logger.md)
- [application-text-async-logger.md](./application-text-async-logger.md)
- [build-application-async-logger.md](./build-application-async-logger.md)
- [build-application-text-async-logger.md](./build-application-text-async-logger.md)
- [parse-and-build-application-async-logger.md](./parse-and-build-application-async-logger.md)
- [build-library-async-logger.md](./build-library-async-logger.md)
- [build-library-async-text-logger.md](./build-library-async-text-logger.md)
- [parse-and-build-library-async-logger.md](./parse-and-build-library-async-logger.md)

## Configured logger runtime

- [runtime-sink.md](./runtime-sink.md)
- [runtime-sink-flush.md](./runtime-sink-flush.md)
- [runtime-sink-drain.md](./runtime-sink-drain.md)
- [runtime-sink-close.md](./runtime-sink-close.md)
- [runtime-sink-pending-count.md](./runtime-sink-pending-count.md)
- [runtime-sink-dropped-count.md](./runtime-sink-dropped-count.md)
- [runtime-sink-file-path.md](./runtime-sink-file-path.md)
- [runtime-sink-file-available.md](./runtime-sink-file-available.md)
- [runtime-sink-file-reopen.md](./runtime-sink-file-reopen.md)
- [runtime-sink-file-reopen-with-current-policy.md](./runtime-sink-file-reopen-with-current-policy.md)
- [runtime-sink-file-reopen-append.md](./runtime-sink-file-reopen-append.md)
- [runtime-sink-file-reopen-truncate.md](./runtime-sink-file-reopen-truncate.md)
- [runtime-sink-file-append-mode.md](./runtime-sink-file-append-mode.md)
- [runtime-sink-file-set-append-mode.md](./runtime-sink-file-set-append-mode.md)
- [runtime-sink-file-auto-flush.md](./runtime-sink-file-auto-flush.md)
- [runtime-sink-file-set-auto-flush.md](./runtime-sink-file-set-auto-flush.md)
- [configured-logger.md](./configured-logger.md)
- [configured-logger-flush.md](./configured-logger-flush.md)
- [configured-logger-drain.md](./configured-logger-drain.md)
- [configured-logger-close.md](./configured-logger-close.md)
- [configured-logger-pending-count.md](./configured-logger-pending-count.md)
- [configured-logger-dropped-count.md](./configured-logger-dropped-count.md)

## Configured logger file runtime

- [configured-logger-file-available.md](./configured-logger-file-available.md)
- [configured-logger-file-path.md](./configured-logger-file-path.md)
- [configured-logger-file-state.md](./configured-logger-file-state.md)
- [configured-logger-file-runtime-state.md](./configured-logger-file-runtime-state.md)
- [configured-logger-file-policy.md](./configured-logger-file-policy.md)
- [configured-logger-file-default-policy.md](./configured-logger-file-default-policy.md)
- [configured-logger-file-policy-matches-default.md](./configured-logger-file-policy-matches-default.md)
- [configured-logger-file-rotation-config.md](./configured-logger-file-rotation-config.md)
- [configured-logger-file-rotation-enabled.md](./configured-logger-file-rotation-enabled.md)
- [configured-logger-file-append-mode.md](./configured-logger-file-append-mode.md)
- [configured-logger-file-auto-flush.md](./configured-logger-file-auto-flush.md)
- [configured-logger-file-open-failures.md](./configured-logger-file-open-failures.md)
- [configured-logger-file-write-failures.md](./configured-logger-file-write-failures.md)
- [configured-logger-file-flush-failures.md](./configured-logger-file-flush-failures.md)
- [configured-logger-file-rotation-failures.md](./configured-logger-file-rotation-failures.md)

## Configured logger file control

- [configured-logger-file-flush.md](./configured-logger-file-flush.md)
- [configured-logger-file-close.md](./configured-logger-file-close.md)
- [configured-logger-file-reopen.md](./configured-logger-file-reopen.md)
- [configured-logger-file-reopen-append.md](./configured-logger-file-reopen-append.md)
- [configured-logger-file-reopen-truncate.md](./configured-logger-file-reopen-truncate.md)
- [configured-logger-file-reopen-with-current-policy.md](./configured-logger-file-reopen-with-current-policy.md)
- [configured-logger-file-set-policy.md](./configured-logger-file-set-policy.md)
- [configured-logger-file-reset-policy.md](./configured-logger-file-reset-policy.md)
- [configured-logger-file-set-rotation.md](./configured-logger-file-set-rotation.md)
- [configured-logger-file-clear-rotation.md](./configured-logger-file-clear-rotation.md)
- [configured-logger-file-set-append-mode.md](./configured-logger-file-set-append-mode.md)
- [configured-logger-file-set-auto-flush.md](./configured-logger-file-set-auto-flush.md)
- [configured-logger-file-reset-failure-counters.md](./configured-logger-file-reset-failure-counters.md)