summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrançois Charlier <francois.charlier@redhat.com>2020-06-17 17:58:49 +0200
committerFrançois Charlier <francois.charlier@redhat.com>2020-06-17 17:58:49 +0200
commit5223da6b333531fd7065610e1b074ff584a227dd (patch)
tree6965c677ff036ae2fcfe44d92cd79af69bc0c33d
parentc5d7daa5929be0ab5aadb0daf35aeea8c8adc9f2 (diff)
Add mtail role & include it in main playbook
Change-Id: Ib2785c44405466368f8ce164d2581123acbc6afa
-rw-r--r--files/mtail_progs/httpd.mtail27
-rw-r--r--playbook.yml1
-rw-r--r--roles/mtail/LICENSE201
-rw-r--r--roles/mtail/defaults/main.yml36
-rw-r--r--roles/mtail/files/epel7-copr.repo10
-rw-r--r--roles/mtail/handlers/main.yml22
-rw-r--r--roles/mtail/meta/main.yml28
-rw-r--r--roles/mtail/tasks/CentOS/rpm-based-repo.yml26
-rw-r--r--roles/mtail/tasks/main.yml92
-rw-r--r--roles/mtail/templates/mtail_sysconfig.j21
10 files changed, 444 insertions, 0 deletions
diff --git a/files/mtail_progs/httpd.mtail b/files/mtail_progs/httpd.mtail
new file mode 100644
index 0000000..e684780
--- /dev/null
+++ b/files/mtail_progs/httpd.mtail
@@ -0,0 +1,27 @@
+# Parser for the common apache log format as follow.
+# LogFormat "%h %l %u %t \"%r\" %>s %b %D \"%{Referer}i\" \"%{User-agent}i\"
+counter apache_http_requests_total by request_method, request_uri, status_code
+
+/^/ +
+/(?P<remote_host>[0-9A-Za-z\.:-]+) / + # %h
+/(?P<remote_logname>[0-9A-Za-z-]+) / + # %l
+/(?P<remote_username>[0-9A-Za-z-]+) / + # %u
+/\[(?P<timestamp>\d{2}\/\w{3}\/\d{4}:\d{2}:\d{2}:\d{2} (\+|-)\d{4})\] / + # %u
+/"(?P<request_method>[A-Z]+) (?P<request_uri>\S+?)(\?\S+)? (?P<http_version>HTTP\/[0-9\.]+)" / + # \"%r\"
+/(?P<status_code>\d{3}) / + # %>s
+/((?P<response_size>\d+)|-) / + # %b
+/"(?P<referer>\S+)" / + # \"%{Referer}i\"
+/"(?P<user_agent>[[:print:]]+)"/ + # \"%{User-agent}i\"
+/$/ {
+ const UUID_OR_INT /([[:xdigit:]]{8}-([[:xdigit:]]{4}-){3}[[:xdigit:]]{12}|\d+)/
+
+ $request_uri =~ /(?P<endpoint>\S+?\/)/ + UUID_OR_INT + /(?P<endpoint_after>\/\S*)?/ {
+ $endpoint_after =~ /(?P<ep_next>\S+?\/)/ + UUID_OR_INT + /(?P<ep_end>\/\S*)?/ {
+ apache_http_requests_total[$request_method][$endpoint + ":UUID:" + $ep_next + ":UUID:" + $ep_end][$status_code]++
+ } else {
+ apache_http_requests_total[$request_method][$endpoint + ":UUID:" + $endpoint_after][$status_code]++
+ }
+ } else {
+ apache_http_requests_total[$request_method][$request_uri][$status_code]++
+ }
+}
diff --git a/playbook.yml b/playbook.yml
index b7ff57e..bebf959 100644
--- a/playbook.yml
+++ b/playbook.yml
@@ -43,3 +43,4 @@
remote_user: dci
roles:
- prometheus-apache-exporter
+ - mtail
diff --git a/roles/mtail/LICENSE b/roles/mtail/LICENSE
new file mode 100644
index 0000000..d074afa
--- /dev/null
+++ b/roles/mtail/LICENSE
@@ -0,0 +1,201 @@
+ 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 2020 François Charlier <francois.charlier@redhat.com>
+
+ 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/roles/mtail/defaults/main.yml b/roles/mtail/defaults/main.yml
new file mode 100644
index 0000000..b70652a
--- /dev/null
+++ b/roles/mtail/defaults/main.yml
@@ -0,0 +1,36 @@
+---
+##
+# Programs
+
+# Where programs will be stored
+mtail_programs_path: /etc/mtail/
+# List of the programs to copy to the host
+mtail_programs: []
+
+##
+# Log files & acls
+
+# List of log files to watch
+mtail_logs: []
+
+# Default to set acls to the direct folders containing log files
+# customize according to your needs if you need more.
+mtail_acl_folders: "{{ mtail_logs | map('dirname') | unique }}"
+# Should we apply acls recursively ?
+mtail_acl_recursive: False
+# Use the following to set acl to all declared log files
+# WARNING: won't work with wildcards though
+#mtail_acl_files: mtail_logs
+mtail_acl_files: []
+
+##
+# Extra options
+
+mtail_extra_options: ""
+
+##
+# Service user
+
+mtail_user: mtail
+mtail_group: mtail
+
diff --git a/roles/mtail/files/epel7-copr.repo b/roles/mtail/files/epel7-copr.repo
new file mode 100644
index 0000000..ee94aaa
--- /dev/null
+++ b/roles/mtail/files/epel7-copr.repo
@@ -0,0 +1,10 @@
+[copr:copr.fedorainfracloud.org:nazgullien:mtail]
+name=Copr repo for mtail owned by nazgullien
+baseurl=https://download.copr.fedorainfracloud.org/results/nazgullien/mtail/epel-7-$basearch/
+type=rpm-md
+skip_if_unavailable=True
+gpgcheck=1
+gpgkey=https://download.copr.fedorainfracloud.org/results/nazgullien/mtail/pubkey.gpg
+repo_gpgcheck=0
+enabled=1
+enabled_metadata=1
diff --git a/roles/mtail/handlers/main.yml b/roles/mtail/handlers/main.yml
new file mode 100644
index 0000000..f91c0c6
--- /dev/null
+++ b/roles/mtail/handlers/main.yml
@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright 2017 Red Hat, Inc.
+#
+# 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.
+
+---
+- name: restart mtail
+ become: True
+ service:
+ name: mtail
+ state: restarted
diff --git a/roles/mtail/meta/main.yml b/roles/mtail/meta/main.yml
new file mode 100644
index 0000000..a1e75b9
--- /dev/null
+++ b/roles/mtail/meta/main.yml
@@ -0,0 +1,28 @@
+# 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.
+
+---
+galaxy_info:
+ author: François Charlier <francois.charlier@redhat.com
+ description: An Ansible role for mtail
+ company: Red Hat
+ license: Apache
+ min_ansible_version: 2.0
+ platforms:
+ - name: EL
+ versions:
+ - 7
+
+ galaxy_tags:
+ - monitoring
+
+dependencies: []
diff --git a/roles/mtail/tasks/CentOS/rpm-based-repo.yml b/roles/mtail/tasks/CentOS/rpm-based-repo.yml
new file mode 100644
index 0000000..1a1ce1e
--- /dev/null
+++ b/roles/mtail/tasks/CentOS/rpm-based-repo.yml
@@ -0,0 +1,26 @@
+# Copyright 2020 François Charlier <francois.charlier@redhat.com>
+# Author: François Charlier <francois.charlier@redhat.com>
+#
+# 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.
+
+---
+- name: Import GPG keys
+ become: True
+ rpm_key:
+ key: https://download.copr.fedorainfracloud.org/results/nazgullien/mtail/pubkey.gpg
+
+- name: Have the Copr repo for mtail configured
+ become: True
+ copy:
+ src: epel7-copr.repo
+ dest: /etc/yum.repos.d/mtail-copr.repo
diff --git a/roles/mtail/tasks/main.yml b/roles/mtail/tasks/main.yml
new file mode 100644
index 0000000..a79c0f3
--- /dev/null
+++ b/roles/mtail/tasks/main.yml
@@ -0,0 +1,92 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright 2017 Red Hat, Inc.
+#
+# 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.
+
+---
+- name: Include RPM-based repo (when necessary)
+ include_tasks: CentOS/rpm-based-repo.yml
+ when: ansible_distribution == 'CentOS'
+
+- name: Ensure mtail is installed
+ package:
+ name: mtail
+ state: latest
+ become: True
+ notify:
+ - restart mtail
+
+- name: Ensure mtail has access to the logs folder
+ acl:
+ path: "{{ item }}"
+ entity: "{{ mtail_user }}"
+ etype: user
+ permissions: rX
+ recursive: "{{ mtail_acl_recursive }}"
+ state: present
+ loop: "{{ mtail_acl_folders | list }}"
+ when: mtail_acl_folders is defined and mtail_acl_folders
+ become: True
+
+- name: Ensure mtail has access to the logs files
+ acl:
+ etype: user
+ entity: "{{ mtail_user }}"
+ path: "{{ item }}"
+ permissions: r
+ loop: "{{ mtail_acl_files | list }}"
+ when: mtail_acl_files is defined and mtail_acl_files
+ become: True
+ tags: acl
+
+- name: Ensure mtail configuration is set
+ template:
+ src: mtail_sysconfig.j2
+ dest: /etc/sysconfig/mtail
+ backup: yes
+ mode: 0644
+ owner: root
+ group: root
+ become: True
+ notify:
+ - restart mtail
+
+- name: Ensure the mtail programs directory exists
+ file:
+ path: "{{ mtail_programs_path }}"
+ mode: 0755
+ owner: "{{ mtail_user }}"
+ group: "{{ mtail_group }}"
+ state: directory
+ become: True
+
+- name: Install mtail programs
+ copy:
+ src: "{{ item }}"
+ dest: "{{ mtail_programs_path }}/{{ item | basename }}"
+ owner: "{{ mtail_user }}"
+ group: "{{ mtail_group }}"
+ mode: 0644
+ loop: "{{ mtail_programs | list }}"
+ when: mtail_programs is defined and mtail_programs
+ become: True
+ notify:
+ - restart mtail
+
+- name: Ensure the service is enabled and started
+ service:
+ name: mtail
+ enabled: yes
+ state: started
+ become: True
diff --git a/roles/mtail/templates/mtail_sysconfig.j2 b/roles/mtail/templates/mtail_sysconfig.j2
new file mode 100644
index 0000000..ac0d7a4
--- /dev/null
+++ b/roles/mtail/templates/mtail_sysconfig.j2
@@ -0,0 +1 @@
+MTAIL_OPTIONS=--progs {{ mtail_programs_path }} --logs {{ mtail_logs | list | join(',') }}{% if mtail_extra_options is defined and mtail_extra_options %} {{ mtail_extra_options }}{% endif %}