diff --git a/etc/telegraf.conf b/etc/telegraf.conf index 56619968a..41717d4cd 100644 --- a/etc/telegraf.conf +++ b/etc/telegraf.conf @@ -2290,7 +2290,7 @@ # region = "us-east-1" # # ## Amazon Credentials -# ## Credentials are loaded in the following order +# ## Credentials are loaded in the following order: # ## 1) Web identity provider credentials via STS if role_arn and web_identity_token_file are specified # ## 2) Assumed credentials via STS if role_arn is specified # ## 3) explicit credentials from 'access_key' and 'secret_key' @@ -2323,76 +2323,50 @@ # ## and therefore the Telegraf agent will not start. # describe_database_on_start = false # -# ## The mapping mode specifies how Telegraf records are represented in Timestream. +# ## Specifies how the data is organized in Timestream. # ## Valid values are: single-table, multi-table. -# ## For example, consider the following data in line protocol format: -# ## weather,location=us-midwest,season=summer temperature=82,humidity=71 1465839830100400200 -# ## airquality,location=us-west no2=5,pm25=16 1465839830100400200 -# ## where weather and airquality are the measurement names, location and season are tags, -# ## and temperature, humidity, no2, pm25 are fields. -# ## In multi-table mode: -# ## - first line will be ingested to table named weather -# ## - second line will be ingested to table named airquality -# ## - the tags will be represented as dimensions -# ## - first table (weather) will have two records: -# ## one with measurement name equals to temperature, -# ## another with measurement name equals to humidity -# ## - second table (airquality) will have two records: -# ## one with measurement name equals to no2, -# ## another with measurement name equals to pm25 -# ## - the Timestream tables from the example will look like this: -# ## TABLE "weather": -# ## time | location | season | measure_name | measure_value::bigint -# ## 2016-06-13 17:43:50 | us-midwest | summer | temperature | 82 -# ## 2016-06-13 17:43:50 | us-midwest | summer | humidity | 71 -# ## TABLE "airquality": -# ## time | location | measure_name | measure_value::bigint -# ## 2016-06-13 17:43:50 | us-west | no2 | 5 -# ## 2016-06-13 17:43:50 | us-west | pm25 | 16 -# ## In single-table mode: -# ## - the data will be ingested to a single table, which name will be valueOf(single_table_name) -# ## - measurement name will stored in dimension named valueOf(single_table_dimension_name_for_telegraf_measurement_name) -# ## - location and season will be represented as dimensions -# ## - temperature, humidity, no2, pm25 will be represented as measurement name -# ## - the Timestream table from the example will look like this: -# ## Assuming: -# ## - single_table_name = "my_readings" -# ## - single_table_dimension_name_for_telegraf_measurement_name = "namespace" -# ## TABLE "my_readings": -# ## time | location | season | namespace | measure_name | measure_value::bigint -# ## 2016-06-13 17:43:50 | us-midwest | summer | weather | temperature | 82 -# ## 2016-06-13 17:43:50 | us-midwest | summer | weather | humidity | 71 -# ## 2016-06-13 17:43:50 | us-west | NULL | airquality | no2 | 5 -# ## 2016-06-13 17:43:50 | us-west | NULL | airquality | pm25 | 16 -# ## In most cases, using multi-table mapping mode is recommended. -# ## However, you can consider using single-table in situations when you have thousands of measurement names. +# ## When mapping_mode is set to single-table, all of the data is stored in a single table. +# ## When mapping_mode is set to multi-table, the data is organized and stored in multiple tables. +# ## The default is multi-table. # mapping_mode = "multi-table" # -# ## Only valid and required for mapping_mode = "single-table" -# ## Specifies the Timestream table where the metrics will be uploaded. -# # single_table_name = "yourTableNameHere" -# -# ## Only valid and required for mapping_mode = "single-table" -# ## Describes what will be the Timestream dimension name for the Telegraf -# ## measurement name. -# # single_table_dimension_name_for_telegraf_measurement_name = "namespace" -# -# ## Specifies if the plugin should create the table, if the table do not exist. -# ## The plugin writes the data without prior checking if the table exists. -# ## When the table does not exist, the error returned from Timestream will cause -# ## the plugin to create the table, if this parameter is set to true. +# ## Specifies if the plugin should create the table, if the table does not exist. # create_table_if_not_exists = true # -# ## Only valid and required if create_table_if_not_exists = true # ## Specifies the Timestream table magnetic store retention period in days. # ## Check Timestream documentation for more details. +# ## NOTE: This property is valid when create_table_if_not_exists = true. # create_table_magnetic_store_retention_period_in_days = 365 # -# ## Only valid and required if create_table_if_not_exists = true # ## Specifies the Timestream table memory store retention period in hours. # ## Check Timestream documentation for more details. +# ## NOTE: This property is valid when create_table_if_not_exists = true. # create_table_memory_store_retention_period_in_hours = 24 # +# ## Specifies how the data is written into Timestream. +# ## Valid values are: true, false +# ## When use_multi_measure_records is set to true, all of the tags and fields are stored +# ## as a single row in a Timestream table. +# ## When use_multi_measure_record is set to false, Timestream stores each field in a +# ## separate table row, thereby storing the tags multiple times (once for each field). +# ## The recommended setting is true. +# ## The default is false. +# use_multi_measure_records = "false" +# +# ## Specifies the measure_name to use when sending multi-measure records. +# ## NOTE: This property is valid when use_multi_measure_records=true and mapping_mode=multi-table +# measure_name_for_multi_measure_records = "telegraf_measure" +# +# ## Specifies the name of the table to write data into +# ## NOTE: This property is valid when mapping_mode=single-table. +# # single_table_name = "" +# +# ## Specifies the name of dimension when all of the data is being stored in a single table +# ## and the measurement name is transformed into the dimension value +# ## (see Mapping data from Influx to Timestream for details) +# ## NOTE: This property is valid when mapping_mode=single-table. +# # single_table_dimension_name_for_telegraf_measurement_name = "namespace" +# # ## Only valid and optional if create_table_if_not_exists = true # ## Specifies the Timestream table tags. # ## Check Timestream documentation for more details @@ -2401,6 +2375,9 @@ # ## Specify the maximum number of parallel go routines to ingest/write data # ## If not specified, defaulted to 1 go routines # max_write_go_routines = 25 +# +# ## Please see README.md to know how line protocol data is mapped to Timestream +# ## # # Write metrics to Warp 10 diff --git a/etc/telegraf_windows.conf b/etc/telegraf_windows.conf index c7478c69d..dddc981fd 100644 --- a/etc/telegraf_windows.conf +++ b/etc/telegraf_windows.conf @@ -2290,7 +2290,7 @@ # region = "us-east-1" # # ## Amazon Credentials -# ## Credentials are loaded in the following order +# ## Credentials are loaded in the following order: # ## 1) Web identity provider credentials via STS if role_arn and web_identity_token_file are specified # ## 2) Assumed credentials via STS if role_arn is specified # ## 3) explicit credentials from 'access_key' and 'secret_key' @@ -2323,76 +2323,50 @@ # ## and therefore the Telegraf agent will not start. # describe_database_on_start = false # -# ## The mapping mode specifies how Telegraf records are represented in Timestream. +# ## Specifies how the data is organized in Timestream. # ## Valid values are: single-table, multi-table. -# ## For example, consider the following data in line protocol format: -# ## weather,location=us-midwest,season=summer temperature=82,humidity=71 1465839830100400200 -# ## airquality,location=us-west no2=5,pm25=16 1465839830100400200 -# ## where weather and airquality are the measurement names, location and season are tags, -# ## and temperature, humidity, no2, pm25 are fields. -# ## In multi-table mode: -# ## - first line will be ingested to table named weather -# ## - second line will be ingested to table named airquality -# ## - the tags will be represented as dimensions -# ## - first table (weather) will have two records: -# ## one with measurement name equals to temperature, -# ## another with measurement name equals to humidity -# ## - second table (airquality) will have two records: -# ## one with measurement name equals to no2, -# ## another with measurement name equals to pm25 -# ## - the Timestream tables from the example will look like this: -# ## TABLE "weather": -# ## time | location | season | measure_name | measure_value::bigint -# ## 2016-06-13 17:43:50 | us-midwest | summer | temperature | 82 -# ## 2016-06-13 17:43:50 | us-midwest | summer | humidity | 71 -# ## TABLE "airquality": -# ## time | location | measure_name | measure_value::bigint -# ## 2016-06-13 17:43:50 | us-west | no2 | 5 -# ## 2016-06-13 17:43:50 | us-west | pm25 | 16 -# ## In single-table mode: -# ## - the data will be ingested to a single table, which name will be valueOf(single_table_name) -# ## - measurement name will stored in dimension named valueOf(single_table_dimension_name_for_telegraf_measurement_name) -# ## - location and season will be represented as dimensions -# ## - temperature, humidity, no2, pm25 will be represented as measurement name -# ## - the Timestream table from the example will look like this: -# ## Assuming: -# ## - single_table_name = "my_readings" -# ## - single_table_dimension_name_for_telegraf_measurement_name = "namespace" -# ## TABLE "my_readings": -# ## time | location | season | namespace | measure_name | measure_value::bigint -# ## 2016-06-13 17:43:50 | us-midwest | summer | weather | temperature | 82 -# ## 2016-06-13 17:43:50 | us-midwest | summer | weather | humidity | 71 -# ## 2016-06-13 17:43:50 | us-west | NULL | airquality | no2 | 5 -# ## 2016-06-13 17:43:50 | us-west | NULL | airquality | pm25 | 16 -# ## In most cases, using multi-table mapping mode is recommended. -# ## However, you can consider using single-table in situations when you have thousands of measurement names. +# ## When mapping_mode is set to single-table, all of the data is stored in a single table. +# ## When mapping_mode is set to multi-table, the data is organized and stored in multiple tables. +# ## The default is multi-table. # mapping_mode = "multi-table" # -# ## Only valid and required for mapping_mode = "single-table" -# ## Specifies the Timestream table where the metrics will be uploaded. -# # single_table_name = "yourTableNameHere" -# -# ## Only valid and required for mapping_mode = "single-table" -# ## Describes what will be the Timestream dimension name for the Telegraf -# ## measurement name. -# # single_table_dimension_name_for_telegraf_measurement_name = "namespace" -# -# ## Specifies if the plugin should create the table, if the table do not exist. -# ## The plugin writes the data without prior checking if the table exists. -# ## When the table does not exist, the error returned from Timestream will cause -# ## the plugin to create the table, if this parameter is set to true. +# ## Specifies if the plugin should create the table, if the table does not exist. # create_table_if_not_exists = true # -# ## Only valid and required if create_table_if_not_exists = true # ## Specifies the Timestream table magnetic store retention period in days. # ## Check Timestream documentation for more details. +# ## NOTE: This property is valid when create_table_if_not_exists = true. # create_table_magnetic_store_retention_period_in_days = 365 # -# ## Only valid and required if create_table_if_not_exists = true # ## Specifies the Timestream table memory store retention period in hours. # ## Check Timestream documentation for more details. +# ## NOTE: This property is valid when create_table_if_not_exists = true. # create_table_memory_store_retention_period_in_hours = 24 # +# ## Specifies how the data is written into Timestream. +# ## Valid values are: true, false +# ## When use_multi_measure_records is set to true, all of the tags and fields are stored +# ## as a single row in a Timestream table. +# ## When use_multi_measure_record is set to false, Timestream stores each field in a +# ## separate table row, thereby storing the tags multiple times (once for each field). +# ## The recommended setting is true. +# ## The default is false. +# use_multi_measure_records = "false" +# +# ## Specifies the measure_name to use when sending multi-measure records. +# ## NOTE: This property is valid when use_multi_measure_records=true and mapping_mode=multi-table +# measure_name_for_multi_measure_records = "telegraf_measure" +# +# ## Specifies the name of the table to write data into +# ## NOTE: This property is valid when mapping_mode=single-table. +# # single_table_name = "" +# +# ## Specifies the name of dimension when all of the data is being stored in a single table +# ## and the measurement name is transformed into the dimension value +# ## (see Mapping data from Influx to Timestream for details) +# ## NOTE: This property is valid when mapping_mode=single-table. +# # single_table_dimension_name_for_telegraf_measurement_name = "namespace" +# # ## Only valid and optional if create_table_if_not_exists = true # ## Specifies the Timestream table tags. # ## Check Timestream documentation for more details @@ -2401,6 +2375,9 @@ # ## Specify the maximum number of parallel go routines to ingest/write data # ## If not specified, defaulted to 1 go routines # max_write_go_routines = 25 +# +# ## Please see README.md to know how line protocol data is mapped to Timestream +# ## # # Write metrics to Warp 10