From af3b0de9e862b97408d5c53dba18faea0af2b381 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Mon, 7 May 2018 14:32:58 +0200 Subject: [PATCH] Initial version Signed-off-by: Knut Ahlers --- LICENSE | 202 +++++++++++++++++++++++++++++++++++++ README.md | 14 +++ defaults/main.yml | 11 ++ meta/main.yml | 36 +++++++ tasks/main.yml | 66 ++++++++++++ templates/telegraf.conf.j2 | 73 ++++++++++++++ 6 files changed, 402 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 defaults/main.yml create mode 100644 meta/main.yml create mode 100644 tasks/main.yml create mode 100644 templates/telegraf.conf.j2 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e31d023 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018- Knut Ahlers + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..76472e6 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# luzifer-ansible / telegraf + +This role installs telegraf on a host, configures its startup parameters and enables it as a systemd daemon. + +## Requirements + +- Debian >= 8 (jessie) +- Ubuntu >= 16.04 (xenial) + +## Usage + +See the [Ansible Galaxy Intro](https://galaxy.ansible.com/intro) for usage of roles within Ansible Galaxy. + +For configuration variables and how to use them see [defaults/main.yml](defaults/main.yml). diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..76f1dd0 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,11 @@ +--- + +# See telegraf_agent_.* in templates/telegraf.conf.j2 + +telegraf_global_tags: {} +telegraf_outputs: {} +telegraf_inputs: {} + +telegraf_version: "1.6.1" + +... diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..f1df5b2 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,36 @@ +--- +galaxy_info: + author: Knut Ahlers + description: | + Install and configure telegraf on host + + license: Apache + min_ansible_version: 2.3 + + platforms: + - name: Ubuntu + versions: + - xenial + - name: Debian + versions: + - jessie + - stretch + + categories: + #- cloud + #- cloud:ec2 + #- cloud:gce + #- cloud:rax + #- clustering + #- database + #- database:nosql + #- database:sql + #- development + - monitoring + #- networking + #- packaging + #- system + #- web + +dependencies: + - config_encoder_filters diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..aafec54 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,66 @@ +--- + +- name: Get current telegraf version + shell: "/usr/local/bin/telegraf version || true" + check_mode: no + register: telegraf_version_cmd + +- name: Download and unpack telegraf release + unarchive: + src: 'https://dl.influxdata.com/telegraf/releases/telegraf-{{ telegraf_version }}-static_linux_amd64.tar.gz' + remote_src: true + dest: /tmp + when: telegraf_version not in telegraf_version_cmd.stdout + +- name: Move telegraf to expected position + command: mv /tmp/telegraf/telegraf /usr/local/bin/telegraf + when: telegraf_version not in telegraf_version_cmd.stdout + +- name: Cleanup tmp folder + file: + dest: /tmp/telegraf + state: absent + when: telegraf_version not in telegraf_version_cmd.stdout + +- name: Install systemd service + copy: + content: | + [Unit] + Description=Telegraf monitoring + After=network-online.target + Requires=network-online.target + + [Service] + TimeoutStartSec=0 + TimeoutStopSec=0 + Restart=on-failure + RestartSec=10 + SyslogIdentifier=telegraf + ExecStart=/usr/local/bin/telegraf --config /etc/telegraf.conf + + [Install] + WantedBy=multi-user.target + dest: /etc/systemd/system/telegraf.service + register: telegraf_service + +- name: Enable systemd service + systemd: + name: telegraf + enabled: true + daemon_reload: true + +- name: Write telegraf.conf file + template: + src: templates/telegraf.conf.j2 + dest: /etc/telegraf.conf + mode: 0600 + owner: root + register: telegraf_config + +- name: Restart systemd service + systemd: + name: telegraf + state: restarted + when: packer_build_name is not defined and (telegraf_service.changed or telegraf_config.changed) + +... diff --git a/templates/telegraf.conf.j2 b/templates/telegraf.conf.j2 new file mode 100644 index 0000000..c6dd184 --- /dev/null +++ b/templates/telegraf.conf.j2 @@ -0,0 +1,73 @@ +# {{ ansible_managed }} + +[global_tags] +{% for k,v in telegraf_global_tags.items() %} + {{ k }} = "{{ v }}" +{% endfor %} + +# Configuration for telegraf agent +[agent] + ## Default data collection interval for all inputs + interval = "{{ telegraf_agent_interval | default('10s') }}" + ## Rounds collection interval to 'interval' + ## ie, if interval="10s" then always collect on :00, :10, :20, etc. + round_interval = {{ telegraf_agent_round_interval | default(true) | to_nice_json }} + + ## Telegraf will send metrics to outputs in batches of at most + ## metric_batch_size metrics. + ## This controls the size of writes that Telegraf sends to output plugins. + metric_batch_size = {{ telegraf_agent_metric_batch_size | default(1000) }} + + ## For failed writes, telegraf will cache metric_buffer_limit metrics for each + ## output, and will flush this buffer on a successful write. Oldest metrics + ## are dropped first when this buffer fills. + ## This buffer only fills when writes fail to output plugin(s). + metric_buffer_limit = {{ telegraf_agent_metric_buffer_limit | default(10000) }} + + ## Collection jitter is used to jitter the collection by a random amount. + ## Each plugin will sleep for a random time within jitter before collecting. + ## This can be used to avoid many plugins querying things like sysfs at the + ## same time, which can have a measurable effect on the system. + collection_jitter = "{{ telegraf_agent_collection_jitter | default('0s') }}" + + ## Default flushing interval for all outputs. You shouldn't set this below + ## interval. Maximum flush_interval will be flush_interval + flush_jitter + flush_interval = "{{ telegraf_agent_flush_interval | default('10s') }}" + ## Jitter the flush interval by a random amount. This is primarily to avoid + ## large write spikes for users running a large number of telegraf instances. + ## ie, a jitter of 5s and interval 10s means flushes will happen every 10-15s + flush_jitter = "{{ telegraf_agent_flush_jitter | default('0s') }}" + + ## By default or when set to "0s", precision will be set to the same + ## timestamp order as the collection interval, with the maximum being 1s. + ## ie, when interval = "10s", precision will be "1s" + ## when interval = "250ms", precision will be "1ms" + ## Precision will NOT be used for service inputs. It is up to each individual + ## service input to set the timestamp at the appropriate precision. + ## Valid time units are "ns", "us" (or "µs"), "ms", "s". + precision = "{{ telegraf_agent_precision | default('') }}" + + ## Logging configuration: + ## Run telegraf with debug log messages. + debug = {{ telegraf_agent_debug | default(false) | to_nice_json }} + ## Run telegraf in quiet mode (error log messages only). + quiet = {{ telegraf_agent_quiet | default(false) | to_nice_json }} + ## Specify the log file name. The empty string means to log to stderr. + logfile = "{{ telegraf_agent_logfile | default('') }}" + + ## Override default hostname, if empty use os.Hostname() + hostname = "{{ telegraf_agent_hostname | default('') }}" + ## If set to true, do no set the "host" tag in the telegraf agent. + omit_hostname = {{ telegraf_agent_omit_hostname | default(false) | to_nice_json }} + +{% for name, config in telegraf_outputs.items() %} +[[ outputs.{{ name }} ]] + {{ config | encode_toml }} +{% endfor %} + +{% for name, config in telegraf_inputs.items() %} +[[ inputs.{{ name }} ]] + {{ config | encode_toml }} +{% endfor %} + +# vim: set ft=toml: