> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# veryfront/observability

> Tracing, metrics, OTLP export, and structured logs.

## Import

```ts theme={null}
import {
  addSpanEvent,
  createChildSpan,
  createFileLogSubscriber,
  createOpenTelemetryServiceTracer,
  endSpan,
  extractContext,
} from "veryfront/observability";
```

## Examples

```ts theme={null}
import { withSpan } from "veryfront/observability";

const result = await withSpan("load-data", async () => {
  return await fetch("https://example.com/data");
});
```

## Exports

### Components

| Name        | Description        | Source                                                                                                     |
| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------------- |
| `SpanNames` | Render span names. | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/span-names.ts#L2) |

### Functions

| Name                               | Description                                                          | Source                                                                                                                         |
| ---------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `addSpanEvent`                     | Event emitted for add span.                                          | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L70)                         |
| `createChildSpan`                  | Create child span.                                                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L79)                         |
| `createFileLogSubscriber`          | Create file log subscriber.                                          | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/file-log-subscriber.ts#L194)                  |
| `createOpenTelemetryServiceTracer` | Create open telemetry service tracer.                                | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L177)               |
| `endSpan`                          | End an active tracing span.                                          | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L57)                         |
| `extractContext`                   | Context for extract.                                                 | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L88)                         |
| `getActiveContext`                 | Context for get active.                                              | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L98)                         |
| `getErrorCollector`                | Return error collector.                                              | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/error-collector.ts#L348)                      |
| `getLogBuffer`                     | Return log buffer.                                                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/log-buffer.ts#L174)                           |
| `getMetricsState`                  | State for get metrics.                                               | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L38)                         |
| `initAutoInstrumentation`          | Initialize automatic instrumentation wrappers.                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/orchestrator.ts#L13)          |
| `initializeOTLP`                   | Initialize OTLP tracing export.                                      | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L103)                   |
| `initMetrics`                      | Initialize metrics collection.                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L20)                         |
| `initTracing`                      | Initialize tracing for the current runtime.                          | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L18)                         |
| `injectContext`                    | Context for inject.                                                  | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L93)                         |
| `instrument`                       | Instrument an async operation.                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/wrappers.ts#L6)               |
| `instrumentBatch`                  | Instrument a batch operation.                                        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/wrappers.ts#L50)              |
| `instrumentErrorHandler`           | Handler for instrument error.                                        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/react-instrumentation.ts#L34) |
| `instrumentFetch`                  | Create a fetch implementation instrumented with observability spans. | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/http-instrumentation.ts#L75)  |
| `instrumentHttpHandler`            | Handler for instrument HTTP.                                         | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/http-instrumentation.ts#L38)  |
| `instrumentReactRender`            | Instrument a React render operation.                                 | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/react-instrumentation.ts#L6)  |
| `instrumentSync`                   | Instrument a synchronous operation.                                  | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/wrappers.ts#L28)              |
| `interceptConsole`                 | Capture console output in the log buffer.                            | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/log-buffer.ts#L186)                           |
| `isAutoInstrumentEnabled`          | Check whether auto instrumentation is enabled.                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/orchestrator.ts#L42)          |
| `isMetricsEnabled`                 | Check whether metrics collection is enabled.                         | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L28)                         |
| `isOTLPEnabled`                    | Check whether OTLP export is enabled.                                | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L121)                   |
| `isTracingEnabled`                 | Check whether tracing is enabled.                                    | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L26)                         |
| `parseCompileError`                | Error shape for parse compile.                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/error-collector.ts#L360)                      |
| `parseMaxSize`                     | Parses max size.                                                     | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/file-log-subscriber.ts#L28)                   |
| `recordBuild`                      | Record build.                                                        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L124)                        |
| `recordBundle`                     | Record bundle.                                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L132)                        |
| `recordCacheGet`                   | Record cache get.                                                    | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L56)                         |
| `recordCacheInvalidate`            | Record cache invalidate.                                             | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L69)                         |
| `recordCacheSet`                   | Record cache set.                                                    | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L64)                         |
| `recordCorsRejection`              | Record CORS rejection.                                               | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L153)                        |
| `recordDataFetch`                  | Record data fetch.                                                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L140)                        |
| `recordDataFetchError`             | Error shape for record data fetch.                                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L148)                        |
| `recordHttpRequest`                | Request payload for record HTTP.                                     | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L43)                         |
| `recordHttpRequestComplete`        | Record HTTP request complete.                                        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L48)                         |
| `recordRender`                     | Record render.                                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L82)                         |
| `recordRenderError`                | Error shape for record render.                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L90)                         |
| `recordRSCError`                   | Error shape for record rscerror.                                     | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L119)                        |
| `recordRSCRender`                  | Record RSC render.                                                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L95)                         |
| `recordRSCRequest`                 | Request payload for record rscrequest.                               | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L111)                        |
| `recordRSCStream`                  | Record RSC stream.                                                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L103)                        |
| `recordSecurityHeaders`            | Record security headers.                                             | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L158)                        |
| `resetErrorCollector`              | Reset captured runtime errors.                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/error-collector.ts#L354)                      |
| `resetLogBuffer`                   | Reset the in-memory log buffer.                                      | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/log-buffer.ts#L180)                           |
| `setCacheSize`                     | Sets cache size.                                                     | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L77)                         |
| `setSpanAttributes`                | Sets span attributes.                                                | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L62)                         |
| `shutdownMetrics`                  | Shut down metrics collection.                                        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/index.ts#L33)                         |
| `shutdownOTLP`                     | Shut down OTLP tracing export.                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L115)                   |
| `shutdownTracing`                  | Shut down the tracing runtime.                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L35)                         |
| `startSpan`                        | Starts span.                                                         | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L52)                         |
| `withActiveSpan`                   | Applies active span.                                                 | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L103)                        |
| `withSpan`                         | Applies span.                                                        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L110)                        |
| `withSpanSync`                     | Applies span sync.                                                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/index.ts#L129)                        |

