Axibase Time Series Database

scollector

Linux

Manual Installation

Download scollector binary for Linux.

mkdir scollector

cd scollector

wget https://github.com/bosun-monitor/bosun/releases/download/0.6.0-beta1/scollector-linux-amd64

chmod 700 scollector-linux-amd64

Replace username, password, hostname and port number with actual connection parameters.

echo 'Host = "http://username:password@atsd_hostname:8088/"' > scollector.toml

The default ATSD HTTP port is 8088, HTTPS port is 8443.

scollector does not support untrusted SSL certificates. If ATSD is running on a CA-signed SSL certificate, you can specify the secure connection.

echo 'Host = "https://username:password@atsd_hostname:8443/"' > scollector.toml

Start scollector.

nohup ./scollector-linux-amd64 &

Auto-start in Privileged Mode

This section describes how to configure scollector start under a sudo user.

Note

init scripts for systems without systemd do not support daemon stopping and do not check if service is already running.

Ubuntu 14.04

Change to the scollector installation directory.

Create /etc/init.d/scollector file:

sudo cat <<EOF > /etc/init.d/scollector
#chkconfig: 2345 90 10
#description: scollector is a framework to collect data points and store them in a TSDB.
### BEGIN INIT INFO
# Provides: scollector
# Required-Start:
# Required-Stop:
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: start scollector
# Description:
### END INIT INFO

SCOLLECTOR_BIN=$(pwd)/scollector-linux-amd64
SCOLLECTOR_CONF=$(pwd)/scollector.toml

"\$SCOLLECTOR_BIN" -conf="\$SCOLLECTOR_CONF"
EOF

Make /etc/init.d/scollector file executable.

chmod a+x /etc/init.d/scollector

Enable scollector launch when the system is started.

sudo update-rc.d scollector defaults 90 10

Start scollector.

sudo service scollector start

CentOS 6.x and RHEL 6.x

Change to the scollector installation directory.

Create /etc/init.d/scollector file:

sudo cat <<EOF > /etc/init.d/scollector
#chkconfig: 2345 90 10
#description: scollector is a framework to collect data points and store them in a TSDB.
### BEGIN INIT INFO
# Provides: scollector
# Required-Start:
# Required-Stop:
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: start scollector
# Description:
### END INIT INFO

SCOLLECTOR_BIN=$(pwd)/scollector-linux-amd64
SCOLLECTOR_CONF=$(pwd)/scollector.toml

"\$SCOLLECTOR_BIN" -conf="\$SCOLLECTOR_CONF"
EOF

Make the /etc/init.d/scollector file executable.

chmod a+x /etc/init.d/scollector

Enable scollector launch when the system is started.

sudo chkconfig --add scollector

Ubuntu 16.04, CentOS 7.x and RHEL 7.x

Change to the scollector installation directory.

Create a service file for scollector /lib/systemd/system/scollector.service:

sudo cat <<EOF > /lib/systemd/system/scollector.service
[Unit]
Description=scollector daemon
After=network.target

[Service]
Type=simple
ExecStart=$(pwd)/scollector-linux-amd64

[Install]
WantedBy=multi-user.target
EOF

Enable scollector launch when the system is started.

sudo systemctl enable scollector

Auto-start scollector as a non-sudo user

Ubuntu 14.04, CentOS 6.x and RHEL 6.x

Modify the /etc/init.d/tcollector file:

#chkconfig: 2345 90 10
#description: collect OS metrics and store them in ATSD
### BEGIN INIT INFO
# Provides: scollector
# Required-Start:
# Required-Stop:
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: start scollector
# Description:
### END INIT INFO

SCOLLECTOR_BIN=/home/axibase/scollector-linux-amd64
SCOLLECTOR_CONF=/home/axibase/scollector.toml
SCOLLECTOR_USER=axibase

if [ `whoami` != "$SCOLLECTOR_USER" ]; then
su - "$SCOLLECTOR_USER" -c "$SCOLLECTOR_BIN" -conf="$SCOLLECTOR_CONF"
else
"$SCOLLECTOR_BIN" -conf="$SCOLLECTOR_CONF"
fi

Change SCOLLECTOR_BIN and SCOLLECTOR_CONF to the actual scollector directory path. Set SCOLLECTOR_USER to the user under which scollector is launched.

Ubuntu 16.04, CentOS 7.x and RHEL 7.x

Add User option to [Service] section of the service file

sudo sed -i '/\[Service\]/a User=[user_name]' /lib/systemd/system/scollector.service
sudo systemctl daemon-reload

Windows

Download scollector executable for Windows.

Expand the archive, change to the directory containing exe file and create a scollector.toml file containing the Host setting.

Host = "http://username:password@atsd_hostname:8088/"

Specify user credentials for a data collector account. If necessary, create an account with the Settings > Users > Create Collector User wizard.

Because scollector does not support untrusted SSL certificates, the above example uses the HTTP endpoint. If you installed a signed SSL certificate into ATSD, you can change the setting to the HTTPS endpoint running on the 8443 port by default.

Open the prompt as Administrator and create an scollector service with automated startup:

scollector-windows-amd64.exe -winsvc=install

Start scollector service:

scollector-windows-amd64.exe -winsvc=start

If the service exits a few seconds after startup, check the following:

  • scollector.toml file exists in the same directory as the executable file.
  • scollector.toml file is valid and is not empty.

Open Windows event log and review the scollector service messages.

If the service is running but there are no scollector metrics in ATSD, verify the protocol, URL, and user credentials specified in the scollector.toml file.