11 |
13 |
14 | {% endblock %}
15 |
--------------------------------------------------------------------------------
/ui/tests/unit/test_pivot.py:
--------------------------------------------------------------------------------
1 | from io import StringIO
2 |
3 |
4 | def test_pivot():
5 | from temboardui.plugins.monitoring.pivot import pivot_timeserie
6 |
7 | in_ = StringIO("i,k,v\n1,a,1\n1,b,2\n2,a,3\n4,b,5\n100,z,100\n")
8 | expected = "i,a,b,z\n1,1,2,\n2,3,,\n4,,5,\n100,,,100\n"
9 | out_ = StringIO()
10 | pivot_timeserie(in_, index="i", key="k", value="v", output=out_)
11 | assert out_.getvalue() == expected
12 |
--------------------------------------------------------------------------------
/ui/temboardui/model/queries/instance-has-dba.sql:
--------------------------------------------------------------------------------
1 | SELECT EXISTS (
2 | SELECT COUNT(1)
3 | FROM application.instances AS i
4 | JOIN application.environments AS e ON e.id = i.environment_id
5 | JOIN application.groups AS g ON g.id = e.dba_group_id
6 | JOIN application.memberships AS ms ON ms.group_id = g.id
7 | WHERE i.agent_address = :agent_address AND i.agent_port = :agent_port
8 | AND ms.role_name = :role_name
9 | ) AS has_dba;
10 |
--------------------------------------------------------------------------------
/dev/bin/mkenv:
--------------------------------------------------------------------------------
1 | #!/bin/bash -eu
2 | #
3 | # Generate environment variables for development.
4 | #
5 |
6 | # Configure a routable UI address to configure agent-to-UI communication from
7 | # Docker container.
8 |
9 | mapfile -t hostaddr < <(hostname --all-ip-addresses | tr ' ' '\n')
10 | test -n "${hostaddr[*]}"
11 | TEMBOARD_UI_URL="http://${hostaddr[0]}:8888"
12 |
13 | cat <<-EOF
14 | # Generated by $0 at $(date).
15 | TEMBOARD_UI_URL=${TEMBOARD_UI_URL@Q}
16 | EOF
17 |
--------------------------------------------------------------------------------
/dev/postgres-setup-replication.sh:
--------------------------------------------------------------------------------
1 | mkdir -p "/var/lib/postgresql/archive"
2 |
3 | docker_process_sql <
7 |
16 | {% end %}
17 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/error.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Error{% endblock %}
4 |
5 | {% block content %}
6 |
8 |
14 |
15 |
7 |
15 | {% endblock %}
16 |
--------------------------------------------------------------------------------
/toolkit/temboardtoolkit/logfmt.py:
--------------------------------------------------------------------------------
1 | def format(**kw):
2 | return " ".join([format_attribute(*i) for i in sorted(flatten(**kw))])
3 |
4 |
5 | def format_attribute(key, value):
6 | if " " in str(value):
7 | value = '"%s"' % value
8 | return "%s=%s" % (key, value)
9 |
10 |
11 | def flatten(**kw):
12 | for k, v in kw.items():
13 | if isinstance(v, dict):
14 | for kk, vv in flatten(**v):
15 | yield "%s.%s" % (k, kk), vv
16 | else:
17 | yield k, v
18 |
--------------------------------------------------------------------------------
/ui/temboardui/cli/serve.py:
--------------------------------------------------------------------------------
1 | from temboardtoolkit import services
2 | from temboardtoolkit.app import SubCommand
3 |
4 | from ..model import check_schema
5 | from .app import app
6 |
7 |
8 | @app.command
9 | class Serve(SubCommand):
10 | """Combined web server and background workers."""
11 |
12 | is_service = True
13 |
14 | def main(self, args):
15 | check_schema()
16 | self.app.config.load_signing_key()
17 |
18 | services.run(self.app.webservice, self.app.scheduler, self.app.worker_pool)
19 |
--------------------------------------------------------------------------------
/ui/temboardui/model/queries/roles-select-instances.sql:
--------------------------------------------------------------------------------
1 | SELECT
2 | i.agent_address,
3 | i.agent_port,
4 | i.hostname,
5 | i.pg_port,
6 | i.notify,
7 | i.comment,
8 | i.cdate,
9 | i.discover,
10 | i.discover_date,
11 | i.discover_etag,
12 | i.environment_id
13 | FROM application.instances AS i
14 | JOIN application.environment AS e ON e.id = i.environment_id
15 | JOIN application.groups AS g ON g.id = e.group_id
16 | JOIN application.memberships AS m ON m.group_id = g.id
17 | WHERE m.role_name = :role_name;
18 |
--------------------------------------------------------------------------------
/agent/packaging/temboard-agent@.service:
--------------------------------------------------------------------------------
1 | [Unit]
2 | Description=PostgreSQL Remote Control Agent %I
3 | After=network.target postgresql@%i.service
4 | AssertPathExists=/etc/temboard-agent/%I/temboard-agent.conf
5 |
6 | [Service]
7 | Type=simple
8 | User=postgres
9 | Group=postgres
10 | Environment="SYSTEMD=1"
11 | ExecStart=/usr/bin/temboard-agent -c /etc/temboard-agent/%I/temboard-agent.conf serve
12 | # Increase OOM Score to ensure agent is killed before Postgres.
13 | OOMScoreAdjust=15
14 |
15 | [Install]
16 | WantedBy=multi-user.target
17 |
--------------------------------------------------------------------------------
/.config/.readthedocs.yaml:
--------------------------------------------------------------------------------
1 | version: 2
2 |
3 | build:
4 | os: ubuntu-22.04
5 | tools:
6 | python: "3.9"
7 | jobs:
8 | pre_create_environment:
9 | - asdf plugin add uv
10 | - asdf install uv latest
11 | - asdf global uv latest
12 | create_environment:
13 | - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
14 | install:
15 | - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --no-default-groups --group=docs
16 |
17 | mkdocs:
18 | configuration: mkdocs.yml
19 | fail_on_warning: true
20 |
--------------------------------------------------------------------------------
/dev/bin/checkdocker:
--------------------------------------------------------------------------------
1 | #!/bin/bash -eu
2 | # Usage: dev/bin/checkdocker
8 |
14 |
9 |
13 | Internal Error
10 |The following unhandled error occured:
11 |{{ message }}
12 |
7 |
14 | {% endblock %}
15 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/404.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Not Found{% endblock %}
4 |
5 | {% block content %}
6 |
8 |
13 |
9 |
12 | Authentication required
10 |Go to login page to authenticate.
11 |
7 |
14 | {% endblock %}
15 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/home.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}temBoard{% endblock %}
4 |
5 | {% block head %}
6 | {% for link in vitejs.css_links_for('home.js') %}
7 | {{ link | safe}}
8 | {% endfor %}
9 | {% endblock %}
10 |
11 | {% block content %}
12 |
8 |
13 |
9 |
12 | Page not Found
10 |The page you are looking for might have been removed or had its name changed.
11 |
13 |
16 |
17 |
18 |
19 | {% endblock %}
20 |
--------------------------------------------------------------------------------
/toolkit/tests/test_queries.py:
--------------------------------------------------------------------------------
1 | def test_filter_pg_version():
2 | from temboardtoolkit.queries import filter_pragma_version
3 |
4 | assert filter_pragma_version("pouet", pg_version=150000)
5 |
6 | sql = "pouet -- pragma:pg_version_max 140000"
7 | assert not filter_pragma_version(sql, pg_version=150000)
8 | assert filter_pragma_version(sql, pg_version=100000)
9 |
10 | sql = "pouet -- pragma:pg_version_min 140000"
11 | assert not filter_pragma_version(sql, pg_version=100000)
12 | assert filter_pragma_version(sql, pg_version=150000)
13 |
--------------------------------------------------------------------------------
/ui/temboardui/model/queries/monitoring-purge-instances.sql:
--------------------------------------------------------------------------------
1 | WITH deleted AS (
2 | SELECT
3 | i.instance_id,
4 | h.hostname,
5 | i.port
6 | FROM monitoring.instances AS i
7 | JOIN monitoring.hosts AS h USING (host_id)
8 | LEFT OUTER JOIN application.instances AS agent
9 | ON agent.hostname = h.hostname AND agent.pg_port = i.port
10 | WHERE agent.agent_address IS NULL
11 | )
12 | DELETE FROM monitoring.instances AS i
13 | USING deleted
14 | WHERE i.instance_id = deleted.instance_id
15 | RETURNING deleted.hostname, deleted.port;
16 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/configuration.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{super()}} / Configuration{% endblock %}
4 |
5 | {% block head %}
6 | {% for link in vitejs.css_links_for('home.js') %}
7 | {{ link | safe}}
8 | {% endfor %}
9 | {% endblock %}
10 |
11 | {% block content %}
12 |
13 |
18 |
19 | {% endblock %}
20 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/instance-about.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ About{% endblock %}
4 |
5 | {% block content %}
6 |
7 |
14 |
15 |
16 |
17 | {% endblock %}
18 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/home.js:
--------------------------------------------------------------------------------
1 | import { createApp } from "vue";
2 | import { createRouter, createWebHistory } from "vue-router";
3 |
4 | import Home from "./views/Home.vue";
5 |
6 | const NotFound = { template: "" };
7 | const router = createRouter({
8 | history: createWebHistory(),
9 | // at least one route is required, we use a fake one
10 | routes: [{ path: "/:pathMatch(.*)*", name: "not-found", component: NotFound }],
11 | });
12 |
13 | createApp({
14 | components: {
15 | home: Home,
16 | },
17 | })
18 | .use(router)
19 | .mount("#app");
20 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/about.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}temBoard / About{% endblock %}
4 |
5 | {% block head %}
6 | {% for link in vitejs.css_links_for('settings.about.js') %}
7 | {{ link | safe}}
8 | {% endfor %}
9 | {% endblock %}
10 |
11 | {% block content %}
12 |
13 |
14 |
17 |
18 |
19 |
20 | {% endblock %}
21 |
--------------------------------------------------------------------------------
/agent/temboardagent/cli/discover.py:
--------------------------------------------------------------------------------
1 | import logging
2 | import sys
3 |
4 | from temboardtoolkit.app import SubCommand
5 |
6 | from .app import app
7 |
8 | logger = logging.getLogger(__name__)
9 |
10 |
11 | @app.command
12 | class Discover(SubCommand):
13 | """Introspect system and PostgreSQL instance."""
14 |
15 | def main(self, args):
16 | self.app.discover.refresh()
17 | self.app.discover.write()
18 | self.app.discover.write(sys.stdout)
19 | logger.debug("Discover etag is %s.", self.app.discover.etag)
20 | return 0
21 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/unauthorized.html:
--------------------------------------------------------------------------------
1 | {% extends base.html %}
2 |
3 | {% block title %}temBoard{% end %}
4 |
5 | {% block content %}
6 |
7 |
16 | {% end %}
17 |
--------------------------------------------------------------------------------
/ui/share/preun.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | set -eu
3 | mode="$1"
4 |
5 | # rpm uses an int. deb uses a keyword.
6 | case "$mode" in
7 | remove|0)
8 | if ! readlink /proc/1/exe | grep -q systemd ; then
9 | echo You must disable manually temboard service. >&2
10 | exit 0
11 | fi
12 |
13 | systemctl disable --now temboard
14 | if systemctl -q is-failed temboard ; then
15 | systemctl reset-failed temboard
16 | fi
17 | exit 0
18 | ;;
19 | upgrade|1)
20 | exit 0
21 | ;;
22 | *)
23 | echo "Unknown scriptlet execution mode: '$mode'. Skipping" >&2
24 | exit 0
25 | ;;
26 | esac
27 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/monitoring.js:
--------------------------------------------------------------------------------
1 | import { createApp } from "vue";
2 | import { createRouter, createWebHistory } from "vue-router";
3 |
4 | import Monitoring from "./views/Monitoring.vue";
5 |
6 | const NotFound = { template: "" };
7 | const router = createRouter({
8 | history: createWebHistory(),
9 | // at least one route is required, we use a fake one
10 | routes: [{ path: "/:pathMatch(.*)*", name: "not-found", component: NotFound }],
11 | });
12 |
13 | createApp({
14 | components: {
15 | monitoring: Monitoring,
16 | },
17 | })
18 | .use(router)
19 | .mount("#app");
20 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/statements.js:
--------------------------------------------------------------------------------
1 | import { createApp } from "vue";
2 | import { createRouter, createWebHistory } from "vue-router";
3 |
4 | import Statements from "./views/Statements.vue";
5 |
6 | const NotFound = { template: "" };
7 | const router = createRouter({
8 | history: createWebHistory(),
9 | // at least one route is required, we use a fake one
10 | routes: [{ path: "/:pathMatch(.*)*", name: "not-found", component: NotFound }],
11 | });
12 |
13 | createApp({
14 | components: {
15 | statements: Statements,
16 | },
17 | })
18 | .use(router)
19 | .mount("#app");
20 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/activity.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 | {% block title %}temBoard / {{instance}} / Activity{% endblock %}
3 |
4 | {% block head %}
5 | {% for link in vitejs.css_links_for('activity.js') %}{{ link | safe }}{% endfor %}
6 | {% endblock %}
7 |
8 | {% block content %}
9 |
8 |
13 |
14 |
15 |
10 |
12 |
13 |
14 |
18 |
19 | {% endblock %}
20 |
--------------------------------------------------------------------------------
/ui/temboardui/__init__.py:
--------------------------------------------------------------------------------
1 | import os
2 | import sys
3 |
4 | if True: # Vendoring
5 | parent_dir = os.path.abspath(os.path.dirname(__file__))
6 | vendor_dir = os.path.join(parent_dir, "_vendor")
7 | sys.path[:0] = [vendor_dir]
8 |
9 | import warnings
10 |
11 | import temboardtoolkit.log
12 |
13 | from .version import __version__ # noqa
14 |
15 | if "DEBUG" not in os.environ and "CI" not in os.environ:
16 | warnings.filterwarnings("ignore")
17 |
18 | # Configure toolkit root logger name before importing toolkit's getLogger.
19 | temboardtoolkit.log.LastnameFilter.root = __name__
20 |
--------------------------------------------------------------------------------
/agent/temboardagent/__init__.py:
--------------------------------------------------------------------------------
1 | import os
2 | import sys
3 | import warnings
4 |
5 | if True: # Vendoring
6 | parent_dir = os.path.abspath(os.path.dirname(__file__))
7 | vendor_dir = os.path.join(parent_dir, "_vendor")
8 | sys.path[:0] = [vendor_dir]
9 |
10 | import temboardtoolkit.log
11 |
12 | from .version import __version__ # noqa
13 |
14 | if "DEBUG" not in os.environ and "CI" not in os.environ:
15 | warnings.filterwarnings("ignore")
16 |
17 |
18 | # Configure toolkit root logger name before importing toolkit's getLogger.
19 | temboardtoolkit.log.LastnameFilter.root = __name__
20 |
--------------------------------------------------------------------------------
/dev/grafana/rootfs/etc/grafana/provisioning/dashboards/perf.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: 1
2 |
3 | providers:
4 | - name: "temBoard Performance Provisionned"
5 | type: file
6 | folder: ''
7 | allowUiUpdates: true
8 | options:
9 | path: /usr/share/temboard/perf.json
10 | - name: "Postgres from temBoard agent"
11 | type: file
12 | folder: ''
13 | allowUiUpdates: true
14 | options:
15 | path: /usr/share/temboard/postgres.json
16 | - name: "temBoard Prometheus"
17 | type: file
18 | folder: ''
19 | allowUiUpdates: true
20 | options:
21 | path: /usr/share/temboard/temboard-prometheus.json
22 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/alerting.check.js:
--------------------------------------------------------------------------------
1 | import { createApp } from "vue";
2 | import { createRouter, createWebHistory } from "vue-router";
3 |
4 | import AlertingCheck from "./views/AlertingCheck.vue";
5 |
6 | const NotFound = { template: "" };
7 | const router = createRouter({
8 | history: createWebHistory(),
9 | // at least one route is required, we use a fake one
10 | routes: [{ path: "/:pathMatch(.*)*", name: "not-found", component: NotFound }],
11 | });
12 |
13 | createApp({
14 | components: {
15 | alertingCheck: AlertingCheck,
16 | },
17 | })
18 | .use(router)
19 | .mount("#app");
20 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | charset = utf-8
5 | indent_style = space
6 | indent_size = 4
7 | # Unix-style newlines
8 | end_of_line = lf
9 | # Remove any whitespace characters preceding newline characters
10 | trim_trailing_whitespace = true
11 | # Newline ending every file
12 | insert_final_newline = true
13 | # Sync it with default ruff value.
14 | max_line_length = 88
15 |
16 | # 2 space indentation for UI
17 | [*.{css,html,js,json,scss,yml,yaml,sql,vue}]
18 | indent_size = 2
19 |
20 | [{*.sh,Makefile}]
21 | indent_size = 8
22 | indent_style = tab
23 |
24 | [dev/lnav/**.json]
25 | indent_size = 4
26 |
--------------------------------------------------------------------------------
/ui/temboardui/cli/web.py:
--------------------------------------------------------------------------------
1 | from temboardtoolkit import services
2 | from temboardtoolkit.app import SubCommand
3 |
4 | from ..model import check_schema
5 | from .app import app
6 |
7 |
8 | @app.command
9 | class web(SubCommand):
10 | """Standalone web server.
11 |
12 | For testing purpose only. Some feature won't work without combined task
13 | manager processes. See serve command for production.
14 |
15 | """
16 |
17 | is_service = True
18 |
19 | def main(self, args):
20 | check_schema()
21 | self.app.config.load_signing_key()
22 | services.run(self.app.webservice)
23 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/maintenance/index.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Maintenance{% endblock %}
4 |
5 | {% block content %}
6 |
7 | {% include "maintenance/breadcrumb.html" %}
8 |
9 |
17 |
18 |
19 | {% endblock %}
20 |
--------------------------------------------------------------------------------
/ui/temboardui/plugins/pgconf/__init__.py:
--------------------------------------------------------------------------------
1 | from ...web.flask import instance_proxy
2 |
3 |
4 | class PGConfPlugin:
5 | def __init__(self, app):
6 | self.app = app
7 |
8 | def load(self):
9 | __import__(__name__ + ".routes")
10 | instance_proxy.generic_proxy("/pgconf/configuration")
11 | instance_proxy.generic_proxy("/pgconf/configuration", method="POST")
12 | instance_proxy.generic_proxy("/pgconf/configuration/categories")
13 | instance_proxy.generic_proxy("/pgconf/configuration/status")
14 | instance_proxy.generic_proxy("/pgconf/configuration/category/
14 |
16 |
17 | {% endblock %}
18 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/public/images/ring-alt.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/403.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Restricted area{% endblock %}
4 |
5 | {% block content %}
6 |
7 |
16 | {% endblock %}
17 |
--------------------------------------------------------------------------------
/ui/temboardui/model/queries/instance-select-email-and-phone-for-notify.sql:
--------------------------------------------------------------------------------
1 | SELECT
2 | array_agg(DISTINCT r.role_email) FILTER (WHERE r.role_email IS NOT NULL AND r.role_email <> '') AS emails,
3 | array_agg(DISTINCT r.role_phone) FILTER (WHERE r.role_phone IS NOT NULL AND r.role_phone <> '') AS phones
4 | FROM application.instances AS i
5 | JOIN application.environments AS e ON i.environment_id = e.id
6 | JOIN application.memberships AS m ON e.dba_group_id = m.group_id
7 | JOIN application.roles AS r ON m.role_name = r.role_name
8 | WHERE i.agent_address = :agent_address AND i.agent_port = :agent_port
9 | AND r.is_active AND i.notify;
10 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/login.js:
--------------------------------------------------------------------------------
1 | import $ from "jquery";
2 |
3 | function login(e) {
4 | e.preventDefault();
5 | $.ajax({
6 | url: "/json/login",
7 | type: "post",
8 | data: JSON.stringify({
9 | username: $("#inputUsername").val(),
10 | password: $("#inputPassword").val(),
11 | }),
12 | headers: {
13 | "Content-Type": "application/json",
14 | },
15 | success: function (data) {
16 | window.location.href = document.referrer ? document.referrer : "/";
17 | },
18 | error: function (xhr) {
19 | console.log("error", xhr);
20 | showError(xhr);
21 | },
22 | });
23 | }
24 |
25 | window.login = login;
26 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/components/configuration/SettingSwitch.vue:
--------------------------------------------------------------------------------
1 |
10 |
11 |
12 |
8 |
15 |
9 |
14 | Restricted area
10 |You are not allowed to access this page.
11 | Go back to home page
12 | or ask your temBoard administrator to grant access to you.
13 |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/dev/loki/loki-config.yaml:
--------------------------------------------------------------------------------
1 | auth_enabled: false
2 |
3 | server:
4 | http_listen_port: 3100
5 | grpc_listen_port: 9096
6 |
7 | common:
8 | path_prefix: /tmp/loki
9 | storage:
10 | filesystem:
11 | chunks_directory: /tmp/loki/chunks
12 | rules_directory: /tmp/loki/rules
13 | replication_factor: 1
14 | ring:
15 | instance_addr: 127.0.0.1
16 | kvstore:
17 | store: inmemory
18 |
19 | schema_config:
20 | configs:
21 | - from: 2020-10-24
22 | store: boltdb-shipper
23 | object_store: filesystem
24 | schema: v11
25 | index:
26 | prefix: index_
27 | period: 24h
28 |
29 | ruler:
30 | alertmanager_url: http://localhost:9093
31 |
--------------------------------------------------------------------------------
/ui/temboardui/model/queries/instances-insert.sql:
--------------------------------------------------------------------------------
1 | WITH environment AS (
2 | SELECT id FROM application.environments WHERE name = :environment
3 | )
4 | INSERT INTO application.instances (agent_address, agent_port, hostname, pg_port, notify, comment, discover, discover_date, discover_etag, environment_id)
5 | SELECT
6 | :agent_address AS agent_address,
7 | :agent_port AS agent_port,
8 | :hostname AS hostname,
9 | :pg_port AS pg_port,
10 | :notify AS notify,
11 | :comment AS "comment",
12 | :discover AS discover,
13 | :discover_date AS discover_date,
14 | :discover_etag AS discover_etag,
15 | environment.id AS environment_id
16 | FROM environment
17 | RETURNING *;
18 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/components/settings/InstanceDetails.vue:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
15 |
16 |
--------------------------------------------------------------------------------
/ui/packaging/docker/entrypoint.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash -eu
2 |
3 | export PGHOST=${PGHOST-localhost}
4 | export PGPORT=${PGPORT-5432}
5 | export PGUSER=${PGUSER-postgres}
6 | PGPASSWORD=${PGPASSWORD-}
7 | export PGDATABASE=${PGDATABASE-$PGUSER}
8 |
9 | wait-for-it "${PGHOST}:${PGPORT}"
10 | if [ ! -f /etc/temboard/temboard.conf ] ; then
11 | if ! DEBUG=y PGPASSWORD="$PGPASSWORD" /usr/share/temboard/auto_configure.sh; then
12 | cat /var/log/temboard-auto-configure.log >&2
13 | exit 1
14 | fi
15 | fi
16 |
17 | # Clean PG* used for setup. libpq for temBoard is configured only by config
18 | # file.
19 | # shellcheck disable=2086
20 | unset ${!PG*}
21 |
22 | set -x
23 | exec sudo -EHu temboard "${@-temboard}"
24 |
--------------------------------------------------------------------------------
/agent/temboardagent/cli/runscript.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | from temboardtoolkit.app import SubCommand
4 |
5 | from .app import app
6 |
7 | logger = logging.getLogger(__name__)
8 |
9 |
10 | @app.command
11 | class RunScript(SubCommand):
12 | """Run a Python script."""
13 |
14 | def define_arguments(self, parser):
15 | parser.add_argument("script", metavar="PATH", help="Path to script file.")
16 |
17 | super().define_arguments(parser)
18 |
19 | def main(self, args):
20 | with open(args.script) as fo:
21 | source = fo.read()
22 | code = compile(source, args.script, "exec")
23 |
24 | g = globals()
25 | g["app"] = self.app
26 |
27 | exec(code, g, g)
28 |
--------------------------------------------------------------------------------
/ui/temboardui/plugins/monitoring/templates/index.html:
--------------------------------------------------------------------------------
1 | {% extends ../../../templates/base.html %}
2 |
3 | {% block title %}temBoard / {{instance}} / Monitoring{% end %}
4 |
5 | {% block head %}
6 |
7 | {% end %}
8 |
9 | {% block content %}
10 |
11 | :
8 |
9 | CPU - GB memory
10 | serving .
13 |
12 |
14 |
15 |
16 |
17 |
21 |
22 | {% end %}
23 |
--------------------------------------------------------------------------------
/agent/temboardagent/queries/monitoring-bgwriter.sql:
--------------------------------------------------------------------------------
1 | WITH backends AS (
2 | SELECT SUM(writes) AS buffers_backend,
3 | SUM(fsyncs) AS buffers_backend_fsync
4 | FROM pg_stat_io
5 | WHERE backend_type = 'client backend'
6 | )
7 | SELECT cp.num_timed AS checkpoints_timed,
8 | cp.num_requested AS checkpoints_req,
9 | cp.write_time AS checkpoint_write_time,
10 | cp.sync_time AS checkpoint_sync_time,
11 | cp.buffers_written AS buffers_checkpoint,
12 | bg.buffers_clean,
13 | bg.maxwritten_clean,
14 | backends.buffers_backend,
15 | backends.buffers_backend_fsync,
16 | bg.buffers_alloc,
17 | bg.stats_reset
18 | FROM pg_stat_bgwriter AS bg,
19 | pg_stat_checkpointer AS cp,
20 | backends;
21 |
--------------------------------------------------------------------------------
/dev/agent-entrypoint.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash -eux
2 |
3 | chown -R "$(stat -c "%u:%g" "$0")" /usr/local/src/temboard/agent
4 |
5 | if ! [ -f /etc/temboard-agent/postgres0/signing-public.pem ] ; then
6 | # Copy dev signing key to prefetch UI key. Don't bother whether we are
7 | # managing first or second instance.
8 | mkdir -p /etc/temboard-agent/postgres{0,1}
9 | cp -fv /usr/local/src/temboard/dev/signing-public.pem /etc/temboard-agent/postgres0
10 | cp -fv /usr/local/src/temboard/dev/signing-public.pem /etc/temboard-agent/postgres1
11 | fi
12 |
13 | # Presere uv PATH when sudoing as Postgres.
14 | sed -i /secure_path/d /etc/sudoers
15 | visudo -cf /etc/sudoers
16 |
17 | uv sync
18 | exec uv run /usr/local/src/temboard/agent/packaging/docker/entrypoint.sh "$@"
19 |
--------------------------------------------------------------------------------
/agent/share/preun.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | set -eu
3 | mode="$1"
4 |
5 | # rpm uses an int. deb uses a keyword.
6 | case "$mode" in
7 | 0|remove)
8 | if ! readlink /proc/1/exe | grep -q systemd ; then
9 | echo You must disable manually temboard-agent services. >&2
10 | exit 0
11 | fi
12 |
13 | while read -r service ; do
14 | systemctl disable --now "$service"
15 | if systemctl -q is-failed "$service" ; then
16 | systemctl reset-failed "$service"
17 | fi
18 | done < <(systemctl list-units --full --no-legend --no-pager --plain --type service temboard-agent@* | grep -Po '^[^.]+')
19 | exit 0
20 | ;;
21 | 1|upgrade)
22 | exit 0
23 | ;;
24 | *)
25 | echo "Unknown scriptlet execution mode: '$mode'. Skipping" >&2
26 | exit 0
27 | ;;
28 | esac
29 |
--------------------------------------------------------------------------------
/agent/temboardagent/queries/pgconf-settings.sql:
--------------------------------------------------------------------------------
1 | SELECT
2 | category, "s"."name",
3 | "s".setting,
4 | current_setting("name") AS current_setting,
5 | unit,
6 | vartype,
7 | min_val, max_val, enumvals,
8 | context,
9 | short_desc || ' ' || coalesce(extra_desc, '') AS "desc",
10 | boot_val, reset_val,
11 | pending_restart,
12 | COALESCE(json_agg(
13 | json_build_object(
14 | 'file', f.sourcefile,
15 | 'line', f.sourceline,
16 | 'seqno', f.seqno,
17 | 'setting', f.setting,
18 | 'error', f.error,
19 | 'applied', f.applied
20 | )
21 | ) FILTER (WHERE f.sourcefile IS NOT NULL), '[]'::JSON) AS sources
22 | FROM pg_settings AS "s"
23 | LEFT OUTER JOIN pg_file_settings AS "f" USING("name")
24 | GROUP BY 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
25 | ORDER BY 1, 2;
26 |
--------------------------------------------------------------------------------
/ui/temboardui/plugins/statements/templates/index.html:
--------------------------------------------------------------------------------
1 | {% extends ../../../templates/base.html %}
2 |
3 | {% block title %}temBoard / {{instance}} / Statements{% end %}
4 |
5 | {% block head %}
6 | {% for link in vitejs.css_links_for('statements.js') %}{% raw link %}{% end %}
7 |
8 | {% end %}
9 |
10 | {% block content %}
11 |
12 |
13 |
15 |
16 |
17 |
18 |
22 | {% end %}
23 |
--------------------------------------------------------------------------------
/agent/temboardagent/__main__.py:
--------------------------------------------------------------------------------
1 | import sys
2 |
3 | from bottle import default_app
4 |
5 | from .cli.app import app
6 | from .web.app import create_app
7 |
8 |
9 | def main():
10 | default_app.push(create_app(app))
11 |
12 | # Import core HTTP routes
13 | __import__(__package__ + ".web.core")
14 |
15 | # Import commands
16 | __import__(__package__ + ".cli.discover")
17 | __import__(__package__ + ".cli.fetch_key")
18 | __import__(__package__ + ".cli.register")
19 | __import__(__package__ + ".cli.routes")
20 | __import__(__package__ + ".cli.runscript")
21 | __import__(__package__ + ".cli.serve")
22 | __import__(__package__ + ".cli.tasks")
23 | __import__(__package__ + ".cli.web")
24 | return app()
25 |
26 |
27 | if "__main__" == __name__:
28 | sys.exit(main())
29 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/maintenance/database.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Maintenance / {{database}}{% endblock %}
4 |
5 | {% block content %}
6 |
7 | {% include "maintenance/breadcrumb.html" %}
8 |
9 |
10 |
11 |
21 |
22 |
23 | {% endblock %}
24 |
--------------------------------------------------------------------------------
/ui/tests/unit/test_main.py:
--------------------------------------------------------------------------------
1 | def test_pgvar_map():
2 | from temboardui.cli.app import map_pgvars
3 |
4 | env = dict(
5 | PGHOST="localhost",
6 | PGPORT="5433",
7 | PGUSER="temboard",
8 | PGPASSWORD="étagère",
9 | PGDATABASE="temboarddb",
10 | )
11 | mapped = map_pgvars(env)
12 | assert "localhost" == mapped["TEMBOARD_REPOSITORY_HOST"]
13 | assert "5433" == mapped["TEMBOARD_REPOSITORY_PORT"]
14 | assert "temboard" == mapped["TEMBOARD_REPOSITORY_USER"]
15 | assert "étagère" == mapped["TEMBOARD_REPOSITORY_PASSWORD"]
16 | assert "temboarddb" == mapped["TEMBOARD_REPOSITORY_DBNAME"]
17 |
18 | env = dict(PGHOST="pg", TEMBOARD_REPOSITORY_HOST="temboard")
19 | mapped = map_pgvars(env)
20 | assert "temboard" == mapped["TEMBOARD_REPOSITORY_HOST"]
21 |
--------------------------------------------------------------------------------
/ui/temboardui/web/routes/instance.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | from flask import current_app as app
4 | from flask import g, render_template
5 |
6 | from ..flask import instance_routes
7 |
8 | logger = logging.getLogger(__name__)
9 |
10 |
11 | @instance_routes.route("/about")
12 | def instance_about():
13 | app.instance.fetch_status()
14 | return render_template(
15 | "instance-about.html",
16 | instance_name=g.instance.__str__(),
17 | pg_data=g.instance.pg_data,
18 | pg_version_summary=g.instance.pg_version_summary,
19 | discover=g.instance.discover,
20 | environment=g.instance.environment.name,
21 | )
22 |
23 |
24 | @app.route("/explain")
25 | def explain():
26 | return render_template(
27 | "explain.html", nav=True, role=g.current_user, vitejs=app.vitejs
28 | )
29 |
--------------------------------------------------------------------------------
/dev/signing-public.pem:
--------------------------------------------------------------------------------
1 | -----BEGIN PUBLIC KEY-----
2 | MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA4TVNVsTR3IaL9hdV69XY
3 | 6FEFnZpxfdJ5HuKtku+Gy+ezw4swTNLolSXn1OYDlLd688aE0p3xER+dtim5bWxj
4 | p2iTnN2hS8w6hPMA3o5noBG1UWJy5jjKeVF40h92MAB6KU4SA84IJNz+zBQTIFkx
5 | AqRaOJUPqyJwXeHhkiH3p5zuPHw+FPZZkNcmL4FuoPjZ5KGvPalUvmUM7HZevSdf
6 | 4Ycsn5xEHB8mutpwheNhRJDRuUfzZxoj6Iru7hPxWOSrQdgkIxYymZV0YrRGB0OI
7 | AV5Go1MwWCAyK8D55JO9F3fZMwyVbSHAdOEcvCVqf8YBrjT3BzvgxM1qDx+k5Mlb
8 | 3RcMED9EXNGwKUHKxsc9jEFunNeM6t8mpndki2gdxrmZsovQ2MDAmGcFNTffSO5h
9 | S5hm4nw44Vv2SG7FBOp29WmGbOdBnNRwAt1f5VvvyYLwwAX3bk8ljIYplMBWJN5D
10 | sl0kT9YPYphbWtWESLX9X/LgpgD7t299m4Fi0OEyamL0jF4pRgvTha3vUIEtcgaJ
11 | 3WNGVFQRBHgu8lIUmI6hO7swCMnIG+CcjCRo0ez/e0JyK6ONVFuuwt38FSam+Nrk
12 | vDqvhmKaNFwJpkWuSW3p+j5fjWVsf39arIodLU4XxNr32LaqKncld24bRYhg35CG
13 | /saax0girQznwhje0AH0tLMCAwEAAQ==
14 | -----END PUBLIC KEY-----
15 |
--------------------------------------------------------------------------------
/agent/share/purge.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash -eu
2 |
3 | if [ -n "${DEBUG-}" ] ; then
4 | set -x
5 | fi
6 |
7 | ETCDIR=${ETCDIR-/etc/temboard-agent}
8 | VARDIR=${VARDIR-/var/lib/temboard-agent}
9 | LOGDIR=${LOGDIR-/var/log/temboard-agent}
10 |
11 | instance_path="$1"
12 | instance_name="${instance_path//\//-}"
13 |
14 | if type -p systemctl >/dev/null && systemctl is-system-running && [ -w /etc/systemd/system ]; then
15 | echo "Stopping and disabling systemd service." >&2
16 | systemctl disable --now "temboard-agent@$instance_name" || true
17 | fi
18 |
19 | echo "Cleaning files and directories..." >&2
20 | rm -rvf \
21 | "${ETCDIR:?}/$instance_path/" \
22 | "${LOGDIR:?}/$instance_path.log" \
23 | "${VARDIR:?}/$instance_path/" \
24 | "/etc/systemd/system/temboard-agent@${instance_path}.service.d" \
25 | ;
26 |
27 | echo "temBoard agent ${instance_name} stopped and cleaned." >&2
28 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/dashboard.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Dashboard{% endblock %}
4 |
5 | {% block content %}
6 |
7 |
21 |
22 |
23 |
24 |
25 | {% endblock %}
26 |
--------------------------------------------------------------------------------
/ui/vendor.txt:
--------------------------------------------------------------------------------
1 | # This file was autogenerated by uv via the following command:
2 | # uv pip compile --python-version=3.9 ui/vendor.in -o ui/vendor.txt
3 | blinker==1.9.0
4 | # via flask
5 | click==8.1.8
6 | # via flask
7 | flask==3.1.2
8 | # via -r ui/vendor.in
9 | greenlet==3.2.4
10 | # via sqlalchemy
11 | importlib-metadata==8.7.0
12 | # via flask
13 | itsdangerous==2.2.0
14 | # via flask
15 | jinja2==3.1.6
16 | # via
17 | # -r ui/vendor.in
18 | # flask
19 | markupsafe==3.0.3
20 | # via
21 | # flask
22 | # jinja2
23 | # werkzeug
24 | python-dateutil==2.9.0.post0
25 | # via -r ui/vendor.in
26 | six==1.17.0
27 | # via python-dateutil
28 | sqlalchemy==1.4.54
29 | # via -r ui/vendor.in
30 | tornado==6.4.2
31 | # via -r ui/vendor.in
32 | werkzeug==3.1.3
33 | # via flask
34 | zipp==3.23.0
35 | # via importlib-metadata
36 |
--------------------------------------------------------------------------------
/docs/assets/temboard.css:
--------------------------------------------------------------------------------
1 | :root {
2 | --md-primary-fg-color: #d65916;
3 | --md-primary-fg-color--dark: #622a11;
4 | --md-accent-fg-color: #d65916;
5 | }
6 |
7 | .md-grid {
8 | max-width: 1200px;
9 | }
10 |
11 | .md-sidebar[hidden] + .md-content {
12 | max-width: 990px;
13 | margin: 0 auto;
14 | }
15 |
16 | .md-container .md-main h2.doc-hide {
17 | display: none;
18 | }
19 |
20 | .md-container .md-main img.logo {
21 | display: block;
22 | margin: 3rem auto;
23 | max-width: 75%;
24 | }
25 |
26 | .display-none
27 | {
28 | display: none !important;
29 | }
30 |
31 | .md-container .md-main article > p img {
32 | display: block;
33 | max-width: 90%;
34 | margin: 1em auto;
35 | }
36 |
37 | /* Hide RTD injected code. */
38 | div.injected {
39 | display: none !important;
40 | }
41 |
42 | .md-header__option {
43 | height: 2.4rem;
44 | line-height: 2.4rem;
45 | }
46 |
--------------------------------------------------------------------------------
/agent/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright (c) 2016, Dalibo
2 |
3 | Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.
4 |
5 | IN NO EVENT SHALL DALIBO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF DALIBO HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
6 |
7 | DALIBO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND DALIBO HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
8 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/_bootstrap-variables-override.scss:
--------------------------------------------------------------------------------
1 | $primary: #3c424c;
2 | $undef: #ccc;
3 | $cat1: #78b8fa;
4 | $cat2: #fa9e78;
5 | $navbar-inverse-bg: $primary;
6 | $link-color: lighten(saturate($primary, 15%), 15%);
7 |
8 | @import "../node_modules/bootstrap/scss/functions";
9 | @import "../node_modules/bootstrap/scss/variables";
10 |
11 | $input-border-focus: $link-color;
12 | $grid-gutter-width: 20px;
13 | $spacer: $grid-gutter-width;
14 | $small-font-size: 85%;
15 |
16 | // Additional xxl grid tiers
17 | $grid-breakpoints: (
18 | xs: 0,
19 | sm: 576px,
20 | md: 768px,
21 | lg: 992px,
22 | xl: 1200px,
23 | xxl: 1500px,
24 | ) !default;
25 |
26 | $custom-colors: (
27 | "ok": $success,
28 | "critical": $danger,
29 | "undef": $undef,
30 | "cat1": $cat1,
31 | "cat2": $cat2,
32 | );
33 | $theme-colors: map-merge($theme-colors, $custom-colors);
34 | $popover-font-size: 1rem !default;
35 |
--------------------------------------------------------------------------------
/ui/temboardui/model/versions/010_discover.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE "application"."instances"
2 | ADD COLUMN "cdate" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
3 | ADD COLUMN "discover" JSONB,
4 | ADD COLUMN "discover_date" TIMESTAMP WITH TIME ZONE,
5 | ADD COLUMN "discover_etag" TEXT;
6 |
7 | UPDATE "application"."instances"
8 | SET "discover" = json_build_object(
9 | 'system', json_build_object(
10 | 'cpu_count', "cpu",
11 | 'memory', "memory_size",
12 | 'fqdn', "hostname"
13 | ),
14 | 'postgres', json_build_object(
15 | 'version', "pg_version",
16 | 'version_summary', "pg_version_summary",
17 | 'port', "pg_port",
18 | 'data_directory', "pg_data"
19 | ),
20 | 'temboard', json_build_object()
21 | );
22 |
23 | ALTER TABLE "application"."instances"
24 | DROP COLUMN "cpu",
25 | DROP COLUMN "memory_size",
26 | DROP COLUMN "pg_data",
27 | DROP COLUMN "pg_version",
28 | DROP COLUMN "pg_version_summary";
29 |
--------------------------------------------------------------------------------
/ui/packaging/nfpm/docker-compose.yml:
--------------------------------------------------------------------------------
1 | services:
2 | rhel10: &rhel
3 | image: dalibo/buildpack-pkg:rockylinux10
4 | volumes:
5 | - ../..:/workspace
6 | working_dir: /workspace
7 | entrypoint: ["/usr/bin/tini", "--"]
8 | command: /workspace/packaging/nfpm/mkrpm.sh
9 |
10 | rhel9:
11 | <<: *rhel
12 | image: dalibo/buildpack-pkg:rockylinux9
13 |
14 | rhel8:
15 | <<: *rhel
16 | image: dalibo/buildpack-pkg:rockylinux8
17 |
18 | trixie: &mkdeb
19 | <<: *rhel
20 | image: dalibo/buildpack-pkg:trixie
21 | command: /workspace/packaging/nfpm/mkdeb.sh
22 |
23 | bookworm:
24 | <<: *mkdeb
25 | image: dalibo/buildpack-pkg:bookworm
26 |
27 | bullseye:
28 | <<: *mkdeb
29 | image: dalibo/buildpack-pkg:bullseye
30 |
31 | jammy:
32 | <<: *mkdeb
33 | image: dalibo/buildpack-pkg:jammy
34 |
35 | noble:
36 | <<: *mkdeb
37 | image: dalibo/buildpack-pkg:noble
38 |
--------------------------------------------------------------------------------
/agent/packaging/nfpm/docker-compose.yml:
--------------------------------------------------------------------------------
1 | services:
2 | rhel10: &rhel
3 | image: dalibo/buildpack-pkg:rockylinux10
4 | volumes:
5 | - ../..:/workspace
6 | working_dir: /workspace
7 | entrypoint: ["/usr/bin/tini", "--"]
8 | command: /workspace/packaging/nfpm/mkrpm.sh
9 |
10 | rhel9:
11 | <<: *rhel
12 | image: dalibo/buildpack-pkg:rockylinux9
13 |
14 | rhel8:
15 | <<: *rhel
16 | image: dalibo/buildpack-pkg:rockylinux8
17 |
18 | trixie: &mkdeb
19 | <<: *rhel
20 | image: dalibo/buildpack-pkg:trixie
21 | command: /workspace/packaging/nfpm/mkdeb.sh
22 |
23 | bookworm:
24 | <<: *mkdeb
25 | image: dalibo/buildpack-pkg:bookworm
26 |
27 | bullseye:
28 | <<: *mkdeb
29 | image: dalibo/buildpack-pkg:bullseye
30 |
31 | jammy:
32 | <<: *mkdeb
33 | image: dalibo/buildpack-pkg:jammy
34 |
35 | noble:
36 | <<: *mkdeb
37 | image: dalibo/buildpack-pkg:noble
38 |
--------------------------------------------------------------------------------
/ui/temboardui/plugins/monitoring/templates/alerting.check.html:
--------------------------------------------------------------------------------
1 | {% extends ../../../templates/base.html %}
2 |
3 | {% block title %}temBoard / {{instance}} / Monitoring{% end %}
4 |
5 | {% block head %}
6 |
7 | {% end %}
8 |
9 | {% block content %}
10 |
11 |
12 |
14 |
15 |
16 |
17 |
28 | {% end %}
29 |
--------------------------------------------------------------------------------
/ui/temboardui/web/routes/core.py:
--------------------------------------------------------------------------------
1 | from flask import current_app as app
2 | from flask import g, jsonify, redirect
3 |
4 | from ...model.orm import Instance
5 | from ..flask import admin_required, anonymous_allowed
6 |
7 |
8 | @app.route("/")
9 | @anonymous_allowed
10 | def index():
11 | if g.current_user:
12 | return redirect("/home")
13 | return redirect("/login")
14 |
15 |
16 | @app.route("/json/instances/home")
17 | def get_instance_home():
18 | """Data for InstanceCards.vue component."""
19 | return jsonify(
20 | [
21 | {k: getattr(row, k) for k in row.keys()}
22 | for row in g.db_session.execute(
23 | Instance.select_for_home(g.current_user.role_name)
24 | )
25 | ]
26 | )
27 |
28 |
29 | @app.route("/json/plugins")
30 | @admin_required
31 | def get_plugins():
32 | """List plugins."""
33 | return jsonify(sorted(app.temboard.config.temboard.plugins))
34 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/utils/state.js:
--------------------------------------------------------------------------------
1 | function stateBorderClass(state) {
2 | const classes = ["border"];
3 | if (state != "OK" && state != "UNDEF") {
4 | classes.push("border-" + state.toLowerCase());
5 | }
6 | if (state == "CRITICAL") {
7 | classes.push("border-2");
8 | }
9 | return classes;
10 | }
11 |
12 | function stateBgClass(state) {
13 | const classes = [];
14 | if (state == "UNDEF") {
15 | classes.push("text-bg-light");
16 | } else if (state == "OK") {
17 | classes.push("text-success");
18 | } else {
19 | classes.push("text-bg-" + state.toLowerCase());
20 | }
21 | return classes;
22 | }
23 |
24 | function stateIcon(state) {
25 | if (state == "WARNING") {
26 | return "fa-warning";
27 | }
28 | if (state == "CRITICAL") {
29 | return "fa-burst";
30 | }
31 | if (state == "OK") {
32 | return "fa-check";
33 | }
34 | return "";
35 | }
36 |
37 | export { stateBgClass, stateBorderClass, stateIcon };
38 |
--------------------------------------------------------------------------------
/ui/packaging/nfpm/nfpm.yaml:
--------------------------------------------------------------------------------
1 | name: temboard
2 | arch: amd64
3 | # Accept PEP440
4 | version_schema: none
5 | version: ${VERSION}
6 | release: ${RELEASE}
7 | depends:
8 | - "${PYTHONPKG}"
9 | maintainer: Dalibo Labs
11 |
34 |
35 | {% end %}
36 |
--------------------------------------------------------------------------------
/ui/temboardui/plugins/dashboard/routes.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | from flask import current_app, render_template
4 |
5 | from ...agentclient import TemboardAgentClient
6 | from ...web.flask import instance_routes
7 |
8 | logger = logging.getLogger(__name__)
9 |
10 |
11 | @instance_routes.route("/dashboard")
12 | def dashboard():
13 | current_app.instance.check_active_plugin("dashboard")
14 |
15 | try:
16 | config = current_app.instance.request("/dashboard/config").json()
17 | except TemboardAgentClient.Error as e:
18 | if 404 != e.code:
19 | raise
20 | logger.debug("Fallback dashboard config.")
21 | config = {"history_length": 150, "scheduler_interval": 2}
22 |
23 | history = current_app.instance.request("/dashboard/history").json()
24 |
25 | current_app.instance.fetch_status()
26 | dashboard = history[-1] if history else {}
27 | return render_template(
28 | "dashboard.html",
29 | plugin="dashboard",
30 | config=config,
31 | dashboard=dashboard,
32 | history=history or "",
33 | )
34 |
--------------------------------------------------------------------------------
/ui/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright (c) 2020, Dalibo
2 |
3 | Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.
4 |
5 | IN NO EVENT SHALL DALIBO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF DALIBO HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
6 |
7 | DALIBO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND DALIBO HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
8 |
9 | A modified version of code chunks of PoWA (powa-archivist and powa-web) is embedded in temBoard with copyright (c) Dalibo, The PoWA-team under the terms of the PostgreSQL License.
10 |
--------------------------------------------------------------------------------
/ui/temboardui/model/versions/008_monitoring-archive-wait-lock.sql:
--------------------------------------------------------------------------------
1 | CREATE OR REPLACE FUNCTION monitoring.archive_current_metrics(table_name TEXT, record_type TEXT, query TEXT)
2 | RETURNS TABLE(tblname TEXT, nb_rows INTEGER)
3 | LANGUAGE plpgsql
4 | AS $$
5 | DECLARE
6 | v_table_current TEXT;
7 | v_table_history TEXT;
8 | v_query TEXT;
9 | i INTEGER;
10 | BEGIN
11 | v_table_current := table_name || '_current';
12 | v_table_history := table_name || '_history';
13 | -- Lock _current table to prevent concurrent updates
14 | EXECUTE 'LOCK TABLE ' || v_table_current || ' IN SHARE MODE';
15 | v_query := replace(query, '#history_table#', v_table_history);
16 | v_query := replace(v_query, '#current_table#', v_table_current);
17 | v_query := replace(v_query, '#record_type#', record_type);
18 | -- Move data into _history table
19 | EXECUTE v_query;
20 | GET DIAGNOSTICS i = ROW_COUNT;
21 | -- Truncate _current table
22 | EXECUTE 'TRUNCATE '||v_table_current;
23 | -- Return each history table name and the number of rows inserted
24 | RETURN QUERY SELECT v_table_history, i;
25 | END;
26 | $$;
27 |
--------------------------------------------------------------------------------
/ui/temboardui/plugins/activity/__init__.py:
--------------------------------------------------------------------------------
1 | from flask import current_app, jsonify
2 | from flask import render_template as flask_render_template
3 |
4 | from ...web.flask import instance_proxy, instance_routes
5 |
6 |
7 | class ActivityPlugin:
8 | def __init__(self, app, **kw):
9 | self.app = app
10 |
11 | def load(self):
12 | instance_proxy.generic_proxy("/activity/kill", method="POST")
13 |
14 |
15 | @instance_routes.route("/activity")
16 | def activity():
17 | current_app.instance.check_active_plugin("activity")
18 | current_app.instance.fetch_status()
19 | return flask_render_template("activity.html", plugin="activity")
20 |
21 |
22 | @instance_proxy.route("/activity")
23 | def activity_proxy():
24 | # DEPRECATED: move to new agent endpoints for activity.
25 | return jsonify(
26 | dict(
27 | blocking=current_app.instance.request("/activity/blocking").json(),
28 | running=current_app.instance.request("/activity").json(),
29 | waiting=current_app.instance.request("/activity/waiting").json(),
30 | )
31 | )
32 |
--------------------------------------------------------------------------------
/tests/test_60_alerting.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 |
4 | def test_quick_alerting(browser, browse_alerting):
5 | # Quick smoketest of status page.
6 | browser.select("#checks-container")
7 |
8 |
9 | @pytest.mark.slowmonitoring
10 | def test_alerts(browser, browse_alerting):
11 | checks = [
12 | "btree_bloat",
13 | "cpu_core",
14 | "heap_bloat",
15 | "hitreadratio_db",
16 | "load1",
17 | "memory_usage",
18 | "rollback_db",
19 | "sessions_usage",
20 | "temp_files_size_delta",
21 | "waiting_sessions_db",
22 | "wal_files_archive",
23 | "wal_files_total",
24 | ]
25 |
26 | wanted = {"text-success", "text-bg-warning", "text-bg-critical"}
27 |
28 | for check in checks:
29 | el = browser.refresh_until(f"#status-{check} .badge")
30 | classes = set(el.get_attribute("class").split())
31 | assert wanted & classes
32 |
33 |
34 | @pytest.fixture
35 | def browse_alerting(browse_instance, browser):
36 | """Go to Monitoring tab of current instance."""
37 | browser.select("div.sidebar a.alerting").click()
38 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/maintenance/schema.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Maintenance / {{database}} / {{schema}}{% endblock %}
4 |
5 | {% block head %}
6 | {% for link in vitejs.css_links_for('maintenance.schema.js') %}{{ link | safe }}{% endfor %}
7 | {% endblock %}
8 |
9 | {% block content %}
10 |
11 | {% include "maintenance/breadcrumb.html" %}
12 |
13 |
12 |
33 |
13 |
14 |
15 |
31 |
32 | | Date | 17 |Username | 18 |Content | 19 |
|---|---|---|
| {{notification['date']}} | 25 |{{notification['username']}} | 26 |{{notification['message']}} | 27 |
14 |
26 |
27 |
28 | {% endblock %}
29 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Python runtime files
2 | *.egg-info/
3 | *.pyc
4 | .venv/
5 |
6 | dev/downloads/
7 | dev/bin/prometheus
8 | dev/bin/promtool
9 |
10 | # Buildtime files
11 | agent/temboardagent/_vendor/
12 | ui/temboardui/_vendor/
13 | build/
14 | dist/
15 |
16 | # ViteJS assets
17 | ui/temboardui/static/*.css
18 | ui/temboardui/static/css/
19 | ui/temboardui/static/images/
20 | ui/temboardui/static/*.js
21 | ui/temboardui/static/js/
22 | ui/temboardui/static/fontawesome-webfont*
23 | ui/temboardui/static/manifest.json
24 | ui/temboardui/static/.vite/
25 |
26 | # From dev compose project
27 | .env
28 | dev/agent-bash_history
29 | dev/agent-psql_history
30 | dev/pip-cache
31 | dev/prometheus/targets/*.yaml
32 |
33 | # Test runtime files
34 | # from pytest-log
35 | test_log.log
36 | tests/downloads/
37 | tests/logs/
38 | tests/screenshots/
39 | tests/workdir/
40 | tests/results.xml
41 |
42 | # Nodejs buildtime files
43 | node_modules/
44 |
45 | # temBoard runtime files
46 | dev/temboard/
47 |
48 | # Help developer customize their development environment
49 | docker-compose.override.yml
50 | temboard.conf.d/
51 | *.log
52 | dev/prometheus/import/*.txt
53 |
--------------------------------------------------------------------------------
/agent/temboardagent/cli/serve.py:
--------------------------------------------------------------------------------
1 | import logging
2 | import os
3 |
4 | from temboardtoolkit import services
5 | from temboardtoolkit.app import SubCommand
6 |
7 | from ..plugins.monitoring import db
8 | from .app import app
9 |
10 | logger = logging.getLogger(__name__)
11 |
12 |
13 | @app.command
14 | class Serve(SubCommand):
15 | """Combined web and worker services."""
16 |
17 | is_service = True
18 |
19 | def main(self, args):
20 | # Purge all legacy data queues
21 | home = self.app.config.temboard.home
22 | if os.path.exists(home):
23 | [
24 | os.remove(os.path.join(home, f))
25 | for f in os.listdir(home)
26 | if f.endswith(".q")
27 | ]
28 |
29 | if "monitoring" in self.app.config.temboard.plugins:
30 | logger.info("Resetting monitoring data.")
31 | db.bootstrap(self.app.config.temboard.home, "monitoring.db")
32 |
33 | self.app.config.load_signing_key()
34 | self.app.discover.refresh()
35 | self.app.discover.write()
36 |
37 | return services.run(self.app.httpd, self.app.scheduler, self.app.worker_pool)
38 |
--------------------------------------------------------------------------------
/ui/temboardui/handlers/settings/metadata.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | from temboardui.web.tornado import admin_required, app, render_template
4 |
5 | from ...version import inspect_versions
6 |
7 | logger = logging.getLogger(__name__)
8 |
9 |
10 | @app.route(r"/settings/metadata")
11 | @admin_required
12 | def metadata(request):
13 | versions_info = inspect_versions()
14 | infos = {
15 | "Version": "%(temboard)s (%(temboardbin)s)" % versions_info,
16 | "Uptime": app.start_time,
17 | "OS": "%(distname)s %(distversion)s" % versions_info,
18 | "Python": "%(python)s (%(pythonbin)s)" % versions_info,
19 | "cryptography": "%(cryptography)s" % versions_info,
20 | "Tornado": "%(tornado)s" % versions_info,
21 | "libpq": "%(libpq)s" % versions_info,
22 | "psycopg2": "%(psycopg2)s" % versions_info,
23 | "SQLAlchemy": "%(sqlalchemy)s" % versions_info,
24 | }
25 | temboard_version = "%(temboard)s" % versions_info
26 |
27 | return render_template(
28 | "settings/metadata.html",
29 | role=request.current_user,
30 | infos=infos,
31 | temboard_version=temboard_version,
32 | )
33 |
--------------------------------------------------------------------------------
/agent/temboardagent/queries/activity-sessions.sql:
--------------------------------------------------------------------------------
1 | WITH blockages AS (
2 | SELECT
3 | pid AS waiting_pid,
4 | -- Requires pg_blocking_pids from PostgreSQL 9.6+
5 | unnest(pg_blocking_pids(pid)) AS blocking_pid
6 | FROM pg_stat_activity
7 | )
8 | SELECT
9 | sessions.pid AS pid,
10 | sessions.client_addr AS client_addr,
11 | sessions.usename AS "username",
12 | sessions.application_name AS application_name,
13 | sessions.datname AS database,
14 | sessions."state" AS "state",
15 | sessions.backend_start AS backend_start,
16 | sessions.query_start AS query_start,
17 | round(EXTRACT(epoch FROM (NOW() - sessions.query_start))::numeric, 2)::FLOAT AS duration,
18 | sessions.query AS query,
19 | waiting.waiting_pid IS NOT NULL AS waiting,
20 | blocking.blocking_pid IS NOT NULL AS blocking
21 | FROM pg_catalog.pg_stat_activity AS sessions
22 | LEFT OUTER JOIN blockages AS waiting ON waiting.waiting_pid = pid
23 | LEFT OUTER JOIN blockages AS blocking ON blocking.blocking_pid = pid
24 | WHERE sessions.pid <> pg_backend_pid()
25 | AND sessions.backend_type = 'client backend' -- pragma:pg_version_min 100000
26 | ORDER BY EXTRACT(epoch FROM (NOW() - sessions.query_start)) DESC
27 |
--------------------------------------------------------------------------------
/docs/postgres_upgrade.md:
--------------------------------------------------------------------------------
1 | This section explains how to upgrade a PostgreSQL instance monitored by a temBoard agent.
2 |
3 | To upgrade to PostgreSQL instance hosting the *repository* database,
4 | please go to the [Server Upgrade] section.
5 |
6 | [Server Upgrade]: server_upgrade.md
7 |
8 |
9 | ## Minor Upgrade
10 |
11 | PostgreSQL minor upgrades (e.g. from `10.3` to `10.4`) are very important
12 | but they include only backward-compatible changes.
13 |
14 | Therefore, you can simply upgrade your instance using the usual update process,
15 | depending on which distribution you are using.
16 |
17 | You dont need to restart temBoard agent nor edit its configuration.
18 |
19 |
20 | ## Major Upgrade
21 |
22 | PostgreSQL major upgrades (e.g. from 13 to 14) will bring new features and improvements.
23 |
24 | If you choose to migrate your data from your current instance to a new one listening to another port (or on another host),
25 | then you can simply add a temboard-agent to this new instance.
26 | However you will lose the history of the former one.
27 |
28 | If you choose the *in-place upgrade*, you can keep the same agent.
29 | You don't need to restart agent nor edit its configuration.
30 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/maintenance/table.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Maintenance / {{database}} / {{schema}} / {{table}}{% endblock %}
4 |
5 | {% block head %}
6 | {% for link in vitejs.css_links_for('maintenance.table.js') %}{{ link | safe }}{% endfor %}
7 | {% endblock %}
8 |
9 | {% block content %}
10 |
11 | {% include "maintenance/breadcrumb.html" %}
12 |
13 |
14 |
27 |
28 |
29 | {% endblock %}
30 |
--------------------------------------------------------------------------------
/ui/share/temboard_CHANGEME.pem:
--------------------------------------------------------------------------------
1 | -----BEGIN CERTIFICATE-----
2 | MIIDETCCAfkCFCfsZSk1gg872dzAFpy/8yk3B2GCMA0GCSqGSIb3DQEBCwUAMEUx
3 | CzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRl
4 | cm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMjIwNDI2MTcwNzI3WhcNMjUwNDI1MTcw
5 | NzI3WjBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UE
6 | CgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOC
7 | AQ8AMIIBCgKCAQEAsJYf3R8GOrtF0wn6cxLn4OxnClccKzvVV25zQIR+QM0SeIFk
8 | lxs7zxc5bT2TsVmr2dGnHhqrgueQL/UFfwovZUpkktZnUaNm6El2XSSIQJ+X0m6i
9 | 8K6NKn7Yjgqkj36tMyMNerGcXjfA9+QfXjnkTIXty19GqYtzslYFZRWXDfoKLhQf
10 | qjRdIMPsxeXzrROYfAuT1dxBULfLH+oa2RWL/gaVt+L7+ld06r/a6dFGCuHebbTN
11 | FaqqdmMwnMBCqYkrgPPhsysJF07ENGBIeFzYX54gOtpG+Ya5ayWvQsQLSlGlhYkC
12 | tNqFcxT5jtWvXHVDSkaQ4g8F+2SJApUeQNqHHQIDAQABMA0GCSqGSIb3DQEBCwUA
13 | A4IBAQBhT5DnbJFDrt9fCP3bZbD3X9iAv3YA8dEp46BfyTd4jh8HALiHttmUEjG+
14 | ImB7y/U/84vrMRgdAfVpkogMIO9fHG9joLQxuCtKkeikKI5BBw+BM5wZyC8m3bpW
15 | 9wvAsle5Suc0scx6Mpwiu5/n+nYEj25UE8vkCZ7R/wRH1/xLfk1tWFYhyvz/exUm
16 | KmcdbUWxSkxrWCEeHHTIwSlf/yty5VNz4OzzSy2919kkcs9iB5vjgKp0zbC7SDXA
17 | Inm78yDQpcZXfhnt7cRTu2d4Vm+wsdpOX5nf7qBuGAT/VvqJg9qaLqNVqNNtcj/x
18 | e8dTtauaSnZ4MvZvU8rwFZ4ATsTA
19 | -----END CERTIFICATE-----
20 |
--------------------------------------------------------------------------------
/agent/share/temboard-agent_CHANGEME.pem:
--------------------------------------------------------------------------------
1 | -----BEGIN CERTIFICATE-----
2 | MIIDETCCAfkCFGOIzLQKtvCulsO6905Nd3d95aOOMA0GCSqGSIb3DQEBCwUAMEUx
3 | CzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRl
4 | cm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMjIwNDI2MTcwNzI3WhcNMjUwNDI1MTcw
5 | NzI3WjBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UE
6 | CgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOC
7 | AQ8AMIIBCgKCAQEA0HwkI8cz7KnBf+2arktqO3TvaVi8+307rJGkkfmeDZYnjuWv
8 | BiQSF7N97thMPLaB7W2J2nzrIJCKTTtnagqVOn/TLOboSxDAzMWaJh9jfXqOwgX1
9 | e4khjw7gXemOQR/tCPVX00fIorKtX0vqS1oBDlbpW/Yxxu2gI/Lwld+787957iy5
10 | uZq8kIqa19tOW+0Kp8288nQbqnCrzb3yOFS57T6UdRHqtwY12vuZV/orjwL6ToVR
11 | zJXGt9Nqqa6dU4toXCEan3AcOQQ8oYmRaNaW0HzZI+jXJs8Y+GS+K1FtFibA2eYU
12 | Rql2DpiHcsg+l6UKQwM340nVGJLbMF6ZbJWrrwIDAQABMA0GCSqGSIb3DQEBCwUA
13 | A4IBAQBu7zj8LR/XMMS+pI/fbDxd5BkXTwAOZ12aDfA+UpEHv6+94+NhFy6XCTKX
14 | JJDYavNdijTtTZjmjdfq6Ryza2R2xhj7DZmgi8COg31foRU+TE6/th4EUxb8bQwg
15 | E/tvMAhNF55RZitIOyFSkylXAK4sT0XqbGlRTo343ME/YzSTqtCMv28iUhLHuDRn
16 | KZCS+6dk930dnCuUvT2gnsd6+MgS61jhgYIYLeyhO6MdDs4VFiH8z0mdudPbcTru
17 | YuEjVwTw9g/3dAuq59oJduRn1l7RLCSMG7ylpQotnjpD+gwDMM4+sQzbvdX4/VP7
18 | ukZMXodW9KeqWGMbUAdBnO99+/qm
19 | -----END CERTIFICATE-----
20 |
--------------------------------------------------------------------------------
/docs/compatibility_guide.md:
--------------------------------------------------------------------------------
1 | temBoard is designed to interact with many components: systemd, PostgreSQL,
2 | agents, etc.
3 |
4 | As we are trying to find the right balance between innovation and backward
5 | compatibility, we define a comprehensive list of platforms and software that
6 | we support for each version.
7 |
8 | Temboard 10 is the current release.
9 |
10 | Each minor release (e.g. `10.1`, `10.2`, etc.) is compatible with the following
11 | components:
12 |
13 | | | |
14 | | -------------- | -------------------------------------------|
15 | | Linux | Debian 12 and 13, Ubuntu 22.04 and 24.04, RHEL 8, 9 and 10 |
16 | | Python | 3.9+ |
17 | | Postgres | 13 to 18 |
18 | | Temboard Agent | 9.x and 10.x |
19 |
20 | Additional notes:
21 |
22 | * On RHEL8, the default python version is 3.6. Be sure to install `python39`.
23 | * RHEL7 et Debian 11 (bullseye) are unsupported
24 | * All PostgreSQL versions below 13.x are obsolete and unsupported
25 | * It is highly recommended to upgrade PostgreSQL to the latest minor version of your
26 | current major version
27 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/settings.notifications.js:
--------------------------------------------------------------------------------
1 | import $ from "jquery";
2 |
3 | $("#sendEmailForm").on("submit", function (e) {
4 | e.preventDefault();
5 | sendEmail();
6 | });
7 |
8 | $("#sendSmsForm").on("submit", function (e) {
9 | e.preventDefault();
10 | sendSms();
11 | });
12 |
13 | function sendEmail() {
14 | clearError();
15 | $.ajax({
16 | url: "/json/test_email",
17 | type: "post",
18 | contentType: "application/json",
19 | data: JSON.stringify({
20 | email: $("#inputTestEmail").val(),
21 | }),
22 | success: function (data) {
23 | var msg = "Test email successfully sent";
24 | msg += "\nIf the email is not received, please have a look at your SMTP server logs";
25 | alert(msg);
26 | },
27 | error: function (xhr) {
28 | console.log("error", xhr);
29 | showError(xhr);
30 | },
31 | });
32 | }
33 |
34 | function sendSms() {
35 | clearError();
36 | $.ajax({
37 | url: "/json/test_sms",
38 | type: "post",
39 | contentType: "application/json",
40 | data: JSON.stringify({
41 | phone: $("#inputTestPhone").val(),
42 | }),
43 | success: function (data) {
44 | alert("Test SMS sent");
45 | },
46 | error: showError,
47 | });
48 | }
49 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/utils/duration.js:
--------------------------------------------------------------------------------
1 | import _ from "lodash";
2 |
3 | const durationSecond = 1000;
4 | const durationMinute = durationSecond * 60;
5 | const durationHour = durationMinute * 60;
6 | const durationDay = durationHour * 24;
7 |
8 | function formatDuration(ms, rounded) {
9 | let results = [];
10 | const µs = Math.round((ms - Math.floor(ms)) * 1000);
11 | ms = Math.floor(ms);
12 | const d = Math.trunc(ms / durationDay);
13 | results.push(d + " d");
14 | ms = ms - d * durationDay;
15 | const h = Math.trunc(ms / durationHour);
16 | results.push(h + " h");
17 | ms = ms - h * durationHour;
18 | const m = Math.trunc(ms / durationMinute);
19 | results.push(m + " min");
20 | ms = ms - m * durationMinute;
21 | const s = Math.trunc(ms / durationSecond);
22 | results.push(s + " s");
23 | ms = ms - s * durationSecond;
24 | results.push(ms + " ms");
25 | results.push(µs + " µs");
26 |
27 | results = _.dropWhile(results, (o) => parseInt(o) == 0);
28 |
29 | if (rounded) {
30 | // Only keep the first or two firsts values
31 | const n = parseInt(results[0]) < 3 && parseInt(results[1]) !== 0 ? 2 : 1;
32 | results = results.slice(0, n);
33 | }
34 | return results.length ? results.join(" ") : "0 ms";
35 | }
36 |
37 | export { formatDuration };
38 |
--------------------------------------------------------------------------------
/dev/grafana/rootfs/etc/grafana/provisioning/datasources/prometheus.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: 1
2 |
3 | datasources:
4 | - "uid": "01lWBBhnk"
5 | "orgId": 1
6 | "name": "Prometheus"
7 | "type": "prometheus"
8 | "typeName": "Prometheus"
9 | "typeLogoUrl": "public/app/plugins/datasource/prometheus/img/prometheus_logo.svg"
10 | "access": "proxy"
11 | "url": "http://prometheus:9090/"
12 | "password": ""
13 | "user": ""
14 | "database": ""
15 | "basicAuth": false
16 | "isDefault": true
17 | "jsonData":
18 | "httpMethod": "POST"
19 | "timeInterval": "60s"
20 | "readOnly": false
21 |
22 | - "uid": "Kme6NfMSz"
23 | "orgId": 1
24 | "name": "temBoard prometheus"
25 | "type": "prometheus"
26 | "typeName": "Prometheus"
27 | "typeLogoUrl": "public/app/plugins/datasource/prometheus/img/prometheus_logo.svg"
28 | "access": "proxy"
29 | # This IP is the default docker0 host IP.
30 | # Binding to 0.0.0.0 on docker host exposes to container through this IP at least.
31 | # You may need to update if docker0 host IP is different.
32 | # And then recreate Grafana container.
33 | "url": "http://172.17.0.1:8890/"
34 | "user": ""
35 | "database": ""
36 | "basicAuth": false
37 | "isDefault": false
38 | "jsonData":
39 | "httpMethod": "POST"
40 | "readOnly": false
41 |
--------------------------------------------------------------------------------
/ui/temboardui/static/src/components/ModalDialog.vue:
--------------------------------------------------------------------------------
1 |
32 |
33 |
34 |
46 |
47 |
--------------------------------------------------------------------------------
/ui/share/temboard_ca_certs_CHANGEME.pem:
--------------------------------------------------------------------------------
1 | -----BEGIN CERTIFICATE-----
2 | MIIDXTCCAkWgAwIBAgIJALXncntr5W52MA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV
3 | BAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBX
4 | aWRnaXRzIFB0eSBMdGQwHhcNMTgxMDIzMDk0MzA3WhcNMjExMDIyMDk0MzA3WjBF
5 | MQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50
6 | ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
7 | CgKCAQEAsJYf3R8GOrtF0wn6cxLn4OxnClccKzvVV25zQIR+QM0SeIFklxs7zxc5
8 | bT2TsVmr2dGnHhqrgueQL/UFfwovZUpkktZnUaNm6El2XSSIQJ+X0m6i8K6NKn7Y
9 | jgqkj36tMyMNerGcXjfA9+QfXjnkTIXty19GqYtzslYFZRWXDfoKLhQfqjRdIMPs
10 | xeXzrROYfAuT1dxBULfLH+oa2RWL/gaVt+L7+ld06r/a6dFGCuHebbTNFaqqdmMw
11 | nMBCqYkrgPPhsysJF07ENGBIeFzYX54gOtpG+Ya5ayWvQsQLSlGlhYkCtNqFcxT5
12 | jtWvXHVDSkaQ4g8F+2SJApUeQNqHHQIDAQABo1AwTjAdBgNVHQ4EFgQUtlIGs0QI
13 | XlQtg7bkbzBH35j57howHwYDVR0jBBgwFoAUtlIGs0QIXlQtg7bkbzBH35j57how
14 | DAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAgxWfdbITjrWOMJEzhY3q
15 | KKz+B/N4QjUq9hpceQtmyT21ntbqkto1yaeksws9Z/81JBYkowW5U6J6DzOziIpI
16 | PptEz845AKa8rljPv7o8Tu/Z+9MdP4Pdl3eVayMIF/WR7drR6vCIRycw25yiY0UT
17 | RvgsGcW6Tf7sz8LWGzlvwcgATXLu5hwGC0iEWRfGESd0wsMEu0FcGDnJceScOVBu
18 | ssp2k7K4g1V+bHEQftTlQ/wYfFgy/o4BoVV0rQx4jlSq9hTx9nTQcbBLtw9stHkr
19 | gNoaIx+Fdqm/OT/h1WDmJkb/grd75uMTZKhJKKMxcvYxtYxpdtWTDSoPqgnVXFBc
20 | hQ==
21 | -----END CERTIFICATE-----
22 |
--------------------------------------------------------------------------------
/agent/share/temboard-agent_ca_certs_CHANGEME.pem:
--------------------------------------------------------------------------------
1 | -----BEGIN CERTIFICATE-----
2 | MIIDYDCCAkigAwIBAgIJALYNYoXM3oe6MA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV
3 | BAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBX
4 | aWRnaXRzIFB0eSBMdGQwHhcNMTgwNjI2MTQzNzA1WhcNMjEwNjI1MTQzNzA1WjBF
5 | MQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50
6 | ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
7 | CgKCAQEA0HwkI8cz7KnBf+2arktqO3TvaVi8+307rJGkkfmeDZYnjuWvBiQSF7N9
8 | 7thMPLaB7W2J2nzrIJCKTTtnagqVOn/TLOboSxDAzMWaJh9jfXqOwgX1e4khjw7g
9 | XemOQR/tCPVX00fIorKtX0vqS1oBDlbpW/Yxxu2gI/Lwld+787957iy5uZq8kIqa
10 | 19tOW+0Kp8288nQbqnCrzb3yOFS57T6UdRHqtwY12vuZV/orjwL6ToVRzJXGt9Nq
11 | qa6dU4toXCEan3AcOQQ8oYmRaNaW0HzZI+jXJs8Y+GS+K1FtFibA2eYURql2DpiH
12 | csg+l6UKQwM340nVGJLbMF6ZbJWrrwIDAQABo1MwUTAdBgNVHQ4EFgQUN/ZOXDwy
13 | QBxz7r5DQGjOUAxFFGIwHwYDVR0jBBgwFoAUN/ZOXDwyQBxz7r5DQGjOUAxFFGIw
14 | DwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAXOoFGi8FpSyXQkwx
15 | VZ6rSQRk8dCorwP3STQsw9p+pXU543y+uZgm1MRJa7LrVAn/5dkBMlEk8LGUzIZt
16 | ScQHWgRn3AtiR5Fz3EOsT24+/JyBqVmIz6WbeeyXAsmoNY3aU5RiRudOGplUubz2
17 | c+pbQCaLsj47Xgu2bgIsJsDzOEy9E5AXcfukBSJIZEO2SzeNGRtSRQpe0pHp5VC1
18 | bj14HVlAD73xarRwatByMj9Nd2PLBVYZcXCWbBYnELG3NBvXzptaK2yCeB8l7H37
19 | V3rS0q+gSDcJMxyFyG4jVCcI/AeUHndxRozDgLWE6y2nxSHHQpcZ7fy24IZfTKMc
20 | DmdQAw==
21 | -----END CERTIFICATE-----
22 |
--------------------------------------------------------------------------------
/ui/temboardui/plugins/monitoring/pivot.py:
--------------------------------------------------------------------------------
1 | import csv
2 | import operator
3 |
4 |
5 | def get_csv_data(fd):
6 | # CSV parser as generator
7 | yield from csv.DictReader(fd)
8 |
9 |
10 | def pivot_timeserie(fd, index, key, value, output):
11 | # Simple pivot table implementation.
12 | # Beware, input data *MUST* be ordered by index value.
13 | fd.seek(0)
14 | keys = {}
15 | p = 1
16 | # We need to get the keys first
17 | for r in get_csv_data(fd):
18 | if r[key] not in keys:
19 | keys[r[key]] = p
20 | p += 1
21 | sk = sorted(list(keys.items()), key=operator.itemgetter(1))
22 | # CSV Header
23 | line = [index] + [x[0] for x in sk]
24 | p_index = ""
25 | fd.seek(0)
26 | for r in get_csv_data(fd):
27 | if r[index] != p_index:
28 | # As data are ordered if we meet a new index value then the current
29 | # line is complete.
30 | output.write(",".join(line) + "\n")
31 | # And start a new line
32 | line = [""] * (len(keys) + 1)
33 | line[0] = r[index]
34 | # Append value to the current line
35 | line[keys[r[key]]] = r[value]
36 | # Keep a track of the index value
37 | p_index = r[index]
38 | # Write the last line
39 | output.write(",".join(line) + "\n")
40 |
--------------------------------------------------------------------------------
/agent/temboardagent/command.py:
--------------------------------------------------------------------------------
1 | import errno
2 | from shlex import split as shlex_split
3 | from subprocess import PIPE, CalledProcessError, Popen, check_call
4 |
5 |
6 | def exec_command(command_args, **kwargs):
7 | """
8 | Execute a system command with Popen.
9 | """
10 | kwargs.setdefault("stdout", PIPE)
11 | kwargs.setdefault("stderr", PIPE)
12 | kwargs.setdefault("stdin", PIPE)
13 | kwargs.setdefault("close_fds", True)
14 | try:
15 | process = Popen(command_args, **kwargs)
16 | except OSError as err:
17 | return (err.errno, None, err.strerror)
18 |
19 | (stdout, stderrout) = process.communicate()
20 |
21 | return (process.returncode, stdout, stderrout)
22 |
23 |
24 | def exec_script(script_args, **kwargs):
25 | """
26 | Execute an external script.
27 | """
28 | kwargs.setdefault("stderr", PIPE)
29 | kwargs.setdefault("stdout", PIPE)
30 | try:
31 | check_call(script_args, **kwargs)
32 | except CalledProcessError as err:
33 | return (err.returncode, None, err.output)
34 | except OSError as err:
35 | if err.errno == errno.EPIPE:
36 | pass
37 |
38 | return (0, None, None)
39 |
40 |
41 | def oneline_cmd_to_array(command_line):
42 | """
43 | Split a command line using shlex module.
44 | """
45 | return shlex_split(command_line)
46 |
--------------------------------------------------------------------------------
/agent/pyproject.toml:
--------------------------------------------------------------------------------
1 | [project]
2 | name = "temboard-agent"
3 | version = "10.0.0"
4 | description = "PostgreSQL Remote Control Agent"
5 | readme = "README.md"
6 | requires-python = ">=3.9,<3.14"
7 | license = "PostgreSQL"
8 | authors = [
9 | {name = "Dalibo", email = "contact@dalibo.com"},
10 | ]
11 | classifiers = ["Private :: Do Not Upload"]
12 | dependencies = [
13 | "cryptography",
14 | ]
15 |
16 | [project.urls]
17 | Homepage = "https://labs.dalibo.com/temboard"
18 | Documentation = "https://temboard.readthedocs.io"
19 | Repository = "https://github.com/dalibo/temboard"
20 | Changelog = "https://github.com/dalibo/temboard/blob/master/CHANGELOG.md"
21 |
22 | [project.scripts]
23 | temboard-agent = "temboardagent.__main__:main"
24 |
25 | [project.entry-points."temboardagent.plugins"]
26 | activity = "temboardagent.plugins.activity:ActivityPlugin"
27 | dashboard = "temboardagent.plugins.dashboard:DashboardPlugin"
28 | maintenance = "temboardagent.plugins.maintenance:MaintenancePlugin"
29 | monitoring = "temboardagent.plugins.monitoring:MonitoringPlugin"
30 | pgconf = "temboardagent.plugins.pgconf:PgConfPlugin"
31 | statements = "temboardagent.plugins.statements:StatementsPlugin"
32 |
33 | [build-system]
34 | requires = ["uv_build>=0.9.10,<0.10.0"]
35 | build-backend = "uv_build"
36 |
37 | [tool.uv.build-backend]
38 | module-name = "temboardagent"
39 | module-root = ""
40 |
--------------------------------------------------------------------------------
/agent/temboardagent/cli/tasks.py:
--------------------------------------------------------------------------------
1 | # Note that our home-made background task implementation uses a different
2 | # semantic that state of the art background task implemtation:
3 | #
4 | # a task function is called a worker
5 | # a worker process is called workerpool
6 | # a message is called a task
7 | # the message broker is called taskmanager
8 | #
9 |
10 | import logging.config
11 |
12 | from temboardtoolkit.app import SubCommand
13 | from temboardtoolkit.errors import UserError
14 | from temboardtoolkit.taskmanager import FlushTasksMixin, RunTaskMixin
15 |
16 | from .app import app
17 |
18 | logger = logging.getLogger(__name__)
19 |
20 |
21 | @app.command
22 | class Tasks(SubCommand):
23 | """Manage background tasks."""
24 |
25 | def main(self, args):
26 | raise UserError("Missing sub-command. See --help for details.")
27 |
28 |
29 | @Tasks.command
30 | class Flush(FlushTasksMixin, SubCommand):
31 | """Flush all tasks."""
32 |
33 |
34 | @Tasks.command
35 | class Run(RunTaskMixin, SubCommand):
36 | """Run a task foreground."""
37 |
38 | def main(self, args):
39 | workers = self.iter_workers()
40 |
41 | if "?" == args.worker_name:
42 | self.print_workers(workers)
43 | else:
44 | worker, worker_args = self.compute_worker_args(workers, args)
45 | worker(*worker_args)
46 | return 0
47 |
--------------------------------------------------------------------------------
/ui/temboardui/templates/flask/login.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{ super() }}/ Login{% endblock %}
4 |
5 | {% block content %}
6 |
7 |
31 |
32 | {% endblock %}
33 |
--------------------------------------------------------------------------------
/ui/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "temboard",
3 | "private": true,
4 | "type": "module",
5 | "engines": {
6 | "node": ">=20.0.0"
7 | },
8 | "scripts": {
9 | "dev": "vite",
10 | "build": "vite build",
11 | "install-husky": "cd .. && husky install ui/.husky"
12 | },
13 | "dependencies": {
14 | "@fortawesome/fontawesome-free": "^7.1.0",
15 | "@vueuse/components": "^10.11.0",
16 | "@vueuse/core": "^10.9.0",
17 | "bootstrap": "^5.3.3",
18 | "bootstrap-vue-next": "^0.16.6",
19 | "datatables.net-bs5": "^2.0.8",
20 | "datatables.net-buttons-bs5": "^3.0.2",
21 | "datatables.net-vue3": "^3.0.1",
22 | "daterangepicker": "^2.1.27",
23 | "dygraphs": "^2.2.1",
24 | "filesize": "^10.1.2",
25 | "highlight.js": "^11.9.0",
26 | "jquery": "^3.7.1",
27 | "lodash": "^4.17.21",
28 | "moment": "^2.30.1",
29 | "pev2": "^1.12.1",
30 | "vue": "^3.4.21",
31 | "vue-multiselect": "^3.0.0",
32 | "vue-router": "^4.4.0"
33 | },
34 | "devDependencies": {
35 | "@trivago/prettier-plugin-sort-imports": "^4.3.0",
36 | "@vitejs/plugin-vue": "^5.0.5",
37 | "autoprefixer": "^10.4.19",
38 | "husky": "^8.0.3",
39 | "lint-staged": "^14.0.1",
40 | "postcss": "^8.4.38",
41 | "prettier": "3.3.3",
42 | "prettier-plugin-jinja-template": "1.4.1",
43 | "sass": "^1.77.6",
44 | "vite": "^5.3.1"
45 | },
46 | "lint-staged": {
47 | "*.{js,css,vue}": "prettier --write"
48 | }
49 | }
50 |
--------------------------------------------------------------------------------
/toolkit/tests/test_versions.py:
--------------------------------------------------------------------------------
1 | import sys
2 | from textwrap import dedent
3 |
4 |
5 | def test_os_release():
6 | from temboardtoolkit.versions import parse_lsb_release
7 |
8 | distinfos = parse_lsb_release(
9 | dedent("""\
10 | PRETTY_NAME="Debian GNU/Linux 10 (buster)"
11 | NAME="Debian GNU/Linux"
12 | VERSION_ID="10"
13 | VERSION="10 (buster)"
14 | VERSION_CODENAME=buster
15 | ID=debian
16 | HOME_URL="https://www.debian.org/"
17 | SUPPORT_URL="https://www.debian.org/support"
18 | BUG_REPORT_URL="https://bugs.debian.org/"
19 | """).splitlines(True)
20 | )
21 |
22 | assert "10" == distinfos["VERSION_ID"]
23 | assert "10 (buster)" == distinfos["VERSION"]
24 |
25 |
26 | def test_format_pq_version():
27 | from temboardtoolkit.versions import format_pq_version
28 |
29 | assert "14.1" == format_pq_version(140001)
30 | assert "13.5" == format_pq_version(130005)
31 | assert "12.9" == format_pq_version(120009)
32 | assert "11.14" == format_pq_version(110014)
33 | assert "10.19" == format_pq_version(100019)
34 | assert "9.6.24" == format_pq_version(90624)
35 |
36 |
37 | def test_read_libpq_version_from_ctypes(mocker):
38 | __import__("psycopg2.extensions")
39 | # Remove __libpq_version__ if any.
40 | mocker.patch.dict(sys.modules, [("psycopg2.extensions", object())])
41 |
42 | from temboardtoolkit.versions import read_libpq_version
43 |
44 | assert read_libpq_version() > 90000
45 |
--------------------------------------------------------------------------------
/tests/pytest-ci:
--------------------------------------------------------------------------------
1 | #!/bin/bash -eu
2 | #
3 | # Wrapper around pytest to configure marker expr from git diff.
4 | #
5 |
6 | main() {
7 | upstream="$1"; shift
8 | marker_expr=()
9 |
10 | if [ "$CIRCLE_BRANCH" = "$upstream" ] ; then
11 | log "Run all tests on $upstream."
12 | else
13 | if ! git diff --name-only "origin/$upstream"..HEAD | grep -f tests/monitoring-files ; then
14 | log "Skipping slow monitoring tests."
15 | marker_expr+=("not slowmonitoring")
16 | fi
17 |
18 | if ! git diff --name-only "origin/$upstream"..HEAD | grep -f tests/statements-files ; then
19 | log "Skipping slow statements tests."
20 | marker_expr+=("not slowstatements")
21 | fi
22 |
23 | if [ "${#marker_expr[@]}" -eq 0 ] ; then
24 | log "Running all test for modifications."
25 | fi
26 | fi
27 |
28 | marker_expr_s="$(join_array " and " "${marker_expr[@]-}")"
29 |
30 | if [ "${marker_expr_s}" ] ; then
31 | set -- "-m" "$marker_expr_s" "$@"
32 | fi
33 |
34 | args=("$@") # Hack for CentOS 7 bash.
35 | log "Running pytest" "${args[@]@Q}"
36 |
37 | exec pytest "$@"
38 | }
39 |
40 |
41 | log() {
42 | echo "$*" >&2
43 | }
44 |
45 |
46 | # From https://stackoverflow.com/questions/1527049/how-can-i-join-elements-of-an-array-in-bash
47 | join_array() {
48 | local d="${1-}" f="${2-}"
49 | if shift 2; then
50 | printf %s "$f" "${@/#/$d}"
51 | fi
52 | }
53 |
54 |
55 | main "$@"
56 |
--------------------------------------------------------------------------------
/ui/temboardui/plugins/maintenance/routes.py:
--------------------------------------------------------------------------------
1 | from flask import current_app, render_template
2 |
3 | from ...web.flask import instance_routes
4 |
5 | PLUGIN_NAME = "maintenance"
6 |
7 |
8 | @instance_routes.route("/maintenance")
9 | def maintenance():
10 | current_app.instance.check_active_plugin(PLUGIN_NAME)
11 | current_app.instance.fetch_status()
12 | return render_template("maintenance/index.html", plugin=PLUGIN_NAME)
13 |
14 |
15 | @instance_routes.route("/maintenance/
8 |
30 |
9 |
29 |
10 | 
11 |
12 |
11 |
13 |
27 |
28 |