From 7f485e3adc9a11c94f30935248c885d2dbe3c5c1 Mon Sep 17 00:00:00 2001 From: Russ Savage Date: Mon, 21 Sep 2020 10:33:32 -0700 Subject: [PATCH] fix(readmes): fixes spacing in the readmes for rendering --- Example_readme.md | 26 ++++----- InfluxDBv2_Covid19_SouthAmerica/readme.md | 18 +++--- apache_jmeter/readme.md | 6 +- apex_legends/readme.md | 21 +++---- csgo/readme.md | 20 +++---- docs/best_practices.md | 29 +++++----- endpoint-security-state/readme.md | 8 +-- fortnite/readme.md | 68 +++++++++++------------ github/readme.md | 18 +++--- haproxy/readme.md | 16 +++--- jboss_wildfly/readme.md | 18 +++--- minio/readme.md | 6 +- mongodb/readme.md | 18 +++--- mssql/readme.md | 20 +++---- mysql_mariadb/readme.md | 18 +++--- postgresql/readme.md | 18 +++--- snmp/readme.md | 12 ++-- speedtest/readme.md | 16 +++--- telegraf/readme.md | 6 +- tomcat/readme.md | 16 +++--- vsphere/readme.md | 18 +++--- x509/readme.md | 18 +++--- zookeeper/readme.md | 18 +++--- 23 files changed, 216 insertions(+), 216 deletions(-) diff --git a/Example_readme.md b/Example_readme.md index 9996519f..2e98c41d 100644 --- a/Example_readme.md +++ b/Example_readme.md @@ -28,12 +28,12 @@ List what resources your template provides in this section. That will allow user **Example:** - - 1 Bucket: `Telegraf`, 7d retention - - 3 Labels: `InfluxDB1.x`,`Solution`,`Telegraf` - - 1 Telegraf Configuration - - 3 Checks: `Disk Usage Check`, `Host Deadman`, and `Memory Usage Check` - - 2 Dashboards: `InfluxDB 1.x` and `Telegraf` - - 3 Variables: `bucket`, `influxdb_host`, and `telegraf_host` + - 1 Bucket: `Telegraf`, 7d retention + - 3 Labels: `InfluxDB1.x`,`Solution`,`Telegraf` + - 1 Telegraf Configuration + - 3 Checks: `Disk Usage Check`, `Host Deadman`, and `Memory Usage Check` + - 2 Dashboards: `InfluxDB 1.x` and `Telegraf` + - 3 Variables: `bucket`, `influxdb_host`, and `telegraf_host` ## Setup Instructions @@ -43,13 +43,13 @@ Describe any steps needed to finish setting up and running your template, includ **Example:** - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization - You **MUST** set these environment variables before running Telegraf using something similar to the following commands - - This can be found on the `Load Data` > `Tokens` page in your browser: `export INFLUX_TOKEN=TOKEN` - - Your Organization name can be found on the Settings page in your browser: `export INFLUX_ORG=my_org` +You **MUST** set these environment variables before running Telegraf using something similar to the following commands + - This can be found on the `Load Data` > `Tokens` page in your browser: `export INFLUX_TOKEN=TOKEN` + - Your Organization name can be found on the Settings page in your browser: `export INFLUX_ORG=my_org` ## Customizations @@ -57,7 +57,7 @@ Show off the flexibility of your template by letting users know different ways t **Example:** - You can easily update the Telegraf configurations to point to a specific InfluxDB 1.x location by setting the options in the [InfluxDB Input](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/influxdb) or the [InfluxDB 2.0 Output](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2). +You can easily update the Telegraf configurations to point to a specific InfluxDB 1.x location by setting the options in the [InfluxDB Input](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/influxdb) or the [InfluxDB 2.0 Output](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2). ## Contact diff --git a/InfluxDBv2_Covid19_SouthAmerica/readme.md b/InfluxDBv2_Covid19_SouthAmerica/readme.md index 5d00cfaa..fe2e5220 100644 --- a/InfluxDBv2_Covid19_SouthAmerica/readme.md +++ b/InfluxDBv2_Covid19_SouthAmerica/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Bucket: 'covid' - - 5 .sh files that get the information from the API and convert in JSON. - - 1 Dashboards: covid.yml - COVID19 América del Sur y Resto del mundo - - 1 Telegraf: 'Configuration: Exec Inputs' - - 1 Label: 'covid' + - 1 Bucket: 'covid' + - 5 .sh files that get the information from the API and convert in JSON. + - 1 Dashboards: covid.yml - COVID19 América del Sur y Resto del mundo + - 1 Telegraf: 'Configuration: Exec Inputs' + - 1 Label: 'covid' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_HOST` - The host running InfluxDB - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. +Telegraf Configuration requires the following environment variables + - `INFLUX_HOST` - The host running InfluxDB + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. As the bucket was provided in this template, you need to set the following environment data ```export INFLUX_BUCKET=covid```. Also may requiere adjust the information about the location of the executables files and set the agent interval to at least 1h, this for not hit to the api too much and cause service disruption. diff --git a/apache_jmeter/readme.md b/apache_jmeter/readme.md index 072ef15e..4a9ee512 100644 --- a/apache_jmeter/readme.md +++ b/apache_jmeter/readme.md @@ -39,8 +39,8 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates The template consists of the following: - - 1 Dashboard: `JMeter` - - 1 Variable: `bucket` + - 1 Dashboard: `JMeter` + - 1 Variable: `bucket` The sample **Test Plan** boilerplate project in the `samples` directory. @@ -52,7 +52,7 @@ General instructions on using InfluxDB Templates can be found in the [use a temp **Import the template** ``` - influx apply --file ./apache_jmeter.yml +influx apply --file ./apache_jmeter.yml ``` **Start with a sample test project:** diff --git a/apex_legends/readme.md b/apex_legends/readme.md index 73e05633..531588af 100644 --- a/apex_legends/readme.md +++ b/apex_legends/readme.md @@ -25,9 +25,9 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Bucket: apexlegends - - 2 Dashboards: Apex Legends for InfluxDB 2 and for Grafana - - 1 Label: Game Data + - 1 Bucket: apexlegends + - 2 Dashboards: Apex Legends for InfluxDB 2 and for Grafana + - 1 Label: Game Data ## Setup Instructions @@ -53,13 +53,14 @@ Due to limitations on the API and the way Telegraf processes the JSON data it's This will run curl every 5 minutes to pull the stats from the API endpoint and write them to `/etc/telegraf/apex_legends.json` - This can be anywhere your Telegraf instance can read from. - Telegraf Configuration requires the following environment variables - - `INFLUX_HOST` - The URL for your InfluxDB instance. - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization - You **MUST** set these environment variables before running Telegraf using something similar to the following commands - - This can be found on the `Load Data` > `Tokens` page in your browser: `export INFLUX_TOKEN=TOKEN` - - Your Organization name can be found on the Settings page in your browser: `export INFLUX_ORG=my_org` +Telegraf Configuration requires the following environment variables + - `INFLUX_HOST` - The URL for your InfluxDB instance. + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization + +You **MUST** set these environment variables before running Telegraf using something similar to the following commands + - This can be found on the `Load Data` > `Tokens` page in your browser: `export INFLUX_TOKEN=TOKEN` + - Your Organization name can be found on the Settings page in your browser: `export INFLUX_ORG=my_org` ## Contact diff --git a/csgo/readme.md b/csgo/readme.md index e026c25e..721f42b4 100644 --- a/csgo/readme.md +++ b/csgo/readme.md @@ -21,21 +21,21 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration: 'csgo-telegraf' - - 1 Dashboards - - 1 Label: 'csgo' - - 1 Bucket: 'csgo' - - 1 Executable: 'csgo.sh' + - 1 Telegraf Configuration: 'csgo-telegraf' + - 1 Dashboards + - 1 Label: 'csgo' + - 1 Bucket: 'csgo' + - 1 Executable: 'csgo.sh' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB - - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```INFLUX_BUCKET=mssql``` +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB + - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```INFLUX_BUCKET=mssql``` In order to use this dashboard you need to get an API key and your Steam User ID: diff --git a/docs/best_practices.md b/docs/best_practices.md index 225ac92e..96758bea 100644 --- a/docs/best_practices.md +++ b/docs/best_practices.md @@ -18,9 +18,9 @@ Rather than duplicating graphs to show filtered views of the same data, use [Var When using Buckets in your Template, you can: - - Provide a default Bucket with your Template - - Reuse an existing Bucket by name - - Let the user choose their Bucket + - Provide a default Bucket with your Template + - Reuse an existing Bucket by name + - Let the user choose their Bucket #### Provide a default Bucket with your Template You can include a uniquely-named [Bucket](https://v2.docs.influxdata.com/v2.0/reference/key-concepts/data-elements/#bucket) with your Template and use it as the default in Dashboards and Telegraf configurations. @@ -135,16 +135,16 @@ To add a custom Telegraf configuration file to your template: 1. Export your template using the command in the [submitting a template](submit_a_template.md) doc. 2. Add the following to the end of the file, being sure to give a name for your Telegraf configuration: - ``` - --- - apiVersion: influxdata.com/v2alpha1 - kind: Telegraf - metadata: - name: unique-name-for-your-config - spec: - name: The Name Of Your Configuration - config: | - ``` +``` +--- +apiVersion: influxdata.com/v2alpha1 +kind: Telegraf +metadata: + name: unique-name-for-your-config +spec: + name: The Name Of Your Configuration + config: | +``` 3. Copy and paste the contents of your Telegraf configuration file below what you just added, indenting it all until it is 4 spaces further indented than the `config:` line. @@ -156,8 +156,7 @@ After you export your finished Template, test it to make sure that it applies cl To create a clean, ephemeral InfluxDB testing environment, run InfluxDB inside of a Docker container: ``` - docker run -p 8086:8086 -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta - +docker run -p 8086:8086 -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta ``` After you create a new `Organization` and `Token` in your Docker instance (available at http://localhost:9999), follow the [instructions for using a Template](./use_a_template.md) to apply your Template. diff --git a/endpoint-security-state/readme.md b/endpoint-security-state/readme.md index 5cc425ee..ba210b52 100644 --- a/endpoint-security-state/readme.md +++ b/endpoint-security-state/readme.md @@ -28,10 +28,10 @@ influx apply --template-url https://raw.githubusercontent.com/influxdata/communi - 4 Labels: `outputs.influxdb_v2`, `Telegraf`, `Solution`, `security` - 1 Telegraf Configuration - 4 Checks: - - Endpoint availablility - - x509 Certificate status - - Authentication is enabled - - Authentication is working + - Endpoint availablility + - x509 Certificate status + - Authentication is enabled + - Authentication is working - 1 Dashboard: `Endpoint Security State` - 1 Variable: `bucket` diff --git a/fortnite/readme.md b/fortnite/readme.md index f2d6f742..787c0e56 100644 --- a/fortnite/readme.md +++ b/fortnite/readme.md @@ -41,48 +41,48 @@ Note: If `fortnite` is not used for the `fn_bucket` name, the bucket name will n ## Included Resources - 1 Bucket: `fortnite` - - 30d retention - - `fn_bucket` - user-definable resource name + - 30d retention + - `fn_bucket` - user-definable resource name - 1 Label: `fortnite` - 1 Telegraf Configuration - - `exec` input plugin - - `influxdb_v2` output plugin + - `exec` input plugin + - `influxdb_v2` output plugin - 1 Task: `wins` - - uses Slack webhook + - uses Slack webhook - 3 Dashboards: - - `Fortnite - All Players` - - `Fortnite - Individual Stats` - - `Fortnite - Player Comparison` + - `Fortnite - All Players` + - `Fortnite - Individual Stats` + - `Fortnite - Player Comparison` - 4 Query Variables: - - `bucket` - - `player` - - `player2` - - `season` + - `bucket` + - `player` + - `player2` + - `season` - 1 Python script: `get_fn_stats.py` - - used by Telegraf exec plugin to access Fortnite API endpoint + - used by Telegraf exec plugin to access Fortnite API endpoint - 1 CSV file: `players.csv` - - seeded with professional Fortnite player ids - - used by Python script + - seeded with professional Fortnite player ids + - used by Python script ## Setup Instructions 1. Register for an account at [fortniteapi.io](https://fortniteapi.io/) 2. Retrieve your Fortnite API token at [dashboard.fortniteapi.io](https://dashboard.fortniteapi.io) 3. Look up Fortnite account ids with the following curl request: - ``` - curl --request GET 'https://fortniteapi.io/lookup?username=' \ - --header 'Authorization: ' - ``` +``` +curl --request GET 'https://fortniteapi.io/lookup?username=' \ + --header 'Authorization: ' +``` 4. Check that the account returns metrics: - ``` - curl --request GET 'https://fortniteapi.io/stats?account=&season=' \ - --header 'Authorization: ' - ``` - - Note: If the response contains `"global_stats":null` it's likely that that the **Show on Career Leaderboard** setting is set to **OFF** in the **Account and Privacy** section of the player's profile. +``` +curl --request GET 'https://fortniteapi.io/stats?account=&season=' \ + --header 'Authorization: ' +``` + - Note: If the response contains `"global_stats":null` it's likely that that the **Show on Career Leaderboard** setting is set to **OFF** in the **Account and Privacy** section of the player's profile. 5. Add accounts to track in `players.csv`. For example: - - `4735ce9132924caf8a5b17789b40f79c,yes,Ninja` - - The second column indicates professional status: `yes`|`no` + - `4735ce9132924caf8a5b17789b40f79c,yes,Ninja` + - The second column indicates professional status: `yes`|`no` ### Telegraf The Telegraf configuration requires the following environmental variables: @@ -96,15 +96,15 @@ Information on using enviromental variables can be found in the [Telegraf Config The Telegraf `exec` input plugin requires the following files: - `get_fn_stats.py` - Python script used to ingest metrics via the unofficial [Fortnite API](https://fortniteapi.io/) - - `requests` module required - - The current season is hardcoded: `season = 14` - - Update this when a new season starts. + - `requests` module required + - The current season is hardcoded: `season = 14` + - Update this when a new season starts. - `players.csv` - CSV file containing a list of players to track using the following fields: - - `acct_id` - Fortnite Account ID - - `pro` - **yes** for professional, **no** for friends and family - - `player_name` - not used by Telegraf - - Note: This file is populated with several professional players. Add friends, family and others that will be tracked separately from the pro players. + - `acct_id` - Fortnite Account ID + - `pro` - **yes** for professional, **no** for friends and family + - `player_name` - not used by Telegraf + - Note: This file is populated with several professional players. Add friends, family and others that will be tracked separately from the pro players. ### Dashboards The `Fortnite - All Players` dashboard displays a url drilldown to the `Fortnite - Individual Stats` dashboard. This url must be changed in the `Friends & Family` and `Pros` cells: @@ -117,7 +117,7 @@ To get the full link, open the `Fortnite - Individual Stats` dashboard and copy The Influx task requires the following [influx secret](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/secret/): - `SLACK_WEBHOOK` - The Slack webhook is used to send a message when a player wins a match. - - https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX + - https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX ``` influx secret update -k SLACK_WEBHOOK ``` diff --git a/github/readme.md b/github/readme.md index a86def97..9723c991 100644 --- a/github/readme.md +++ b/github/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf: `Configuration: Github Inputs` - - 1 Dashboards: `Github - InfluxData [InfluxDB & Telegraf repos]` - - 1 Bucket: `github` - - 1 Label: `github` + - 1 Telegraf: `Configuration: Github Inputs` + - 1 Dashboards: `Github - InfluxData [InfluxDB & Telegraf repos]` + - 1 Bucket: `github` + - 1 Label: `github` ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The URL of your InfluxDB host (this can be your localhost, a remote instance, or InfluxDB Cloud). - - `GITHUB_ACCESS_TOKEN` - Your personal Github token for making API calls +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The URL of your InfluxDB host (this can be your localhost, a remote instance, or InfluxDB Cloud). + - `GITHUB_ACCESS_TOKEN` - Your personal Github token for making API calls > You can generate a Token Access Key from Github on this page: https://github.com/settings/tokens. diff --git a/haproxy/readme.md b/haproxy/readme.md index 76420f5a..72d4cf6a 100644 --- a/haproxy/readme.md +++ b/haproxy/readme.md @@ -21,19 +21,19 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf: `haproxy-config` - - 1 Dashboards: `haproxy` - - 1 Bucket: `haproxy` - - 1 Label: `haproxy` + - 1 Telegraf: `haproxy-config` + - 1 Dashboards: `haproxy` + - 1 Bucket: `haproxy` + - 1 Label: `haproxy` ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The host where run InfluxDB +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The host where run InfluxDB In order to use this template, you need to specify the HAProxy instance, if you have one to monitor, you can pass as variable the name and port of the host. Ex ```$ export haproxy_stats=http://localhost:10000/stats``` If you have more instances of HAProxy I recommend you to edit the haproxy.yml to add others hosts. diff --git a/jboss_wildfly/readme.md b/jboss_wildfly/readme.md index bb035de9..c2784e45 100644 --- a/jboss_wildfly/readme.md +++ b/jboss_wildfly/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration: 'jboss-wildfly-config' - - 1 Dashboards: 'jboss-wildfly' - - 1 Label: 'jboss-wildfly' - - 1 Bucket: 'jboss-wildfly' + - 1 Telegraf Configuration: 'jboss-wildfly-config' + - 1 Dashboards: 'jboss-wildfly' + - 1 Label: 'jboss-wildfly' + - 1 Bucket: 'jboss-wildfly' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your master token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB - - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=jboss-wildfly``` +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your master token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB + - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=jboss-wildfly``` In order to use this Dashboard, you need to specify the connection string to connect to the jBoss Wildfly / Jolokia instance as variable. diff --git a/minio/readme.md b/minio/readme.md index ddf2a60f..4fe12c7f 100644 --- a/minio/readme.md +++ b/minio/readme.md @@ -21,9 +21,9 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Dashboards: 'minio' - - 1 Label: 'minio' - - 1 Bucket: 'minio' + - 1 Dashboards: 'minio' + - 1 Label: 'minio' + - 1 Bucket: 'minio' ## Setup Instructions diff --git a/mongodb/readme.md b/mongodb/readme.md index f1a429fa..cbd0b720 100644 --- a/mongodb/readme.md +++ b/mongodb/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration: 'mongodb-config' - - 1 Dashboards: 'MongoDB' - - 1 bucket: 'mongodb' - - 1 label: 'mongodb' + - 1 Telegraf Configuration: 'mongodb-config' + - 1 Dashboards: 'MongoDB' + - 1 bucket: 'mongodb' + - 1 label: 'mongodb' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_HOST` - Your InfluxDB host (ex:http://localhost:9999) - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_BUCKET` - The name of the bucket you will store the data. +Telegraf Configuration requires the following environment variables + - `INFLUX_HOST` - Your InfluxDB host (ex:http://localhost:9999) + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_BUCKET` - The name of the bucket you will store the data. In order to use this Dashboard, you need to specify the string connection to MongoDB instance as variable. Ex: diff --git a/mssql/readme.md b/mssql/readme.md index a0bde4ed..cf238672 100644 --- a/mssql/readme.md +++ b/mssql/readme.md @@ -21,21 +21,21 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration: 'mssql-config' - - 1 Dashboards: 'MSSQL' - - 1 Label: 'mssql' - - 1 Bucket: 'mssql' - - 1 Variable: 'mssqlType' + - 1 Telegraf Configuration: 'mssql-config' + - 1 Dashboards: 'MSSQL' + - 1 Label: 'mssql' + - 1 Bucket: 'mssql' + - 1 Variable: 'mssqlType' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB - - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```INFLUX_BUCKET=mssql``` +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB + - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```INFLUX_BUCKET=mssql``` ## Additional Instructions For Azure DB diff --git a/mysql_mariadb/readme.md b/mysql_mariadb/readme.md index 06e35216..b5ff0980 100644 --- a/mysql_mariadb/readme.md +++ b/mysql_mariadb/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration: 'mysql-mariadb' - - 1 Dashboards: 'MySQL - MariaDB' - - 1 Label: 'mysql' - - 1 Bucket: 'mariadb' + - 1 Telegraf Configuration: 'mysql-mariadb' + - 1 Dashboards: 'MySQL - MariaDB' + - 1 Label: 'mysql' + - 1 Bucket: 'mariadb' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB - - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=mariadb``` +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB + - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=mariadb``` In order to use this Dashboard, you need to specify the connection string to the mySQL/MariaDB instance as variable. The same needs to define user and password (read only recommended) diff --git a/postgresql/readme.md b/postgresql/readme.md index e90277f1..60ea1c53 100644 --- a/postgresql/readme.md +++ b/postgresql/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration: 'postgres-config - - 1 Dashboards: 'Postgres' - - 1 Label: 'postgres' - - 1 Bucket: 'postgres' + - 1 Telegraf Configuration: 'postgres-config + - 1 Dashboards: 'Postgres' + - 1 Label: 'postgres' + - 1 Bucket: 'postgres' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB - - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=postgres``` +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB + - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=postgres``` In order to use this Dashboard, you need to specify the connection string to the Postgres instance as variable. The same needs to define user and password (read only recommended) diff --git a/snmp/readme.md b/snmp/readme.md index 6d2c213a..dac8efce 100644 --- a/snmp/readme.md +++ b/snmp/readme.md @@ -25,12 +25,12 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates This template includes the following: - - 1 Bucket: `snmp`, 1d retention - - 3 Labels: `inputs.net`,`inputs.system`,`SNMP` - - 3 Telegraf Configurations: `Linux SNMP`, `Cisco SNMP`, `Mikrotik SNMP` - - 0 Checks: - - 3 Dashboards: `SNMP System Monitoring`, `SNMP Mikrotik Monitoring`, `SNMP Network Monitoring` - - 2 Variables: `snmp_host`, and `snmp_ifName` + - 1 Bucket: `snmp`, 1d retention + - 3 Labels: `inputs.net`,`inputs.system`,`SNMP` + - 3 Telegraf Configurations: `Linux SNMP`, `Cisco SNMP`, `Mikrotik SNMP` + - 0 Checks: + - 3 Dashboards: `SNMP System Monitoring`, `SNMP Mikrotik Monitoring`, `SNMP Network Monitoring` + - 2 Variables: `snmp_host`, and `snmp_ifName` ## Setup Instructions diff --git a/speedtest/readme.md b/speedtest/readme.md index 34e05f7d..a9456bf3 100644 --- a/speedtest/readme.md +++ b/speedtest/readme.md @@ -21,19 +21,19 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration: 'speedtest-config' - - 1 Dashboards: 'speedtest' - - 1 Label: 'speedtest' - - 1 Bucket: 'speedtest' + - 1 Telegraf Configuration: 'speedtest-config' + - 1 Dashboards: 'speedtest' + - 1 Label: 'speedtest' + - 1 Bucket: 'speedtest' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB In order to use this template, you must install speedtest-cli. If you're using Debian based distributions, you need to run ```sudo apt install speedtest-cli``` diff --git a/telegraf/readme.md b/telegraf/readme.md index 94e5d4ec..a7af953a 100644 --- a/telegraf/readme.md +++ b/telegraf/readme.md @@ -72,9 +72,9 @@ ___example___ export TELEGRAF_MANIFEST_URL=https://raw.githubusercontent.com/influxdata/community-templates/master/telegraf/manifest.yml influx apply --url $TELEGRAF_MANIFEST_URL \ - --org $INFLUX_ORG \ - --host $INFLUX_HOST \ - --token $INFLUX_TOKEN + --org $INFLUX_ORG \ + --host $INFLUX_HOST \ + --token $INFLUX_TOKEN ``` ## Contact diff --git a/tomcat/readme.md b/tomcat/readme.md index cdee306e..387d27b6 100644 --- a/tomcat/readme.md +++ b/tomcat/readme.md @@ -21,19 +21,19 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf: 'Tomcat Inputs' - - 1 Dashboards: 'Apache Tomcat' - - 1 Bucket: 'tomcat' - - 1 Label: 'tomcat' + - 1 Telegraf: 'Tomcat Inputs' + - 1 Dashboards: 'Apache Tomcat' + - 1 Bucket: 'tomcat' + - 1 Label: 'tomcat' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_HOST` - The host running InfluxDB - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. +Telegraf Configuration requires the following environment variables + - `INFLUX_HOST` - The host running InfluxDB + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. As the bucket was provided in this template, you need to set the following environment data export INFLUX_BUCKET=tomcat. Also is required to specify trough variables the connection string of Tomcat using export TOMCAT_CONNECTION_STRING="you-server:8080//manager/status/all?XML=true" and the user and password. diff --git a/vsphere/readme.md b/vsphere/readme.md index 2c1de127..7c640641 100644 --- a/vsphere/readme.md +++ b/vsphere/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration - - 1 Dashboards: vsphere.yml - - 1 bucket: 'vsphere' - - 1 label: 'vsphere' + - 1 Telegraf Configuration + - 1 Dashboards: vsphere.yml + - 1 bucket: 'vsphere' + - 1 label: 'vsphere' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB - - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=vsphere``` +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB + - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=vsphere``` In order to use this Dashboard, you need to specify as variable the address to the vSphere (EX: https://vsphere/sdk), also, you need to provide the username and password as variable too. diff --git a/x509/readme.md b/x509/readme.md index 17d01b0e..81a302f6 100644 --- a/x509/readme.md +++ b/x509/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration - - 1 Dashboards: x509.yml - - 1 bucket: 'x509' - - 1 label: 'x509' + - 1 Telegraf Configuration + - 1 Dashboards: x509.yml + - 1 bucket: 'x509' + - 1 label: 'x509' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB - - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=x509``` +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB + - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```export INFLUX_BUCKET=x509``` In order to use this template, before import, you need to specify the certificates you want monitor in the x509.yml file. diff --git a/zookeeper/readme.md b/zookeeper/readme.md index 97e1f4fd..a545d8ba 100644 --- a/zookeeper/readme.md +++ b/zookeeper/readme.md @@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates ## Included Resources - - 1 Telegraf Configuration - - 1 Dashboards: 'zookeeper' - - 1 Bucket: 'zookeeper' - - 1 Label: 'zookeeper' + - 1 Telegraf Configuration + - 1 Dashboards: 'zookeeper' + - 1 Bucket: 'zookeeper' + - 1 Label: 'zookeeper' ## Setup Instructions General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document. - Telegraf Configuration requires the following environment variables - - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. - - `INFLUX_ORG` - The name of your Organization. - - `INFLUX_HOST` - The address of you InfluxDB - - `INFLUX_BUCKET` - The name of the Bucket. In this case, the bucket was included, so, you need to specify 'INFLUX_BUCKET=zookeeper' +Telegraf Configuration requires the following environment variables + - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started. + - `INFLUX_ORG` - The name of your Organization. + - `INFLUX_HOST` - The address of you InfluxDB + - `INFLUX_BUCKET` - The name of the Bucket. In this case, the bucket was included, so, you need to specify 'INFLUX_BUCKET=zookeeper' In order to use this Dashboard, you need to specify the address to the ZooKeeper client (EX: https://localhost:2181) as variable 'ZOOKEEPER_HOST'