The Firebird exporter for Prometheus is built by a simple script written in Python with the help of script_exporter and filestat_exporter.
The script and Grafana dashboard have been tested with firebird2.5.2, firebird2.5.7, firebird3.0.7 and firebird4.0.4.
- Metrics of database
- Metrics of backup
gbaklogs
- Custom grafana dashboard
├── docker-compose.yml
└── script_exporter
├── scripts
│ ├── dbs.csv
│ └── firebird_exporter.py
├── ...
├── script_exporter.yml
└── Dockerfile
Uses script-exporter built from the source code by enhancing the original Dockerfile. The environment that includes firebird lib is ensured by docker image jacobalberty/firebird:3.0. Script exporting the metrics is written in python and uses firebird-driver installed with pip.
./docker-compose.yml
...
script_exporter:
build:
context: ./script_exporter
dockerfile: Dockerfile
container_name: script_exporter
restart: unless-stopped
volumes:
- ./script_exporter/script_exporter.yaml:/script_exporter.yaml
- ./script_exporter/scripts/:/scripts/:ro
ports:
- 9469:9469
networks:
- default
...
./script_exporter/ (git clone https://github.com/ricoberger/script_exporter)
./script_exporter/Dockerfile
FROM golang:1.22.0-alpine3.18 as build
RUN apk update && apk add git make
RUN mkdir /build
WORKDIR /build
COPY . .
RUN export CGO_ENABLED=0 && make build
FROM jacobalberty/firebird:3.0
COPY --from=build /build/bin/script_exporter /bin/script_exporter
RUN apt-get update && apt-get install -y software-properties-common python3-dev python3-pip
RUN pip install firebird-driver
ENV TINI_VERSION v0.19.0
ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini
RUN chmod +x /tini
EXPOSE 9469
ENTRYPOINT ["/tini", "--"]
CMD ["/bin/script_exporter", "-config.file", "/script_exporter.yaml"]
./script_exporter/script_exporter.yaml
scripts:
- name: firebird
script: python3 scripts/firebird_exporter.py
./script_exporter/scripts/firebird_exporter.py
#!/usr/bin/env python3
__author__ = "Lukáš Drahník"
__credits__ = ["Lukáš Drahník", "Marek Křiklán"]
__license__ = "MIT"
__version__ = "0.0.1"
__maintainer__ = "Lukáš Drahník"
__email__ = "ldrahnik@gmail.com"
__status__ = "Production"
import os
import sys
import subprocess
from firebird.driver import driver_config, connect
__location__ = os.path.realpath(
os.path.join(os.getcwd(), os.path.dirname(__file__)))
prefix = 'fb_'
db_host = ''
db_name = ''
db_user = ''
db_password = ''
db_uni_man_file = 'fb_databases.csv'
def find_db_user_and_pass(db_host_and_name, db_file):
db_user = None
db_pass = None
with open(os.path.join(__location__, db_file)) as f:
k = f.read()
proc_grep = subprocess.run(
['grep', db_host_and_name + ","],
input=k,
stdout=subprocess.PIPE,
encoding='ascii'
)
if proc_grep.returncode == 0:
proc_user = subprocess.run(
['cut', '-f2', '-d', ','],
input=proc_grep.stdout,
stdout=subprocess.PIPE,
encoding='ascii'
)
db_user = proc_user.stdout.strip()
proc_pass = subprocess.run(
['cut', '-f3', '-d', ','],
input=proc_grep.stdout,
stdout=subprocess.PIPE,
encoding='ascii'
)
db_pass = proc_pass.stdout.strip()
return [db_user, db_pass]
if len(sys.argv) > 1:
db_host_and_name = sys.argv[1]
db_host = db_host_and_name.split(':')[0]
db_name = db_host_and_name.split(':')[1]
[db_user, db_password] = find_db_user_and_pass(db_host_and_name, db_uni_man_file)
else:
print("First argument has to be in format <db_host:db_name> (e.g. fbserver.company.com:db_name).")
exit(1)
def escape_label_value(label_value):
return label_value.replace('\r\n', '').replace('\n', '').replace('"', '\\"').replace("'", "\\'")
def print_counter(cursor):
global prefix
for row in cursor.fetchall():
print(prefix + row[0] + str(row[1]))
def print_vector(cursor, value = 1):
global prefix, db_host, db_name
for row in cursor.fetchall():
vector_names_and_values = [field[0].lower() + '="' + escape_label_value(str(row[i])) + '"' for i, field in enumerate(cursor.description) if i > 0 and not field[0].lower().startswith('as_value')]
vector_as_value = [str(row[i]) for i, field in enumerate(cursor.description) if i > 0 and field[0].lower().startswith('as_value')]
if len(vector_as_value):
value = vector_as_value[0]
print(prefix + row[0] + "{" + ','.join(vector_names_and_values) + "} " + str(value))
driver_config.server_defaults.host.value = db_host
#print(db_host, db_name, db_user, db_password) # testing purpose only
try:
with connect(db_name, user=db_user, password=db_password) as con:
cursor = con.cursor()
try:
cursor.execute("""SELECT 'active_transactions' as counter_name, count(*) as cntr_value
FROM MON$TRANSACTIONS
WHERE MON$STATE = 1
UNION
SELECT 'open_connections' as counter_name, count(*) as cntr_value
FROM MON$ATTACHMENTS
UNION
SELECT 'idle_connections' as counter_name, count(*) as cntr_value
FROM MON$ATTACHMENTS
WHERE MON$STATE = 0
UNION
SELECT 'database_state' as counter_name, MON$SHUTDOWN_MODE as cntr_value
FROM MON$DATABASE
UNION
SELECT 'pages_allocated_externally' as counter_name, MON$PAGES as cntr_value
FROM MON$DATABASE
UNION
SELECT 'page_fetches' as counter_name, MON$PAGE_FETCHES as cntr_value
FROM MON$IO_STATS
WHERE MON$STAT_GROUP = 0
UNION
SELECT 'page_writes' as counter_name, MON$PAGE_WRITES as cntr_value
FROM MON$IO_STATS
WHERE MON$STAT_GROUP = 0
UNION
SELECT 'database_memory_used' as counter_name, MON$MEMORY_USED as cntr_value
FROM MON$MEMORY_USAGE
WHERE MON$STAT_GROUP = 0
UNION
SELECT 'database_page_size' as counter_name, MON$PAGE_SIZE as cntr_value
FROM MON$DATABASE
UNION
SELECT 'database_allocated_pages' as counter_name, MON$PAGE_BUFFERS as cntr_value
FROM MON$DATABASE
UNION
SELECT 'stalled_statements' as counter_name, count(*) as cntr_value
FROM MON$STATEMENTS
WHERE MON$STATE = 2
UNION
SELECT 'running_statements' as counter_name, count(*) as cntr_value
FROM MON$STATEMENTS
WHERE MON$STATE = 1 AND MON$ATTACHMENT_ID <> CURRENT_CONNECTION
UNION
SELECT 'oldest_active' as counter_name, MON$OLDEST_ACTIVE as cntr_value
FROM MON$DATABASE
UNION
SELECT 'oldest_snapshot' as counter_name, MON$OLDEST_SNAPSHOT as cntr_value
FROM MON$DATABASE
UNION
SELECT 'next_transaction' as counter_name, MON$NEXT_TRANSACTION as cntr_value
FROM MON$DATABASE
UNION
SELECT 'database_duration_seconds' as counter_name, DATEDIFF(second, MON$CREATION_DATE, current_timestamp) as cntr_value
FROM MON$DATABASE""")
except:
# old fb version without table MON$MEMORY_USAGE
cursor.execute("""SELECT 'active_transactions' as counter_name, count(*) as cntr_value
FROM MON$TRANSACTIONS
WHERE MON$STATE = 1
UNION
SELECT 'open_connections' as counter_name, count(*) as cntr_value
FROM MON$ATTACHMENTS
UNION
SELECT 'idle_connections' as counter_name, count(*) as cntr_value
FROM MON$ATTACHMENTS
WHERE MON$STATE = 0
UNION
SELECT 'database_state' as counter_name, MON$SHUTDOWN_MODE as cntr_value
FROM MON$DATABASE
UNION
SELECT 'pages_allocated_externally' as counter_name, MON$PAGES as cntr_value
FROM MON$DATABASE
UNION
SELECT 'page_fetches' as counter_name, MON$PAGE_FETCHES as cntr_value
FROM MON$IO_STATS
WHERE MON$STAT_GROUP = 0
UNION
SELECT 'page_writes' as counter_name, MON$PAGE_WRITES as cntr_value
FROM MON$IO_STATS
WHERE MON$STAT_GROUP = 0
UNION
SELECT 'database_page_size' as counter_name, MON$PAGE_SIZE as cntr_value
FROM MON$DATABASE
UNION
SELECT 'database_allocated_pages' as counter_name, MON$PAGE_BUFFERS as cntr_value
FROM MON$DATABASE
UNION
SELECT 'stalled_statements' as counter_name, count(*) as cntr_value
FROM MON$STATEMENTS
WHERE MON$STATE = 2
UNION
SELECT 'running_statements' as counter_name, count(*) as cntr_value
FROM MON$STATEMENTS
WHERE MON$STATE = 1 AND MON$ATTACHMENT_ID <> CURRENT_CONNECTION
UNION
SELECT 'oldest_active' as counter_name, MON$OLDEST_ACTIVE as cntr_value
FROM MON$DATABASE
UNION
SELECT 'oldest_snapshot' as counter_name, MON$OLDEST_SNAPSHOT as cntr_value
FROM MON$DATABASE
UNION
SELECT 'next_transaction' as counter_name, MON$NEXT_TRANSACTION as cntr_value
FROM MON$DATABASE
UNION
SELECT 'database_duration_seconds' as counter_name, DATEDIFF(second, MON$CREATION_DATE, current_timestamp) as cntr_value
FROM MON$DATABASE""")
print_counter(cursor)
# vectors
cursor.execute("""SELECT 'transaction_duration_seconds' AS vector_name, mt.MON$TRANSACTION_ID AS transaction_id,CAST(mt.MON$TIMESTAMP as TIMESTAMP) as transaction_timestamp, DATEDIFF(second, mt.MON$TIMESTAMP, current_timestamp) AS as_value, ma.MON$REMOTE_ADDRESS as REMOTE_ADDRESS, ma.MON$REMOTE_PROCESS as PROCESS, s.MON$SQL_TEXT as SQL_TEXT FROM MON$ATTACHMENTS ma JOIN MON$TRANSACTIONS mt ON ma.MON$ATTACHMENT_ID = mt.MON$ATTACHMENT_ID LEFT JOIN MON$STATEMENTS s ON ma.MON$ATTACHMENT_ID = s.MON$ATTACHMENT_ID WHERE ma.MON$STATE = 1 AND ma.MON$ATTACHMENT_ID <> CURRENT_CONNECTION AND DATEDIFF(second, mt.MON$TIMESTAMP, current_timestamp) > 180""")
print("# transactions are displayed only with duration > 3 mins")
print_vector(cursor)
cursor.execute("""SELECT 'info' as vector_name, RDB$GET_CONTEXT('SYSTEM', 'ENGINE_VERSION') as version FROM RDB$DATABASE""")
print_vector(cursor, 0)
except Exception as e:
print(prefix + "info{error=\"" + escape_label_value(str(repr(e))) + "\"} 1")
sys.exit(1)
./script_exporter/scripts/fb_databases.csv
...
# example 1
fbserver.company.com:/data/vol2/data/db_name.gdb,sysdba,pass
# example 2
fbserver.company.com:db_name,sysdba,pass
...
├── filestat.yaml
├── web-config.yml
└── filestat_exporter.exe
filestat.yaml
exporter:
working_directory: "\\\\xyz\\backups\\"
enable_crc32_metric: true
files:
- patterns: ['*.log']
web-config.yml
basic_auth_users:
admin: <bcrypt-hash-of-pass>
prometheus.yml
...
- job_name: filestat_exporter
metrics_path: /metrics
static_configs:
- targets: [ 'xyz:9943' ]
basic_auth:
username: 'admin'
password_file: 'filestat_exporter.password_file'
- job_name: 'script_exporter'
metrics_path: /probe
params:
script: [firebird]
params: [target]
static_configs:
- targets:
- fbserver.company.com:/data/vol2/data/db_name.gdb
- fbserver.company.com:db_name
basic_auth:
username: 'admin'
password_file: 'script_exporter.password_file'
relabel_configs:
- source_labels: [__address__]
target_label: __param_target
- target_label: __address__
replacement: xyz:9469
- source_labels: [__param_target]
target_label: target
- source_labels: [__param_target]
target_label: instance
alert_rules.yml
...
- name: firebird
rules:
- alert: FirebirdDatabaseCreationDateCheck
expr: fb_database_duration_seconds{instance=~"testfb01.*|testfb02.*|dbmirror.*"} > 108000
for: 5m
labels:
severity: critical
annotations:
summary: Firebird database was created at least 30 hours ago (instance {{ $labels.instance }} {{ $value | humanizeDuration }} ago)
description: ""
- alert: FirebirdTooBigNextTransactionId
expr: fb_next_transaction > 2000000000
for: 0m
labels:
severity: critical
annotations:
summary: Firebird next transaction id is too big (instance {{ $labels.instance }})
description: "The limit in earlier versions (< 3) is 2,147,483,647."
- alert: FirebirdBackupCheck
expr: changes(file_content_hash_crc32{path=~".log"}[25h]) == 0
for: 0m
labels:
severity: critical
annotations:
summary: Firebird backup was not created for more than 24h (instance {{ $labels.instance }})
description: ""
- alert: FirebirdDatabaseScrappingFailed
expr: fb_info == 1
for: 0m
labels:
severity: critical
annotations:
summary: Firebird database scrapping failed (instance {{ $labels.instance }})
description: "{{ $labels.error }}"
- alert: FirebirdOldestActiveNextTransactionCheck
expr: fb_next_transaction - fb_oldest_active > 20000000
for: 1h
labels:
severity: critical
annotations:
summary: Firebird next transaction is not equal to the oldest active (instance {{ $labels.instance }})
description: ""
- alert: FirebirdOldestActiveOldestSnapshotEqualityCheck
expr: fb_oldest_active - fb_oldest_snapshot > 1000000000000000 # only testing, has to be set up zero
for: 1h
labels:
severity: critical
annotations:
summary: Firebird oldest active is not equal to the oldest snapshot (instance {{ $labels.instance }})
description: ""
- alert: FirebirdTransactionDuration
expr: fb_transaction_duration_seconds > 1440000
for: 0m
labels:
severity: critical
annotations:
summary: Firebird transaction (transaction {{ $labels.transaction_id }}, instance {{ $labels.instance }})
description: "The transaction duration > 4h"
...
File dashboard.json or on website 21510-firebird.
I do not know any.