Skip to content

Developer Guide

This page shows you how to build, test and install the project manually.

Build

To build the project you need the following on your development machine.

  • Go Version 1.16.x or later
  • Git >= Version 2.30
  • lsb_release
  • ronn - Only in case you want to work on man pages

To build the software change to the repositories directory and run:

./build.sh build

To figure out all the valid tasks, read ./build.sh -l

Create man pages

To create the man pages out of the *.ronn source files in src/man run:

build/CreateManPage.sh

Run Tests locally

To execute the unit tests you can run:

./build.sh test

Hint: As always it is possible to combine the commands, e. g. ./build.sh build test

To execute the integration tests you can run:

./test/integrationTest/scripts/RunIntegrationTests.sh

Manual installation

On your target machine, the samba server you want to monitor, you need samba and systemd installed.

To build for manual installation run the following:

./build.sh preparePack
build/CreateManPage.sh

For manual install on the target machine do the following copy after you build the project as shown above:

rsync -avr --exclude 'DEBIAN' --exclude 'samba-exporter.spec' ./tmp/samba-exporter_<version>/* root@<target>:/

Now login to your target machine and run the commands below to enable the services and create the needed user and group:

systemctl daemon-reload
systemctl enable samba_statusd.service
systemctl enable samba_exporter.service
addgroup --system samba-exporter
adduser --system --no-create-home --disabled-login samba-exporter
adduser samba-exporter samba-exporter
mandb                                                               # In case you created and copied the man pages as well

Finally you are abel to start the services:

systemctl start samba_statusd.service
systemctl start samba_exporter.service

Test installation

Test the samba_exporter by requesting metrics with curl:

curl http://127.0.0.1:9922/metrics

The output of this test should look something like this:

# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 0
...
# HELP promhttp_metric_handler_requests_in_flight Current number of scrapes being served.
# TYPE promhttp_metric_handler_requests_in_flight gauge
promhttp_metric_handler_requests_in_flight 1
# HELP promhttp_metric_handler_requests_total Total number of scrapes by HTTP status code.
# TYPE promhttp_metric_handler_requests_total counter
promhttp_metric_handler_requests_total{code="200"} 0
promhttp_metric_handler_requests_total{code="500"} 0
promhttp_metric_handler_requests_total{code="503"} 0
# HELP samba_client_count Number of clients using the samba server
# TYPE samba_client_count gauge
samba_client_count 0
# HELP samba_individual_user_count The number of users connected to this samba server
# TYPE samba_individual_user_count gauge
samba_individual_user_count 0
# HELP samba_locked_file_count Number of files locked by the samba server
# TYPE samba_locked_file_count gauge
samba_locked_file_count 0
# HELP samba_pid_count Number of processes running by the samba server
# TYPE samba_pid_count gauge
samba_pid_count 0
# HELP samba_satutsd_up 1 if the samba_statusd seems to be running
# TYPE samba_satutsd_up gauge
samba_satutsd_up 1
# HELP samba_server_up 1 if the samba server seems to be running
# TYPE samba_server_up gauge
samba_server_up 1
# HELP samba_share_count Number of shares used by clients of the samba server
# TYPE samba_share_count gauge
samba_share_count 0