Skip to content

Commit 8a08379

Browse files
committed
pipeline: output: treasure data: style:
Signed-off-by: Lynette Miles <[email protected]>
1 parent 5d81c13 commit 8a08379

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

pipeline/outputs/treasure-data.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,33 @@
11
# Treasure Data
22

3-
The **td** output plugin, allows to flush your records into the [Treasure Data](http://treasuredata.com) cloud service.
3+
The _Treasure Data_ (TD) output plugin lets you flush your records into the [Treasure Data](http://treasuredata.com) cloud service.
44

5-
## Configuration Parameters
5+
## Configuration parameters
66

77
The plugin supports the following configuration parameters:
88

9-
| Key | Description | Default |
10-
|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
11-
| API | The [Treasure Data](http://treasuredata.com) API key. To obtain it please log into the [Console](https://console.treasuredata.com) and in the API keys box, copy the API key hash. | |
12-
| Database | Specify the name of your target database. | |
13-
| Table | Specify the name of your target table where the records will be stored. | |
14-
| Region | Set the service region, available values: US and JP | US |
15-
| Workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
9+
| Key | Description | Default |
10+
|:--- |:----------- |:--------|
11+
| `API` | The Treasure Data API key. To obtain it, log into the [Console](https://console.treasuredata.com) and in the API keys box, copy the API key hash. | _none_ |
12+
| `Database` | Specify the name of your target database. | _none_ |
13+
| `Table` | Specify the name of your target table where the records will be stored. | _none_ |
14+
| `Region` | Set the service region. Allowed values: `US`, `JP`. | `US` |
15+
| `Workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
1616

17-
## Getting Started
17+
## Getting started
1818

19-
In order to start inserting records into [Treasure Data](https://www.treasuredata.com), you can run the plugin from the command line or through the configuration file:
19+
To start inserting records into Treasure Data, run the plugin from the command line or through the configuration file.
2020

21-
### Command Line:
21+
### Command line
22+
23+
You can run the plugin from the command line, but it exposes your API key. Using a
24+
configuration file is recommended.
2225

2326
```shell
2427
fluent-bit -i cpu -o td -p API="abc" -p Database="fluentbit" -p Table="cpu_samples"
2528
```
2629

27-
Ideally you don't want to expose your API key from the command line, using a configuration file is highly desired.
28-
29-
### Configuration File
30+
### Configuration file
3031

3132
In your main configuration file append the following:
3233

@@ -38,7 +39,7 @@ pipeline:
3839
inputs:
3940
- name: cpu
4041
tag: my_cpu
41-
42+
4243
outputs:
4344
- name: td
4445
match: '*'
@@ -65,4 +66,4 @@ pipeline:
6566
```
6667

6768
{% endtab %}
68-
{% endtabs %}
69+
{% endtabs %}

vale-styles/FluentBit/Headings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ exceptions:
102102
- Telemetry Pipeline
103103
- Terraform
104104
- TLS
105+
- Treasure Data
105106
- TypeScript
106107
- URLs
107108
- VictorOps

0 commit comments

Comments
 (0)