Line protocol reference
InfluxDB 使用 Line Protocol 写入数据点。它是一种基于文本的格式,提供数据点的 measurement、tag set、field set 和 timestamp。
// Syntax
<measurement>[,<tag_key>=<tag_value>[,<tag_key>=<tag_value>]] <field_key>=<field_value>[,<field_key>=<field_value>] [<timestamp>]
// Example
myMeasurement,tag1=value1,tag2=value2 fieldKey="fieldValue" 1556813561098000000
以换行符 \n
分隔的行表示 InfluxDB 中的单个点。Line Protocol 对空格敏感。
Line Protocol 不支持在 tag 或 field 值中使用换行符 \n
。
Line Protocol 的元素
Measurement
(必需)measurement 名称。InfluxDB 每个点接受一个 measurement。Measurement 名称区分大小写,并受命名限制约束。
数据类型: 字符串
Tag set
可选 – 点的所有 tag 键值对。键值关系用 =
运算符表示。多个 tag 键值对用逗号分隔。Tag 键和 tag 值区分大小写。Tag 键受命名限制约束。Tag 值不能为空;请改为从 tag set 中省略该 tag。
Field set
(必需)点的所有 field 键值对。点必须至少有一个 field。Field 键和字符串值区分大小写。Field 键受命名限制约束。
键数据类型: 字符串
值数据类型: Float | Integer | UInteger | 字符串 | Boolean
始终使用双引号引用字符串 field 值。有关引号的更多信息,请参见下文。
measurementName fieldKey="field string value" 1556813561098000000
Timestamp
可选 – 数据点的 Unix 时间戳。InfluxDB 每个点接受一个时间戳。如果未提供时间戳,InfluxDB 将使用其主机机器的系统时间 (UTC)。
数据类型: Unix 时间戳
关于时间戳的重要说明
- 为确保数据点包含观察到指标的时间(而不是 InfluxDB 接收到的时间),请包含时间戳。
- 如果您的时间戳不是纳秒,请在将数据写入 InfluxDB 时指定时间戳的精度。
空格
Line Protocol 中的空格决定了 InfluxDB 如何解释数据点。第一个未转义的空格将 measurement 和 tag set 与 field set 分隔开。第二个未转义的空格将 field set 与时间戳分隔开。
数据类型和格式
Float
IEEE-754 64 位浮点数。默认数值类型。InfluxDB 支持 float field 值中的科学计数法。
Float field 值示例
myMeasurement fieldKey=1.0
myMeasurement fieldKey=1
myMeasurement fieldKey=-1.234456e+78
Integer
有符号 64 位整数。数字末尾的 i
指定为整数。
最小整数 | 最大整数 |
---|---|
-9223372036854775808i | 9223372036854775807i |
Integer field 值示例
myMeasurement fieldKey=1i
myMeasurement fieldKey=12485903i
myMeasurement fieldKey=-12485903i
UInteger
无符号 64 位整数。数字末尾的 u
指定为无符号整数。
最小 uinteger | 最大 uinteger |
---|---|
0u | 18446744073709551615u |
UInteger field 值示例
myMeasurement fieldKey=1u
myMeasurement fieldKey=12485903u
字符串
纯文本字符串。长度限制 64KB。
字符串示例
# String measurement name, field key, and field value
myMeasurement fieldKey="this is a string"
Boolean
存储 true
或 false
值。
Boolean 值 | 接受的语法 |
---|---|
True | t 、T 、true 、True 、TRUE |
False | f 、F 、false 、False 、FALSE |
Boolean field 值示例
myMeasurement fieldKey=true
myMeasurement fieldKey=false
myMeasurement fieldKey=t
myMeasurement fieldKey=f
myMeasurement fieldKey=TRUE
myMeasurement fieldKey=FALSE
不要引用 boolean field 值。引用的 field 值将被解释为字符串。
Unix 时间戳
指定精度的 Unix 时间戳。默认精度为纳秒 (ns
)。
最小时间戳 | 最大时间戳 |
---|---|
-9223372036854775806 | 9223372036854775806 |
Unix 时间戳示例
myMeasurementName fieldKey="fieldValue" 1556813561098000000
引号
Line Protocol 支持单引号和双引号,如下表所述
元素 | 双引号 | 单引号 |
---|---|---|
Measurement | 有限 * | 有限 * |
Tag 键 | 有限 * | 有限 * |
Tag 值 | 有限 * | 有限 * |
Field 键 | 有限 * | 有限 * |
Field 值 | 仅限字符串 | 从不 |
Timestamp | 从不 | 从不 |
* Line Protocol 接受 measurement 名称、tag 键、tag 值和 field 键中的双引号和单引号,但将其解释为名称、键或值的一部分。
特殊字符
Line Protocol 支持字符串元素中的特殊字符。在以下上下文中,它要求使用反斜杠 (\
) 转义某些字符
元素 | 转义字符 |
---|---|
Measurement | 逗号、空格 |
Tag 键 | 逗号、等号、空格 |
Tag 值 | 逗号、等号、空格 |
Field 键 | 逗号、等号、空格 |
Field 值 | 双引号、反斜杠 |
您无需转义其他特殊字符。
Line Protocol 中特殊字符的示例
# Measurement name with spaces
my\ Measurement fieldKey="string value"
# Double quotes in a string field value
myMeasurement fieldKey="\"string\" within a string"
# Tag keys and values with spaces
myMeasurement,tag\ Key1=tag\ Value1,tag\ Key2=tag\ Value2 fieldKey=100
# Emojis
myMeasurement,tagKey=🍭 fieldKey="Launch 🚀" 1556813561098000000
转义反斜杠
Line Protocol 同时支持字面反斜杠和作为转义字符的反斜杠。对于两个连续的反斜杠,第一个被解释为转义字符。例如
反斜杠 | 解释为 |
---|---|
\ | \ |
\\ | \ |
\\\ | \\ |
\\\\ | \\ |
\\\\\ | \\\ |
\\\\\\ | \\\ |
注释
Line Protocol 将行首的 #
解释为注释字符,并忽略所有后续字符,直到下一个换行符 \n
。
# This is a comment
myMeasurement fieldKey="string value" 1556813561098000000
命名限制
Measurement 名称、tag 键和 field 键不能以下划线 _
开头。_
命名空间为 InfluxDB 系统使用保留。
重复点
点由 measurement 名称、tag set 和时间戳唯一标识。如果您提交具有相同 measurement、tag set 和时间戳,但具有不同 field set 的 Line Protocol,则 field set 将成为旧 field set 和新 field set 的并集,其中任何冲突都倾向于新的 field set。
此页内容是否对您有帮助?
感谢您的反馈!
支持和反馈
感谢您成为我们社区的一份子!我们欢迎并鼓励您提供关于 InfluxDB Clustered 和本文档的反馈和错误报告。要获得支持,请使用以下资源
拥有年度或支持合同的客户可以联系 InfluxData 支持。