---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: observefs
excerpt: |
  DuckDB Community Extensions
  Provides IO observability to filesystem

extension:
  name: observefs
  description: Provides IO observability to filesystem
  version: 0.6.0
  language: C++
  build: cmake
  license: MIT
  excluded_platforms: "wasm_mvp;wasm_eh;wasm_threads"
  maintainers:
    - dentiny
    - peterxcli

repo:
  github: dentiny/duckdb-filesystem-observability
  andium: cb6a1a7d88eba7f02a9690e1df4c6bf4e166a9f3
  ref: 7ce82e737b047cdb03e9ad8e854ea73d43896844

docs:
  hello_world: |
    COPY (SELECT observefs_get_profile()) TO '/tmp/output.txt';
  extended_description: |
    This extension provides observability to duckdb filesystems.
    It supports a few key features:
    - 100% compatible with duckdb httpfs
    - Record latency for most of the IO operations (open, read, write, etc)
    - Provides both process-wise and bucket-wise latency stats (including histogram and quantile estimation) to all read operations
    - Provides cache access insight to duckdb external file cache
    - Allows registering ANY duckdb compatible filesystems (i.e., azure filesystem)

extension_star_count: 18
extension_star_count_pretty: 18
extension_download_count: 19299
extension_download_count_pretty: 19.3k
image: '/images/community_extensions/social_preview/preview_community_extension_observefs.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Linux ARM64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| macOS AMD64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| macOS ARM64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Windows AMD64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ❌ | ❌ | ❌ | ❌ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

|                   function_name                   | function_type |                               description                                | comment |                         examples                          |
|---------------------------------------------------|---------------|--------------------------------------------------------------------------|---------|-----------------------------------------------------------|
| observefs_clear                                   | scalar        | Clears collected I/O observability metrics for all wrapped filesystems.  | NULL    | [observefs_clear()]                                       |
| observefs_clear_external_file_cache_access_record | scalar        | Clears the recorded external file cache hit and miss counts.             | NULL    | [observefs_clear_external_file_cache_access_record()]     |
| observefs_external_file_cache_access_record       | table         | Returns recorded external file cache hit, miss, and partial-hit counts.  | NULL    | [observefs_external_file_cache_access_record()]           |
| observefs_get_profile                             | scalar        | Returns a human-readable profile of I/O metrics for wrapped filesystems. | NULL    | [observefs_get_profile()]                                 |
| observefs_list_registered_filesystems             | table         | Lists the filesystem implementations registered with DuckDB.             | NULL    | [observefs_list_registered_filesystems()]                 |
| observefs_wrap_filesystem                         | scalar        | Wraps a registered filesystem with I/O observability instrumentation.    | NULL    | [observefs_wrap_filesystem('AzureBlobStorageFileSystem')] |

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

|                    name                    |                       description                       | input_type | scope  | aliases | typed_value |
|--------------------------------------------|---------------------------------------------------------|------------|--------|---------|-------------|
| observefs_enable_external_file_cache_stats | Whether to enable stats record for external file cache. | BOOLEAN    | GLOBAL | []      | 1           |
| temp_directory                             | Set the directory to which temporary files are written. | VARCHAR    | GLOBAL | []      | post.db.tmp |