From 7def6663bd0ebd573fe98c22ec5d9449d1e9b410 Mon Sep 17 00:00:00 2001 From: Cameron Sparr <cameronsparr@gmail.com> Date: Thu, 18 Feb 2016 13:37:36 -0700 Subject: [PATCH] Root directory cleanup --- CHANGELOG.md | 4 ++-- CONTRIBUTING.md | 8 ++++---- README.md | 2 +- CONFIGURATION.md => docs/CONFIGURATION.md | 0 DATA_FORMATS_INPUT.md => docs/DATA_FORMATS_INPUT.md | 8 ++++---- DATA_FORMATS_OUTPUT.md => docs/DATA_FORMATS_OUTPUT.md | 6 +++--- .../LICENSE_OF_DEPENDENCIES.md | 0 plugins/inputs/exec/exec.go | 2 +- plugins/inputs/kafka_consumer/README.md | 2 +- plugins/inputs/kafka_consumer/kafka_consumer.go | 2 +- plugins/inputs/mqtt_consumer/README.md | 4 ++-- plugins/inputs/mqtt_consumer/mqtt_consumer.go | 2 +- plugins/inputs/nats_consumer/README.md | 4 ++-- plugins/inputs/nats_consumer/nats_consumer.go | 2 +- plugins/inputs/statsd/README.md | 2 +- plugins/inputs/statsd/statsd.go | 2 +- plugins/outputs/amqp/amqp.go | 2 +- plugins/outputs/file/file.go | 2 +- plugins/outputs/kafka/kafka.go | 2 +- plugins/outputs/mqtt/mqtt.go | 2 +- plugins/outputs/nsq/nsq.go | 2 +- build.py => scripts/build.py | 0 22 files changed, 30 insertions(+), 30 deletions(-) rename CONFIGURATION.md => docs/CONFIGURATION.md (100%) rename DATA_FORMATS_INPUT.md => docs/DATA_FORMATS_INPUT.md (95%) rename DATA_FORMATS_OUTPUT.md => docs/DATA_FORMATS_OUTPUT.md (91%) rename LICENSE_OF_DEPENDENCIES.md => docs/LICENSE_OF_DEPENDENCIES.md (100%) rename build.py => scripts/build.py (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index e8fd5d8f..c264ce94 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,9 +8,9 @@ format that they would like to parse. Currently supports: "json", "influx", and - Users of message broker and file output plugins can now choose what data format they would like to output. Currently supports: "influx" and "graphite" - More info on parsing _incoming_ data formats can be found -[here](https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md) +[here](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md) - More info on serializing _outgoing_ data formats can be found -[here](https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md) +[here](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md) - Telegraf now has an option `flush_buffer_when_full` that will flush the metric buffer whenever it fills up for each output, rather than dropping points and only flushing on a set time interval. This will default to `true` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7eb08a2d..9ab185d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,7 +101,7 @@ Some input plugins (such as [exec](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/exec)) accept arbitrary input data formats. An overview of these data formats can be found -[here](https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md). +[here](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md). In order to enable this, you must specify a `SetParser(parser parsers.Parser)` function on the plugin object (see the exec plugin for an example), as well as @@ -117,7 +117,7 @@ You should also add the following to your SampleConfig() return: ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ``` @@ -230,7 +230,7 @@ Some output plugins (such as [file](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/file)) can write arbitrary output data formats. An overview of these data formats can be found -[here](https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md). +[here](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md). In order to enable this, you must specify a `SetSerializer(serializer serializers.Serializer)` @@ -247,7 +247,7 @@ You should also add the following to your SampleConfig() return: ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" ``` diff --git a/README.md b/README.md index a2b7c39c..e15cb822 100644 --- a/README.md +++ b/README.md @@ -141,7 +141,7 @@ Examples: ## Configuration -See the [configuration guide](CONFIGURATION.md) for a rundown of the more advanced +See the [configuration guide](docs/CONFIGURATION.md) for a rundown of the more advanced configuration options. ## Supported Input Plugins diff --git a/CONFIGURATION.md b/docs/CONFIGURATION.md similarity index 100% rename from CONFIGURATION.md rename to docs/CONFIGURATION.md diff --git a/DATA_FORMATS_INPUT.md b/docs/DATA_FORMATS_INPUT.md similarity index 95% rename from DATA_FORMATS_INPUT.md rename to docs/DATA_FORMATS_INPUT.md index 16870adc..3e230519 100644 --- a/DATA_FORMATS_INPUT.md +++ b/docs/DATA_FORMATS_INPUT.md @@ -34,7 +34,7 @@ example, in the exec plugin: ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "json" ### Additional configuration options go here @@ -61,7 +61,7 @@ metrics are parsed directly into Telegraf metrics. ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ``` @@ -106,7 +106,7 @@ For example, if you had this configuration: ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "json" ### List of tag names to extract from top-level of JSON server response @@ -250,7 +250,7 @@ There are many more options available, ### Data format to consume. This can be "json", "influx" or "graphite" (line-protocol) ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "graphite" ### This string will be used to join the matched values. diff --git a/DATA_FORMATS_OUTPUT.md b/docs/DATA_FORMATS_OUTPUT.md similarity index 91% rename from DATA_FORMATS_OUTPUT.md rename to docs/DATA_FORMATS_OUTPUT.md index 0ad019b1..30f6e63d 100644 --- a/DATA_FORMATS_OUTPUT.md +++ b/docs/DATA_FORMATS_OUTPUT.md @@ -32,7 +32,7 @@ config option, for example, in the `file` output plugin: ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" ### Additional configuration options go here @@ -56,7 +56,7 @@ metrics are serialized directly into InfluxDB line-protocol. ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" ``` @@ -90,7 +90,7 @@ tars.cpu-total.us-east-1.cpu.usage_idle 98.09 1455320690 ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" prefix = "telegraf" diff --git a/LICENSE_OF_DEPENDENCIES.md b/docs/LICENSE_OF_DEPENDENCIES.md similarity index 100% rename from LICENSE_OF_DEPENDENCIES.md rename to docs/LICENSE_OF_DEPENDENCIES.md diff --git a/plugins/inputs/exec/exec.go b/plugins/inputs/exec/exec.go index e297721b..86309bf7 100644 --- a/plugins/inputs/exec/exec.go +++ b/plugins/inputs/exec/exec.go @@ -23,7 +23,7 @@ const sampleConfig = ` ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ` diff --git a/plugins/inputs/kafka_consumer/README.md b/plugins/inputs/kafka_consumer/README.md index 4fdda0c3..2e9d8cf3 100644 --- a/plugins/inputs/kafka_consumer/README.md +++ b/plugins/inputs/kafka_consumer/README.md @@ -25,7 +25,7 @@ from the same topic in parallel. ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ``` diff --git a/plugins/inputs/kafka_consumer/kafka_consumer.go b/plugins/inputs/kafka_consumer/kafka_consumer.go index 66fce3fc..98f2b299 100644 --- a/plugins/inputs/kafka_consumer/kafka_consumer.go +++ b/plugins/inputs/kafka_consumer/kafka_consumer.go @@ -56,7 +56,7 @@ var sampleConfig = ` ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ` diff --git a/plugins/inputs/mqtt_consumer/README.md b/plugins/inputs/mqtt_consumer/README.md index 6f7fa911..07a64e90 100644 --- a/plugins/inputs/mqtt_consumer/README.md +++ b/plugins/inputs/mqtt_consumer/README.md @@ -3,7 +3,7 @@ The [MQTT](http://mqtt.org/) consumer plugin reads from specified MQTT topics and adds messages to InfluxDB. The plugin expects messages in the -[Telegraf Input Data Formats](https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md). +[Telegraf Input Data Formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md). ### Configuration: @@ -38,7 +38,7 @@ The plugin expects messages in the ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ``` diff --git a/plugins/inputs/mqtt_consumer/mqtt_consumer.go b/plugins/inputs/mqtt_consumer/mqtt_consumer.go index ac4b738d..e9a7ef8b 100644 --- a/plugins/inputs/mqtt_consumer/mqtt_consumer.go +++ b/plugins/inputs/mqtt_consumer/mqtt_consumer.go @@ -71,7 +71,7 @@ var sampleConfig = ` ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ` diff --git a/plugins/inputs/nats_consumer/README.md b/plugins/inputs/nats_consumer/README.md index 31d13297..42993e81 100644 --- a/plugins/inputs/nats_consumer/README.md +++ b/plugins/inputs/nats_consumer/README.md @@ -2,7 +2,7 @@ The [NATS](http://www.nats.io/about/) consumer plugin reads from specified NATS subjects and adds messages to InfluxDB. The plugin expects messages -in the [Telegraf Input Data Formats](https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md). +in the [Telegraf Input Data Formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md). A [Queue Group](http://www.nats.io/documentation/concepts/nats-queueing/) is used when subscribing to subjects so multiple instances of telegraf can read from a NATS cluster in parallel. @@ -26,6 +26,6 @@ from a NATS cluster in parallel. ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ``` diff --git a/plugins/inputs/nats_consumer/nats_consumer.go b/plugins/inputs/nats_consumer/nats_consumer.go index 7dad47b4..c0bf5084 100644 --- a/plugins/inputs/nats_consumer/nats_consumer.go +++ b/plugins/inputs/nats_consumer/nats_consumer.go @@ -58,7 +58,7 @@ var sampleConfig = ` ### Data format to consume. This can be "json", "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" ` diff --git a/plugins/inputs/statsd/README.md b/plugins/inputs/statsd/README.md index 1ed8c72a..294c12b8 100644 --- a/plugins/inputs/statsd/README.md +++ b/plugins/inputs/statsd/README.md @@ -22,7 +22,7 @@ convert_names = true ### Statsd data translation templates, more info can be read here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md#graphite + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md#graphite # templates = [ # "cpu.* measurement*" # ] diff --git a/plugins/inputs/statsd/statsd.go b/plugins/inputs/statsd/statsd.go index 470e3188..bc792149 100644 --- a/plugins/inputs/statsd/statsd.go +++ b/plugins/inputs/statsd/statsd.go @@ -140,7 +140,7 @@ const sampleConfig = ` convert_names = true ### Statsd data translation templates, more info can be read here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md#graphite + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md#graphite # templates = [ # "cpu.* measurement*" # ] diff --git a/plugins/outputs/amqp/amqp.go b/plugins/outputs/amqp/amqp.go index d826e6d5..ea80ad6a 100644 --- a/plugins/outputs/amqp/amqp.go +++ b/plugins/outputs/amqp/amqp.go @@ -77,7 +77,7 @@ var sampleConfig = ` ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" ` diff --git a/plugins/outputs/file/file.go b/plugins/outputs/file/file.go index deae8aaf..3d431774 100644 --- a/plugins/outputs/file/file.go +++ b/plugins/outputs/file/file.go @@ -26,7 +26,7 @@ var sampleConfig = ` ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" ` diff --git a/plugins/outputs/kafka/kafka.go b/plugins/outputs/kafka/kafka.go index 71c2642d..667212f6 100644 --- a/plugins/outputs/kafka/kafka.go +++ b/plugins/outputs/kafka/kafka.go @@ -63,7 +63,7 @@ var sampleConfig = ` ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" ` diff --git a/plugins/outputs/mqtt/mqtt.go b/plugins/outputs/mqtt/mqtt.go index 48046878..ea638f3d 100644 --- a/plugins/outputs/mqtt/mqtt.go +++ b/plugins/outputs/mqtt/mqtt.go @@ -35,7 +35,7 @@ var sampleConfig = ` ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" ` diff --git a/plugins/outputs/nsq/nsq.go b/plugins/outputs/nsq/nsq.go index 7fe9b206..ef23fab9 100644 --- a/plugins/outputs/nsq/nsq.go +++ b/plugins/outputs/nsq/nsq.go @@ -27,7 +27,7 @@ var sampleConfig = ` ### Data format to output. This can be "influx" or "graphite" ### Each data format has it's own unique set of configuration options, read ### more about them here: - ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_OUTPUT.md + ### https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md data_format = "influx" ` diff --git a/build.py b/scripts/build.py similarity index 100% rename from build.py rename to scripts/build.py -- GitLab