sdtd_exporter

README

7 Days to Die Server Exporter

A Prometheus exporter for exposing metrics from the 7 Days to Die server API.

This README does not cover how to set up a 7 Days to Die server. For a good guide, please take a look at the CSMM server cookbook.

Required Server Configuration

You must enable the web dashboard for your server to use this exporter and generate an access token.

Enable the web dashboard

1. Open your serverconfig.xml file in a text editor. For Steam installs, this file will be under steamapps\common\7 Days to Die Dedicated Server.

2. Change the WebDashboardEnabled property to true.

3. Save the file and (re)start your server.

Create an access token

1. After your server/game is running, open the console.

2. Create a web token using the webtokens add command:

   [!NOTE] Replace <secret value> with a password or secret token.

   webtokens add sdtd_exporter <secret value> 2000
   

3. Use the name sdtd_exporter and your chosen secret for the SDTD_TOKEN_NAME and SDTD_TOKEN_SECRET environment variables below.

Running

Running the sdtd_exporter command without arguments will cause it to expose the metrics on port 9816 under /metrics and attempt to connect to a 7 Days to Die server API running on the local system on port 8080.

Use the command line flags and environment variables to specify the server URL and API credentials:

$ ./sdtd_exporter --help
usage: sdtd_exporter [<flags>]


Flags:
  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man).
      --server.url="http://127.0.0.1:8080"
                                 The base URL of the 7 Days to Die dedicated server web API (e.g., http://127.0.0.1:8080). ($SDTD_API_URL)
      --server.token-name=SERVER.TOKEN-NAME
                                 The name of the API token to use to authenticate with the web server. ($SDTD_TOKEN_NAME)
      --server.token-secret=SERVER.TOKEN-SECRET
                                 The secret of the API token to use to authenticate with the web server. ($SDTD_TOKEN_SECRET)
      --web.telemetry-path="/metrics"
                                 Path under which to expose metrics.
      --[no-]web.systemd-socket  Use systemd socket activation listeners instead of port listeners (Linux only).
      --web.listen-address=:9816 ...
                                 Addresses on which to expose metrics and web interface. Repeatable for multiple addresses.
      --web.config.file=""       Path to configuration file that can enable TLS or authentication. See:
                                 https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
      --log.level=info           Only log messages with the given severity or above. One of: [debug, info, warn, error]
      --log.format=logfmt        Output format of log messages. One of: [logfmt, json]
      --[no-]version             Show application version.

You will likely need to specify the --server.url value as well as the SDTD_TOKEN_NAME and SDTD_TOKEN_SECRET environment variables for the values unique to your server. These are the same values you set in the Create an access token section.

SDTD_TOKEN_NAME="sdtd_exporter" SDTD_TOKEN_SECRET="<secret value>" \
  ./sdtd_exporter --server.url=http://1.2.3.4:8080

[!NOTE] On Windows the command will be:

$Env:SDTD_TOKEN_NAME = "sdtd_exporter"
$Env:SDTD_TOKEN_SECRET = "<secret value>"
.\sdtd_exporter --server.url=http://1.2.3.4:8080

Docker

A Docker image of the exporter is available at thelande/sdtd_exporter and takes the same arguments as the command.

You should place your environment variables in an environment file named .env:

SDTD_TOKEN_NAME="<your token name>"
SDTD_TOKEN_SECRET="<your token secret>"

docker run -d -p 9816:9816 --env-file=.env \
  thelande/sdtd_exporter --server.url="<your server URL>"

Documentation

Overview

Copyright 2024-2025 Thomas Helander

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.