Skip to content

Commit 37f2538

Browse files
mal117mal117
committed
Add V1.3.3 English document
1 parent 0f466d4 commit 37f2538

File tree

7 files changed

+197
-28
lines changed

7 files changed

+197
-28
lines changed

src/UserGuide/Master/Tree/Ecosystem-Integration/Telegraf-IoTDB.md renamed to src/UserGuide/Master/Tree/Ecosystem-Integration/Telegraf.md

File renamed without changes.

src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Telegraf-IoTDB.md renamed to src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Telegraf.md

File renamed without changes.

‎src/UserGuide/latest/Ecosystem-Integration/Telegraf-IoTDB.md‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎src/UserGuide/latest/Ecosystem-Integration/Telegraf.md‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# Telegraf
22+
23+
## 1、Product Overview
24+
25+
### 1.1 Telegraf
26+
27+
[Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) is an open-source proxy tool developed by InfluxData for collecting, processing, and transmitting metric data.
28+
29+
Telegraf has the following characteristics:
30+
31+
- Plugin architecture: The strength of Telegraf lies in its extensive plugin ecosystem. It supports multiple input, output, and processor plugins, and can seamlessly integrate with various data sources and targets.
32+
- Data collection: Telegraf excels at collecting metric data from various sources, such as system metrics, logs, databases, etc. Its versatility makes it suitable for monitoring applications, infrastructure, and IoT devices.
33+
- Output target: Once data is collected, it can be sent to various output targets, including popular databases such as InfluxDB. This flexibility allows Telegraf to adapt to different monitoring and analysis settings.
34+
- Easy configuration: Telegraf is configured using TOML files. This simplicity enables users to easily define inputs, outputs, and processors, making customization simple and clear.
35+
- Community and Support: As an open-source project, Telegraf benefits from an active community. Users can contribute plugins, report issues, and seek help through forums and documents.
36+
37+
### 1.2 Telegraf-IoTDB Plugin
38+
39+
The Telegraf IoTDB plugin can output and store monitoring information saved in Telegraf to IoTDB. The output plugin uses IoTDB sessions for connection and data writing.
40+
41+
![](https://alioss.timecho.com/docs/img/telegraf-en.png)
42+
43+
## 2、Installation Requirements
44+
45+
Telegraf supports multiple operating systems, including Linux, Windows, and macOS. It is recommended to use 'root' administrator privileges to successfully install Telegraf. Please refer to the installation requirements for specific [Installation Requirements](https://docs.influxdata.com/telegraf/v1/install/)
46+
47+
## 3、Installation Steps
48+
49+
Please refer to [Installation Steps](https://docs.influxdata.com/telegraf/v1/install/) for specific installation steps
50+
51+
- Note: This plugin is a built-in plugin for Telegraf and does not require secondary installation
52+
53+
## 4、Instructions
54+
55+
### 4.1 Set Input Source
56+
57+
Find 'INPUT PLUGINS' in the' telegraf. conf 'configuration file to configure the input source. The specific configuration content is shown in the table below
58+
59+
| Configuration | Description | Notes |
60+
| ----------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
61+
| alias | Example of named plugin | |
62+
| interval |Collect the frequency of this indicator. Ordinary plugins use a single global interval, but if the running frequency of a specific input should be lower or higher, you can configure it here` Interval can be increased to reduce data input rate limitations. | |
63+
| precision | Overlay the settings of the 'precision' proxy. The collected indicators are rounded to the specified precision interval. When this value is set on the service input (e.g. `'statsd':`), the output database may merge multiple events that occur at the same timestamp. | |
64+
| collection_jitter | Overlay the settings of the 'collectic_jitter' proxy. Collection jitter is used to perform random intervals` | |
65+
| name_override | Custom time series path name used when outputting to IoTDB | The output path name must meet the "[Syntax Requirement](../Reference/Syntax-Rule.md)" requirement |
66+
| name_prefix | Specify the prefix attached to the measurement name | |
67+
| name_suffix | Specify the suffix attached to the measurement name | |
68+
69+
![](https://alioss.timecho.com/docs/img/Telegraf_1.png)
70+
71+
### 4.2 Set Output Source
72+
73+
Find "outputs. iotdb" in the "telegraf. conf" configuration file to configure the output source. The specific configuration content is shown in the table below. For specific input source examples, please refer to [Output Source Example](https://docs.influxdata.com/telegraf/v1/configuration/#output-configuration-examples)
74+
75+
| Configuration | Description | Before Modification | After Modification | Notes |
76+
| ------------------- | -------------- | ----------------------------------- | ------------------------------------------------- | ------------------------------------------------------------ |
77+
| host | Host of IoTDB | # host = "127.0.0.1" | host = "Deploy IoTDB host" | Default is 127.0.0.1 |
78+
| port | The port number of IoTDB | # port = "6667" | port = "Port number for deploying IoTDB" | Default is 6667 |
79+
| user | Username for IoTDB | # user = "root" | user = "Username for IoTDB" |Default as root |
80+
| password | Password for IoTDB | # password = "root" | password= "Password for IoTDB" | Default as root |
81+
| timestamp_precision | Timestamp accuracy | timestamp_precision = "millisecond" | timestamp_precision = "Same timestamp accuracy as IoTDB" | You can check the 'timestamp-precision' field in 'iotdb system. properties' |
82+
| sanitize_tag | Database version | none | sanitize_tag = "0.13/1.0/1.1/1.2/1.3" | |
83+
84+
![](https://alioss.timecho.com/docs/img/Telegraf_2.png)
85+
86+
### 4.3 Start Telegraf Service
87+
88+
```Bash
89+
telegraf -config /path/to/telegraf.conf
90+
```
91+
92+
## 5、Example Usage
93+
94+
The following is an example of collecting CPU data using Telegraf and outputting it to IoTDB using Telegraf IoTDB. Generate configuration files using the telegraf command
95+
96+
```Bash
97+
telegraf --sample-config --input-filter cpu --output-filter iotdb > cpu_iotdb.conf
98+
```
99+
100+
1. Modify the configuration of the input CPU plugin in cpu_iotdb. conf. Among them, the "name_ooverride" field is the custom time-series path name used when outputting to IoTDB
101+
102+
```Bash
103+
# Read metrics about cpu usage
104+
[[inputs.cpu]]
105+
## Whether to report per-cpu stats or not
106+
percpu = true
107+
## Whether to report total system cpu stats or not
108+
totalcpu = true
109+
## If true, collect raw CPU time metrics
110+
collect_cpu_time = false
111+
## If true, compute and report the sum of all non-idle CPU states
112+
report_active = false
113+
## If true and the info is available then add core_id and physical_id tags
114+
core_tags = false
115+
name_override = "root.demo.telgraf.cpu"
116+
```
117+
118+
2. Modify the configuration of the output iotdb plugin in cpu_iotdb. conf
119+
120+
| Configuration | Description | Before Modification | After Modification | Notes |
121+
| ------------------- | -------------- | ----------------------------------- | ------------------------------------------------- | ------------------------------------------------------------ |
122+
| host | Host of IoTDB | # host = "127.0.0.1" | host = "Deploy IoTDB host" | Default is 127.0.0.1 |
123+
| port | The port number of IoTDB | # port = "6667" | port = "Port number for deploying IoTDB" | Default is 6667 |
124+
| user | Username for IoTDB | # user = "root" | user = "Username for IoTDB" |Default as root |
125+
| password | Password for IoTDB | # password = "root" | password= "Password for IoTDB" | Default as root |
126+
| timestamp_precision | Timestamp accuracy | timestamp_precision = "millisecond" | timestamp_precision = "Same timestamp accuracy as IoTDB" | You can check the 'timestamp-precision' field in 'iotdb system. properties' |
127+
| sanitize_tag | Database version | none | sanitize_tag = "0.13/1.0/1.1/1.2/1.3" | |
128+
129+
```Bash
130+
# Save metrics to an IoTDB Database
131+
[[outputs.iotdb]]
132+
## Configuration of IoTDB server connection
133+
host = "127.0.0.1"
134+
# port = "6667"
135+
136+
## Configuration of authentication
137+
# user = "root"
138+
# password = "root"
139+
140+
## Timeout to open a new session.
141+
## A value of zero means no timeout.
142+
# timeout = "5s"
143+
144+
## Configuration of type conversion for 64-bit unsigned int
145+
## IoTDB currently DOES NOT support unsigned integers (version 13.x).
146+
## 32-bit unsigned integers are safely converted into 64-bit signed integers by the plugin,
147+
## however, this is not true for 64-bit values in general as overflows may occur.
148+
## The following setting allows to specify the handling of 64-bit unsigned integers.
149+
## Available values are:
150+
## - "int64" -- convert to 64-bit signed integers and accept overflows
151+
## - "int64_clip" -- convert to 64-bit signed integers and clip the values on overflow to 9,223,372,036,854,775,807
152+
## - "text" -- convert to the string representation of the value
153+
# uint64_conversion = "int64_clip"
154+
155+
## Configuration of TimeStamp
156+
## TimeStamp is always saved in 64bits int. timestamp_precision specifies the unit of timestamp.
157+
## Available value:
158+
## "second", "millisecond", "microsecond", "nanosecond"(default)
159+
timestamp_precision = "millisecond"
160+
161+
## Handling of tags
162+
## Tags are not fully supported by IoTDB.
163+
## A guide with suggestions on how to handle tags can be found here:
164+
## https://iotdb.apache.org/UserGuide/Master/API/InfluxDB-Protocol.html
165+
##
166+
## Available values are:
167+
## - "fields" -- convert tags to fields in the measurement
168+
## - "device_id" -- attach tags to the device ID
169+
##
170+
## For Example, a metric named "root.sg.device" with the tags `tag1: "private"` and `tag2: "working"` and
171+
## fields `s1: 100` and `s2: "hello"` will result in the following representations in IoTDB
172+
## - "fields" -- root.sg.device, s1=100, s2="hello", tag1="private", tag2="working"
173+
## - "device_id" -- root.sg.device.private.working, s1=100, s2="hello"
174+
# convert_tags_to = "device_id"
175+
## Handling of unsupported characters
176+
## Some characters in different versions of IoTDB are not supported in path name
177+
## A guide with suggetions on valid paths can be found here:
178+
## for iotdb 0.13.x -> https://iotdb.apache.org/UserGuide/V0.13.x/Reference/Syntax-Conventions.html#identifiers
179+
## for iotdb 1.x.x and above -> https://iotdb.apache.org/UserGuide/V1.3.x/User-Manual/Syntax-Rule.html#identifier
180+
##
181+
## Available values are:
182+
## - "1.0", "1.1", "1.2", "1.3" -- enclose in `` the world having forbidden character
183+
## such as @ $ # : [ ] { } ( ) space
184+
## - "0.13" -- enclose in `` the world having forbidden character
185+
## such as space
186+
##
187+
## Keep this section commented if you don't want to sanitize the path
188+
sanitize_tag = "1.3"
189+
```
190+
191+
3. Run Telegraf using the cpu_iotdb.exe configuration file: After running for a period of time, the data collected and reported by Telegraf can be queried in IoTDB

src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Telegraf-IoTDB.md renamed to src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Telegraf.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Telegraf支持多种操作系统，包括Linux、Windows、macOS，Telegraf 的
7777
| host | IoTDB 的 host | # host = "127.0.0.1" | host = "部署 IoTDB 的 host" | 默认为 127.0.0.1 |
7878
| port | IoTDB 的端口号 | # port = "6667" | port = "部署 IoTDB 的端口号" | 默认为 6667 |
7979
| user | IoTDB 的用户名 | # user = "root" | user = "IoTDB 的用户名" | 默认为 root |
80-
| password | IoTDB 的用户名 | # password = "root" | password= "IoTDB 的用户名" | 默认为 root |
80+
| password | IoTDB 的密码 | # password = "root" | password= "IoTDB 的密码" | 默认为 root |
8181
| timestamp_precision | 时间戳精度 | timestamp_precision = "millisecond" | timestamp_precision = "与 IoTDB 相同的时间戳精度" | 您可以通过查看"iotdb-system.properties"中"timestamp_precision"字段即可 |
8282
| sanitize_tag | 数据库版本 | 无 | sanitize_tag = "0.13/1.0/1.1/1.2/1.3" | |
8383

@@ -122,7 +122,7 @@ telegraf --sample-config --input-filter cpu --output-filter iotdb > cpu_iotdb.co
122122
| host | IoTDB 的 host | # host = "127.0.0.1" | host = "部署 IoTDB 的 host" | 默认为 127.0.0.1 |
123123
| port | IoTDB 的端口号 | # port = "6667" | port = "部署 IoTDB 的端口号" | 默认为 6667 |
124124
| user | IoTDB 的用户名 | # user = "root" | user = "IoTDB 的用户名" | 默认为 root |
125-
| password | IoTDB 的用户名 | # password = "root" | password= "IoTDB 的用户名" | 默认为 root |
125+
| password | IoTDB 的密码 | # password = "root" | password= "IoTDB 的密码" | 默认为 root |
126126
| timestamp_precision | 时间戳精度 | timestamp_precision = "millisecond" | timestamp_precision = "与 IoTDB 相同的时间戳精度" | 您可以通过查看"iotdb-system.properties"中"timestamp_precision"字段即可 |
127127
| sanitize_tag | 数据库版本 | 无 | sanitize_tag = "0.13/1.0/1.1/1.2/1.3" | |
128128

0 commit comments

Comments
 (0)