Michael-GMH
4 years ago
parent
6f40d78353
commit
ad7bbd6442
@ -0,0 +1,29 @@
|
|||||||
|
# Enabling metrics and graphs for Postgres (optional)
|
||||||
|
|
||||||
|
Expanding on the metrics exposed by the [synapse exporter and the node exporter](configuring-playbook-prometheus-grafana.md), the playbook enables the [postgres exporter](https://github.com/prometheus-community/postgres_exporter) that exposes more detailed information about what's happening on your postgres database.
|
||||||
|
|
||||||
|
You can enable this with the following settings in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
|
||||||
|
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
matrix_prometheus_postgres_exporter_enabled: true
|
||||||
|
|
||||||
|
# the role creates a postgres user as credential. You can configure these if required:
|
||||||
|
matrix_prometheus_postgres_exporter_database_username: 'matrix_prometheus_postgres_exporter'
|
||||||
|
matrix_prometheus_postgres_exporter_database_password: 'some-password'
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## What does it do?
|
||||||
|
|
||||||
|
Name | Description
|
||||||
|
-----|----------
|
||||||
|
`matrix_prometheus_postgres_exporter_enabled`|Enable the postgres prometheus exporter. This sets up the docker container, connects it to the database and adds a 'job' to the prometheus config which tells prometheus about this new exporter. The default is 'false'
|
||||||
|
`matrix_prometheus_postgres_exporter_database_username`| The 'username' for the user that the exporter uses to connect to the database. The default is 'matrix_prometheus_postgres_exporter'
|
||||||
|
`matrix_prometheus_postgres_exporter_database_password`| The 'password' for the user that the exporter uses to connect to the database.
|
||||||
|
|
||||||
|
|
||||||
|
## More information
|
||||||
|
|
||||||
|
- [The PostgresSQL dashboard](https://grafana.com/grafana/dashboards/9628) (generic postgres dashboard)
|
||||||
|
|
||||||
@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"name": "Configure Element Subdomain",
|
||||||
|
"description": "Configure Element clients subdomain location. (Eg: 'element' for element.example.org)",
|
||||||
|
"spec": [
|
||||||
|
{
|
||||||
|
"question_name": "Set Element Subdomain",
|
||||||
|
"question_description": "Sets the subdomain of the Element web-client, you should only specify the subdomain, not the base domain you've already set. (Eg: 'element' for element.example.org) Note that if you change this value you'll need to reconfigure your DNS.",
|
||||||
|
"required": false,
|
||||||
|
"min": 0,
|
||||||
|
"max": 2048,
|
||||||
|
"default": "{{ element_subdomain }}",
|
||||||
|
"choices": "",
|
||||||
|
"new_question": true,
|
||||||
|
"variable": "element_subdomain",
|
||||||
|
"type": "text"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@ -0,0 +1,49 @@
|
|||||||
|
|
||||||
|
- name: Record Element-Web variables locally on AWX
|
||||||
|
delegate_to: 127.0.0.1
|
||||||
|
lineinfile:
|
||||||
|
path: '{{ awx_cached_matrix_vars }}'
|
||||||
|
regexp: "^#? *{{ item.key | regex_escape() }}:"
|
||||||
|
line: "{{ item.key }}: {{ item.value }}"
|
||||||
|
insertafter: '# Element Settings Start'
|
||||||
|
with_dict:
|
||||||
|
'matrix_server_fqn_element': "{{ element_subdomain }}.{{ matrix_domain }}"
|
||||||
|
|
||||||
|
- name: Save new 'Configure Element Subdomain' survey.json to the AWX tower, template
|
||||||
|
delegate_to: 127.0.0.1
|
||||||
|
template:
|
||||||
|
src: 'roles/matrix-awx/surveys/configure_element_subdomain.json.j2'
|
||||||
|
dest: '/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/configure_element_subdomain.json'
|
||||||
|
|
||||||
|
- name: Copy new 'Configure Element Subdomain' survey.json to target machine
|
||||||
|
copy:
|
||||||
|
src: '/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/configure_element_subdomain.json'
|
||||||
|
dest: '/matrix/awx/configure_element_subdomain.json'
|
||||||
|
mode: '0660'
|
||||||
|
|
||||||
|
- name: Collect AWX admin token the hard way!
|
||||||
|
delegate_to: 127.0.0.1
|
||||||
|
shell: |
|
||||||
|
curl -sku {{ tower_username }}:{{ tower_password }} -H "Content-Type: application/json" -X POST -d '{"description":"Tower CLI", "application":null, "scope":"write"}' https://{{ tower_host }}/api/v2/users/1/personal_tokens/ | jq '.token' | sed -r 's/\"//g'
|
||||||
|
register: tower_token
|
||||||
|
no_log: True
|
||||||
|
|
||||||
|
- name: Recreate 'Configure Element Subdomain' job template
|
||||||
|
delegate_to: 127.0.0.1
|
||||||
|
awx.awx.tower_job_template:
|
||||||
|
name: "{{ matrix_domain }} - 1 - Configure Element Subdomain"
|
||||||
|
description: "Configure Element clients subdomain location. (Eg: 'element' for element.example.org)"
|
||||||
|
extra_vars: "{{ lookup('file', '/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/extra_vars.json') }}"
|
||||||
|
job_type: run
|
||||||
|
job_tags: "start,setup-all,setup-client-element-subdomain"
|
||||||
|
inventory: "{{ member_id }}"
|
||||||
|
project: "{{ member_id }} - Matrix Docker Ansible Deploy"
|
||||||
|
playbook: setup.yml
|
||||||
|
credential: "{{ member_id }} - AWX SSH Key"
|
||||||
|
survey_enabled: true
|
||||||
|
survey_spec: "{{ lookup('file', '/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/configure_element_subdomain.json') }}"
|
||||||
|
state: present
|
||||||
|
verbosity: 1
|
||||||
|
tower_host: "https://{{ tower_host }}"
|
||||||
|
tower_oauthtoken: "{{ tower_token.stdout }}"
|
||||||
|
validate_certs: yes
|
||||||
@ -0,0 +1,49 @@
|
|||||||
|
# matrix-prometheus-postgres-exporter is an Prometheus exporter for postgres metrics
|
||||||
|
# See: https://github.com/prometheus-community/postgres_exporter
|
||||||
|
|
||||||
|
matrix_prometheus_postgres_exporter_enabled: false
|
||||||
|
|
||||||
|
matrix_prometheus_postgres_exporter_version: v0.9.0
|
||||||
|
matrix_prometheus_postgres_exporter_port: 9187
|
||||||
|
|
||||||
|
matrix_prometheus_postgres_exporter_docker_image: "quay.io/prometheuscommunity/postgres-exporter:{{ matrix_prometheus_postgres_exporter_version }}"
|
||||||
|
matrix_prometheus_postgres_exporter_docker_image_force_pull: "{{ matrix_prometheus_postgres_exporter_docker_image.endswith(':latest') }}"
|
||||||
|
|
||||||
|
# A list of extra arguments to pass to the container
|
||||||
|
matrix_prometheus_postgres_exporter_container_extra_arguments: ["-e PG_EXPORTER_AUTO_DISCOVER_DATABASES=true",
|
||||||
|
"-e PG_EXPORTER_WEB_LISTEN_ADDRESS=\":{{matrix_prometheus_postgres_exporter_port}}\"",
|
||||||
|
"-e DATA_SOURCE_NAME=\"postgresql://{{matrix_prometheus_postgres_exporter_database_username}}:{{matrix_prometheus_postgres_exporter_database_password}}@{{matrix_prometheus_postgres_exporter_database_hostname}}:5432/{{matrix_prometheus_postgres_exporter_database_name}}?sslmode=disable\"" ]
|
||||||
|
|
||||||
|
# List of systemd services that matrix-prometheus-postgres-exporter.service depends on
|
||||||
|
matrix_prometheus_postgres_exporter_systemd_required_services_list: ['docker.service']
|
||||||
|
|
||||||
|
# List of systemd services that matrix-prometheus-postgres-exporter.service wants
|
||||||
|
matrix_prometheus_postgres_exporter_systemd_wanted_services_list: []
|
||||||
|
|
||||||
|
# details for connecting to the database
|
||||||
|
matrix_prometheus_postgres_exporter_database_username: 'matrix_prometheus_postgres_exporter'
|
||||||
|
matrix_prometheus_postgres_exporter_database_password: 'some-password'
|
||||||
|
matrix_prometheus_postgres_exporter_database_hostname: 'matrix-postgres'
|
||||||
|
matrix_prometheus_postgres_exporter_database_port: 5432
|
||||||
|
matrix_prometheus_postgres_exporter_database_name: 'matrix_prometheus_postgres_exporter'
|
||||||
|
|
||||||
|
|
||||||
|
# Controls whether the matrix-prometheus container exposes its HTTP port (tcp/9100 in the container).
|
||||||
|
#
|
||||||
|
# Takes an "<ip>:<port>" value (e.g. "127.0.0.1:9100"), or empty string to not expose.
|
||||||
|
#
|
||||||
|
# Official recommendations are to run this container with `--net=host`,
|
||||||
|
# but we don't do that, since it:
|
||||||
|
# - likely exposes the metrics web server way too publicly (before applying https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1008)
|
||||||
|
# - or listens on a loopback interface only (--net=host and 127.0.0.1:9100), which is not reachable from another container (like `matrix-prometheus`)
|
||||||
|
#
|
||||||
|
# Using `--net=host` and binding to Docker's `matrix` bridge network may be a solution to both,
|
||||||
|
# but that's trickier to accomplish and won't necessarily work (hasn't been tested).
|
||||||
|
#
|
||||||
|
# Not using `--net=host` means that our network statistic reports are likely broken (inaccurate),
|
||||||
|
# because node-exporter can't see all interfaces, etc.
|
||||||
|
# For now, we'll live with that, until someone develops a better solution.
|
||||||
|
matrix_prometheus_postgres_exporter_container_http_host_bind_port: ''
|
||||||
|
|
||||||
|
matrix_prometheus_postgres_exporter_dashboard_urls:
|
||||||
|
- "https://grafana.com/api/dashboards/9628/revisions/7/download"
|
||||||
@ -0,0 +1,5 @@
|
|||||||
|
- set_fact:
|
||||||
|
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-prometheus-postgres-exporter.service'] }}"
|
||||||
|
when: matrix_prometheus_postgres_exporter_enabled|bool
|
||||||
|
|
||||||
|
|
||||||
@ -0,0 +1,8 @@
|
|||||||
|
- import_tasks: "{{ role_path }}/tasks/init.yml"
|
||||||
|
tags:
|
||||||
|
- always
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/setup.yml"
|
||||||
|
tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-prometheus-postgres-exporter
|
||||||
@ -0,0 +1,54 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
#
|
||||||
|
# Tasks related to setting up matrix-prometheus-postgres-exporter
|
||||||
|
#
|
||||||
|
|
||||||
|
- name: Ensure matrix-prometheus-postgres-exporter image is pulled
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_prometheus_postgres_exporter_docker_image }}"
|
||||||
|
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
||||||
|
force_source: "{{ matrix_prometheus_postgres_exporter_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
||||||
|
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_prometheus_postgres_exporter_docker_image_force_pull }}"
|
||||||
|
when: "matrix_prometheus_postgres_exporter_enabled|bool"
|
||||||
|
|
||||||
|
- name: Ensure matrix-prometheus-postgres-exporter.service installed
|
||||||
|
template:
|
||||||
|
src: "{{ role_path }}/templates/systemd/matrix-prometheus-postgres-exporter.service.j2"
|
||||||
|
dest: "{{ matrix_systemd_path }}/matrix-prometheus-postgres-exporter.service"
|
||||||
|
mode: 0644
|
||||||
|
register: matrix_prometheus_postgres_exporter_systemd_service_result
|
||||||
|
when: matrix_prometheus_postgres_exporter_enabled|bool
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-prometheus.service installation
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_prometheus_postgres_exporter_enabled|bool and matrix_prometheus_postgres_exporter_systemd_service_result.changed"
|
||||||
|
|
||||||
|
#
|
||||||
|
# Tasks related to getting rid of matrix-prometheus-postgres-exporter (if it was previously enabled)
|
||||||
|
#
|
||||||
|
|
||||||
|
- name: Check existence of matrix-prometheus-postgres-exporter service
|
||||||
|
stat:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-prometheus-postgres-exporter.service"
|
||||||
|
register: matrix_prometheus_postgres_exporter_service_stat
|
||||||
|
|
||||||
|
- name: Ensure matrix-prometheus-postgres-exporter is stopped
|
||||||
|
service:
|
||||||
|
name: matrix-prometheus-postgres-exporter
|
||||||
|
state: stopped
|
||||||
|
daemon_reload: yes
|
||||||
|
register: stopping_result
|
||||||
|
when: "not matrix_prometheus_postgres_exporter_enabled|bool and matrix_prometheus_postgres_exporter_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure matrix-prometheus-postgres-exporter.service doesn't exist
|
||||||
|
file:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-prometheus-postgres-exporter.service"
|
||||||
|
state: absent
|
||||||
|
when: "not matrix_prometheus_postgres_exporter_enabled|bool and matrix_prometheus_postgres_exporter_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-prometheus-postgres-exporter.service removal
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "not matrix_prometheus_postgres_exporter_enabled|bool and matrix_prometheus_postgres_exporter_service_stat.stat.exists"
|
||||||
@ -0,0 +1,42 @@
|
|||||||
|
#jinja2: lstrip_blocks: "True"
|
||||||
|
[Unit]
|
||||||
|
Description=matrix-prometheus-postgres-exporter
|
||||||
|
{% for service in matrix_prometheus_postgres_exporter_systemd_required_services_list %}
|
||||||
|
Requires={{ service }}
|
||||||
|
After={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
{% for service in matrix_prometheus_postgres_exporter_systemd_wanted_services_list %}
|
||||||
|
Wants={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
DefaultDependencies=no
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
Environment="HOME={{ matrix_systemd_unit_home_path }}"
|
||||||
|
ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-prometheus-postgres-exporter 2>/dev/null'
|
||||||
|
ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-prometheus-postgres-exporter 2>/dev/null'
|
||||||
|
|
||||||
|
|
||||||
|
ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-prometheus-postgres-exporter \
|
||||||
|
--log-driver=none \
|
||||||
|
--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
|
||||||
|
--cap-drop=ALL \
|
||||||
|
--read-only \
|
||||||
|
{% for arg in matrix_prometheus_postgres_exporter_container_extra_arguments %}
|
||||||
|
{{ arg }} \
|
||||||
|
{% endfor %}
|
||||||
|
--network={{ matrix_docker_network }} \
|
||||||
|
{% if matrix_prometheus_postgres_exporter_container_http_host_bind_port %}
|
||||||
|
-p {{ matrix_prometheus_postgres_exporter_container_http_host_bind_port }}:{{matrix_prometheus_postgres_exporter_port}} \
|
||||||
|
{% endif %}
|
||||||
|
--pid=host \
|
||||||
|
{{ matrix_prometheus_postgres_exporter_docker_image }}
|
||||||
|
|
||||||
|
ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-prometheus-postgres-exporter 2>/dev/null'
|
||||||
|
ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-prometheus-postgres-exporter 2>/dev/null'
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
SyslogIdentifier=matrix-prometheus-postgres-exporter
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/ext/mjolnir-antispam/setup_install.yml"
|
||||||
|
when: matrix_synapse_ext_spam_checker_mjolnir_antispam_enabled|bool
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/ext/mjolnir-antispam/setup_uninstall.yml"
|
||||||
|
when: "not matrix_synapse_ext_spam_checker_mjolnir_antispam_enabled|bool"
|
||||||
@ -0,0 +1,52 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Ensure git installed (RedHat)
|
||||||
|
yum:
|
||||||
|
name:
|
||||||
|
- git
|
||||||
|
state: present
|
||||||
|
update_cache: no
|
||||||
|
when: "ansible_os_family == 'RedHat'"
|
||||||
|
|
||||||
|
- name: Ensure git installed (Debian)
|
||||||
|
apt:
|
||||||
|
name:
|
||||||
|
- git
|
||||||
|
state: present
|
||||||
|
update_cache: no
|
||||||
|
when: "ansible_os_family == 'Debian'"
|
||||||
|
|
||||||
|
- name: Ensure git installed (Archlinux)
|
||||||
|
pacman:
|
||||||
|
name:
|
||||||
|
- git
|
||||||
|
state: present
|
||||||
|
update_cache: no
|
||||||
|
when: "ansible_distribution == 'Archlinux'"
|
||||||
|
|
||||||
|
- name: Clone mjolnir-antispam git repository
|
||||||
|
git:
|
||||||
|
repo: "{{ matrix_synapse_ext_spam_checker_mjolnir_antispam_git_repository_url }}"
|
||||||
|
version: "{{ matrix_synapse_ext_spam_checker_mjolnir_antispam_git_version }}"
|
||||||
|
dest: "{{ matrix_synapse_ext_path }}/mjolnir"
|
||||||
|
become: true
|
||||||
|
become_user: "{{ matrix_user_username }}"
|
||||||
|
|
||||||
|
- set_fact:
|
||||||
|
matrix_synapse_spam_checker: >
|
||||||
|
{{ matrix_synapse_spam_checker }}
|
||||||
|
+
|
||||||
|
[{
|
||||||
|
"module": "mjolnir.AntiSpam",
|
||||||
|
"config": {
|
||||||
|
"block_invites": {{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_invites }},
|
||||||
|
"block_messages": {{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_messages }},
|
||||||
|
"block_usernames": {{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_usernames }},
|
||||||
|
"ban_lists": {{ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists }}
|
||||||
|
}
|
||||||
|
}]
|
||||||
|
|
||||||
|
matrix_synapse_container_extra_arguments: >
|
||||||
|
{{ matrix_synapse_container_extra_arguments|default([]) }}
|
||||||
|
+
|
||||||
|
["--mount type=bind,src={{ matrix_synapse_ext_path }}/mjolnir/synapse_antispam/mjolnir,dst={{ matrix_synapse_in_container_python_packages_path }}/mjolnir,ro"]
|
||||||
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Ensure mjolnir-antispam doesn't exist
|
||||||
|
file:
|
||||||
|
path: "{{ matrix_synapse_ext_path }}/mjolnir"
|
||||||
|
state: absent
|
||||||
Loading…
Reference in new issue