### Classes

| Name                | Description                    | Source                                                                                                       |
| ------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `ErrorCollector`    | Implement error collector.     | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/error-collector.ts#L67)     |
| `FileLogSubscriber` | Implement file log subscriber. | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/file-log-subscriber.ts#L53) |
| `LogBuffer`         | Implement log buffer.          | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/log-buffer.ts#L28)          |

### Types

| Name                                      | Description                                               | Source                                                                                                           |
| ----------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `AutoInstrumentConfig`                    | Configuration used by auto instrument.                    | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/auto-instrument/types.ts#L24)   |
| `CreateOpenTelemetryServiceTracerOptions` | Options accepted by create open telemetry service tracer. | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L96)  |
| `DevError`                                | Error shape for dev.                                      | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/error-collector.ts#L26)         |
| `ErrorFilter`                             | Public API contract for error filter.                     | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/error-collector.ts#L52)         |
| `ErrorSubscriber`                         | Public API contract for error subscriber.                 | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/error-collector.ts#L64)         |
| `ErrorType`                               | Public API contract for error type.                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/error-collector.ts#L12)         |
| `FileLogConfig`                           | Configuration used by file log.                           | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/file-log-subscriber.ts#L4)      |
| `LogBufferFilter`                         | Filter options for reading buffered log entries.          | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/log-buffer.ts#L16)              |
| `LogEntry`                                | Entry shape for log.                                      | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/log-buffer.ts#L7)               |
| `LogLevel`                                | Public API contract for log level.                        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/log-buffer.ts#L4)               |
| `LogSubscriber`                           | Public API contract for log subscriber.                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/log-buffer.ts#L25)              |
| `MetricsConfig`                           | Configuration used by metrics.                            | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/metrics/types.ts#L64)           |
| `OpenTelemetryContextApi`                 | Public API contract for open telemetry context API.       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L31)  |
| `OpenTelemetryServiceTracer`              | Public API contract for open telemetry service tracer.    | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L108) |
| `OpenTelemetrySpan`                       | Public API contract for open telemetry span.              | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L8)   |
| `OpenTelemetrySpanContext`                | Context for open telemetry span.                          | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L2)   |
| `OpenTelemetryTraceApi`                   | Public API contract for open telemetry trace API.         | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L24)  |
| `OpenTelemetryTracer`                     | Public API contract for open telemetry tracer.            | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L18)  |
| `OTLPConfig`                              | Configuration used by otlpconfig.                         | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L36)      |
| `ServiceTracer`                           | Public API contract for service tracer.                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L78)  |
| `ServiceTracerAttributeInput`             | Input payload for service tracer attribute.               | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L37)  |
| `ServiceTracerAttributes`                 | Public API contract for service tracer attributes.        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L46)  |
| `ServiceTracerAttributeValue`             | Public API contract for service tracer attribute value.   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L40)  |
| `ServiceTracerSpan`                       | Public API contract for service tracer span.              | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L55)  |
| `ServiceTracerSpanContext`                | Context for service tracer span.                          | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L49)  |
| `ServiceTracerStartSpanOptions`           | Options accepted by service tracer start span.            | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/service-tracer.ts#L69)  |
| `SpanOptions`                             | Options accepted by span.                                 | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/types.ts#L14)           |
| `TracingConfig`                           | Configuration used by tracing.                            | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/types.ts#L4)            |

## Deep imports

These import paths group focused functionality under this module. Each is a separate barrel; import only what you need.

### `veryfront/observability/otlp-setup`

\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* OpenTelemetry OTLP Setup Thin wrapper that delegates to the `ext-observability-opentelemetry` extension via the `TracingExporter` contract. When the extension is not installed, all span operations silently no-op. Reads configuration from environment variables: - OTEL\_TRACES\_ENABLED: "true" to enable tracing - OTEL\_SERVICE\_NAME: Service name for traces - OTEL\_EXPORTER\_OTLP\_ENDPOINT: OTLP endpoint - OTEL\_EXPORTER\_OTLP\_HEADERS: Auth headers \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

```ts theme={null}
import { endServerSpan, extractContext, getTraceContext } from "veryfront/observability/otlp-setup";
```

#### Functions

| Name                      | Description                                         | Source                                                                                                       |
| ------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `endServerSpan`           | End an active server tracing span.                  | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L230) |
| `extractContext`          | Context for extract.                                | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L199) |
| `getTraceContext`         | Context for get trace.                              | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L279) |
| `initializeOTLP`          | Initialize OTLP tracing export.                     | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L103) |
| `initializeOTLPWithApis`  | Initialize OTLP tracing with explicit API adapters. | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L126) |
| `injectContext`           | Context for inject.                                 | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L207) |
| `isOTLPEnabled`           | Check whether OTLP export is enabled.               | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L121) |
| `setActiveSpanAttributes` | Sets active span attributes.                        | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L264) |
| `setSpanAttributes`       | Sets span attributes.                               | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L253) |
| `shutdownOTLP`            | Shut down OTLP tracing export.                      | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L115) |
| `startServerSpan`         | Starts server span.                                 | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L214) |
| `withContext`             | Context for with.                                   | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L274) |
| `withSpan`                | Applies span.                                       | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L143) |
| `withSpanSync`            | Applies span sync.                                  | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L172) |

#### Types

| Name         | Description                       | Source                                                                                                      |
| ------------ | --------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `OTLPConfig` | Configuration used by otlpconfig. | [source](https://github.com/veryfront/veryfront-code/blob/main/src/observability/tracing/otlp-setup.ts#L36) |