# File

The **file** output plugin allows to write the data received through the *input* plugin to file.

## Configuration Parameters

The plugin supports the following configuration parameters:

| Key     | Description                                                                                                                                                   | Default |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Path    | Directory path to store files. If not set, Fluent Bit will write the files on it's own positioned directory. note: this option was added on Fluent Bit v1.4.6 |         |
| File    | Set file name to store the records. If not set, the file name will be the *tag* associated with the records.                                                  |         |
| Format  | The format of the file content. See also Format section. Default: out\_file.                                                                                  |         |
| Mkdir   | Recursively create output directory if it does not exist. Permissions set to 0755.                                                                            |         |
| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0.                                           | 1       |

## Format

### out\_file format

Output time, tag and json records. There is no configuration parameters for out\_file.

```javascript
tag: [time, {"key1":"value1", "key2":"value2", "key3":"value3"}]
```

### plain format

Output the records as JSON (without additional `tag` and `timestamp` attributes). There is no configuration parameters for plain format.

```javascript
{"key1":"value1", "key2":"value2", "key3":"value3"}
```

### csv format

Output the records as csv. Csv supports an additional configuration parameter.

| Key       | Description                                       |
| --------- | ------------------------------------------------- |
| Delimiter | The character to separate each data. Default: ',' |

```python
time[delimiter]"value1"[delimiter]"value2"[delimiter]"value3"
```

### ltsv format

Output the records as LTSV. LTSV supports an additional configuration parameter.

| Key              | Description                                                 |
| ---------------- | ----------------------------------------------------------- |
| Delimiter        | The character to separate each pair. Default: '\t'(TAB)     |
| Label\_Delimiter | The character to separate label and the value. Default: ':' |

```python
field1[label_delimiter]value1[delimiter]field2[label_delimiter]value2
```

### template format

Output the records using a custom format template.

| Key      | Description                                    |
| -------- | ---------------------------------------------- |
| Template | The format string. Default: '{time} {message}' |

This accepts a formatting template and fills placeholders using corresponding values in a record.

For example, if you set up the configuration as below:

```
[INPUT]
  Name mem

[OUTPUT]
  Name file
  Format template
  Template {time} used={Mem.used} free={Mem.free} total={Mem.total}
```

You will get the following output:

```
1564462620.000254 used=1045448 free=31760160 total=32805608
```

## Getting Started

You can run the plugin from the command line or through the configuration file:

### Command Line

From the command line you can let Fluent Bit count up a data with the following options:

```bash
$ fluent-bit -i cpu -o file -p path=output.txt
```

### Configuration File

In your main configuration file append the following Input & Output sections:

```python
[INPUT]
    Name cpu
    Tag  cpu

[OUTPUT]
    Name file
    Match *
    Path output_dir
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fluentbit.io/manual/1.9/pipeline/outputs/file.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.