fix(deps): update dependency winston to v3.15.0

Reviewed-on: #32

.gitea/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: "Deploy CI"
+
+on:
+  push:
+    branches:
+      - master
+    paths-ignore: # Files in here will not trigger a build
+      - "README.md"
+      - "LICENSE"
+      - "grafana-dashboard.json"
+      - "storage-tracker.sh"
+      - "useful-stuff.md"
+      - ".gitea/workflows/publish.yml"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Cloning repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Push to dokku
+        uses: dokku/github-action@master
+        with:
+          git_remote_url: "ssh://dokku@51.158.63.74:22/mc-tracker"
+          ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}

.gitea/workflows/publish.yml

@@ -4,7 +4,13 @@ on:
   push:
     branches:
       - "master"
-      - "influx-only"
+    paths-ignore: # Files in here will not trigger a build
+      - "README.md"
+      - "LICENSE"
+      - "grafana-dashboard.json"
+      - "storage-tracker.sh"
+      - "useful-stuff.md"
+      - ".gitea/workflows/ci.yml"
 
 jobs:
   docker:
@@ -14,7 +20,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Restore Docker Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: docker-cache
         with:
           path: /usr/bin/docker
@@ -37,26 +43,11 @@ jobs:
           username: ${{ secrets.REPO_USERNAME }}
           password: ${{ secrets.REPO_TOKEN }}
 
-      - name: Restore Docker Build Cache
-        uses: actions/cache@v3
-        id: build-cache
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx
-
       - name: Build and Push (Latest)
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           push: true
           context: .
           tags: fascinated/mc-tracker:latest
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
-
-      - name: Save Docker Build Cache
-        if: steps.build-cache.outputs.cache-hit != 'true'
-        run: |
-          mkdir -p /tmp/.buildx-cache
-          cp -r /tmp/.buildx-cache/. /tmp/.buildx-cache-new
-          rm -rf /tmp/.buildx-cache
-          mv /tmp/.buildx-cache-new /tmp/.buildx-cache

Dockerfile

@@ -4,8 +4,9 @@ ENV NODE_ENV=production
 WORKDIR /usr/src/app
 
 COPY ["package.json", "pnpm-lock.yaml", "./"]
-COPY . .
 
 RUN pnpm install --production --silent
 
+COPY . .
+
 CMD pnpm run build && pnpm run start

README.md

@@ -1,2 +1,9 @@
-# backend
+# Mc Tracker
 
+You can view the live instance of this project [here](https://mc-tracker.fascinated.cc).
+
+## Features
+
+- Track Minecraft server's player count over time
+- See player count peaks (all time)
+- Minecraft Java and Bedrock support

data/config.json-example

@@ -1,15 +1,13 @@
 {
   "influx": {
     "url": "http://localhost:8086",
-    "token": "my-token",
+    "token": "setme",
-    "org": "my-org",
+    "org": "setme",
-    "bucket": "my-bucket"
+    "bucket": "mc-tracker"
   },
-  "scanner": {
+  "pinger": {
-    "updateCron": "*/1 * * * *",
+    "pingCron": "*/1 * * * *",
+    "dnsInvalidationCron": "0 */6 * * *",
     "timeout": 2000
-  },
-  "backup": {
-    "cron": "0 0 * * *"
   }
 }

data/servers.json

@@ -1,7 +1,17 @@
 [
+  {
+    "name": "HiveMC",
+    "ip": "geo.hivebedrock.network",
+    "type": "PE"
+  },
+  {
+    "name": "Cubecraft - Bedrock",
+    "ip": "play.cubecraft.net",
+    "type": "PE"
+  },
   {
     "name": "WildNetwork",
-    "ip": "wildnetwork.net",
+    "ip": "play.wildnetwork.net",
     "type": "PC"
   },
   {
@@ -40,15 +50,10 @@
     "type": "PC"
   },
   {
-    "name": "Grand Theft Minecraft",
+    "name": "Grand Theft Minecart",
     "ip": "gtm.network",
     "type": "PC"
   },
-  {
-    "name": "HiveMC",
-    "ip": "geo.hivebedrock.network",
-    "type": "PE"
-  },
   {
     "name": "Purple Prison",
     "ip": "MCSL.PURPLE.WTF",
@@ -58,5 +63,70 @@
     "name": "MinecraftOnline",
     "ip": "minecraftonline.com",
     "type": "PC"
+  },
+  {
+    "name": "Hoplite",
+    "ip": "hoplite.gg",
+    "type": "PC"
+  },
+  {
+    "name": "Minemen Club",
+    "ip": "minemen.club",
+    "type": "PC"
+  },
+  {
+    "name": "OPLegends",
+    "ip": "play.oplegends.com",
+    "type": "PC"
+  },
+  {
+    "name": "Minecadia",
+    "ip": "play.minecadia.com",
+    "type": "PC"
+  },
+  {
+    "name": "Manacube",
+    "ip": "play.manacube.com",
+    "type": "PC"
+  },
+  {
+    "name": "InvadedLands",
+    "ip": "invadedlands.net",
+    "type": "PC"
+  },
+  {
+    "name": "Complex Gaming",
+    "ip": "hub.mc-complex.com",
+    "type": "PC"
+  },
+  {
+    "name": "Monumenta",
+    "ip": "server.playmonumenta.com",
+    "type": "PC"
+  },
+  {
+    "name": "Shotbow",
+    "ip": "play.shotbow.net",
+    "type": "PC"
+  },
+  {
+    "name": "Stray",
+    "ip": "stray.gg",
+    "type": "PC"
+  },
+  {
+    "name": "Aetheria Anarchy",
+    "ip": "aetheria.cc",
+    "type": "PC"
+  },
+  {
+    "name": "VexedMC",
+    "ip": "play.vexedmc.com",
+    "type": "PC"
+  },
+  {
+    "name": "AzureMC",
+    "ip": "play.azuremc.org",
+    "type": "PC"
   }
 ]

data/websites.json

@@ -0,0 +1,10 @@
+[
+  {
+    "name": "Minecraft Textures",
+    "url": "https://textures.minecraft.net"
+  },
+  {
+    "name": "Minecraft Session Server",
+    "url": "https://session.minecraft.net"
+  }
+]

docker-compose.yml

@@ -7,6 +7,18 @@ services:
     volumes:
       - ./data:/usr/src/app/data
 
+  grafana:
+    image: grafana/grafana:latest
+    environment:
+      - GF_ANALYTICS_REPORTING_ENABLED=false
+      - GF_SERVER_DOMAIN=mc-tracker.fascinated.cc
+      - GF_AUTH_ANONYMOUS_ENABLED=true
+    ports:
+      - 3000:3000
+    volumes:
+      - /home/grafana/data:/var/lib/grafana
+    restart: always
+
   influxdb:
     image: influxdb:latest
     container_name: influxdb

package.json

@@ -14,7 +14,9 @@
   "dependencies": {
     "@influxdata/influxdb-client": "^1.33.2",
     "@types/mcping-js": "^1.5.4",
+    "@types/node": "^20.10.6",
     "@types/node-cron": "^3.0.11",
+    "axios": "^1.6.4",
     "dns": "^0.2.2",
     "mcpe-ping-fixed": "^0.0.3",
     "mcping-js": "^1.5.0",
@@ -22,7 +24,6 @@
     "ts-node": "^10.9.2",
     "tsup": "^8.0.1",
     "typescript": "^5.3.3",
-    "winston": "^3.11.0",
+    "winston": "^3.11.0"
-    "@types/node": "^20.10.6"
   }
 }

renovate.json

@@ -1,6 +1,3 @@
 {
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:recommended", ":dependencyDashboard"]
-  "extends": [
+}
-    "local>Fascinated/renovate-config"
-  ]
-}

src/index.ts

@@ -1,20 +1,14 @@
 import Influx from "./influx/influx";
-import Scanner from "./scanner/scanner";
 import ServerManager from "./server/serverManager";
-
+import WebsiteManager from "./website/websiteManager";
-/**
+import {logger} from "./utils/logger";
- * The server manager instance.
- */
-export const serverManager = new ServerManager();
 
 /**
  * The influx database instance.
  */
 export const influx = new Influx();
 
-(async () => {
+new ServerManager();
-  await serverManager.init();
+new WebsiteManager();
 
-  // The scanner is responsible for scanning all servers
+logger.info("Done loading!");
-  new Scanner();
-})();

src/influx/influx.ts

@@ -14,13 +14,13 @@ export default class Influx {
       url: Config.influx.url,
       token: Config.influx.token,
     });
-    logger.info("InfluxDB initialized");
-
     this.writeApi = this.influx.getWriteApi(
       Config.influx.org,
       Config.influx.bucket,
       "ms"
     );
+
+    logger.info("InfluxDB initialized");
   }
 
   /**
@@ -28,7 +28,7 @@ export default class Influx {
    *
    * @param point the point to write
    */
-  public async writePoint(point: Point): Promise<void> {
+  public writePoint(point: Point) {
     this.writeApi.writePoint(point);
   }
 }

src/scanner/scanner.ts

@@ -1,27 +0,0 @@
-import cron from "node-cron";
-
-import { serverManager } from "..";
-import Config from "../../data/config.json";
-import { logger } from "../utils/logger";
-
-export default class Scanner {
-  constructor() {
-    cron.schedule(Config.scanner.updateCron, () => {
-      this.scanServers();
-    });
-  }
-
-  /**
-   * Start a server scan to ping all servers.
-   */
-  private async scanServers(): Promise<void> {
-    logger.info(`Scanning servers ${serverManager.getServers().length}`);
-
-    // ping all servers in parallel
-    await Promise.all(
-      serverManager.getServers().map((server) => server.pingServer())
-    );
-
-    logger.info("Finished scanning servers");
-  }
-}

src/server/server.ts

@@ -15,10 +15,6 @@ import { logger } from "../utils/logger";
  */
 export type ServerType = "PC" | "PE";
 
-export enum ServerStatus {
-  OFFLINE = "Unable to reach host",
-}
-
 type ServerOptions = {
   name: string;
   ip: string;
@@ -35,27 +31,22 @@ export default class Server {
   /**
    * The name of the server.
    */
-  private name: string;
+  private readonly name: string;
 
   /**
    * The IP address of the server.
    */
-  private ip: string;
+  private readonly ip: string;
 
   /**
    * The port of the server.
    */
-  private port: number | undefined;
+  private readonly port: number | undefined;
 
   /**
    * The type of server.
    */
-  private type: ServerType;
+  private readonly type: ServerType;
-
-  /**
-   * The favicon of the server.
-   */
-  private favicon: string | undefined;
 
   /**
    * The resolved server information from
@@ -78,6 +69,7 @@ export default class Server {
    * @returns the ping response or undefined if the server is offline
    */
   public async pingServer(): Promise<Ping | undefined> {
+    const before = Date.now();
     try {
       let response;
 
@@ -101,10 +93,14 @@ export default class Server {
           new Point("playerCount")
             .tag("name", this.getName())
             .intField("playerCount", response.playerCount)
+            .intField("latency", Date.now() - before)
             .timestamp(response.timestamp)
         );
       } catch (err) {
-        logger.warn(`Failed to write ping to influxdb`, err);
+        logger.warn(
+          `Failed to write point to Influx for ${this.getName()} - ${this.getIP()}`,
+          err
+        );
       }
 
       return Promise.resolve(response);
@@ -147,13 +143,13 @@ export default class Server {
 
     const serverPing = new javaPing.MinecraftServer(ip, port);
 
+    // todo: do something to get the latest protocol? (is this even needed??)
     return new Promise((resolve, reject) => {
-      serverPing.ping(Config.scanner.timeout, 765, (err, res) => {
+      serverPing.ping(Config.pinger.timeout, 765, (err, res) => {
         if (err || res == undefined) {
           return reject(err);
         }
 
-        this.favicon = res.favicon; // Set the favicon
         resolve({
           timestamp: Date.now(),
           ip: ip,
@@ -189,6 +185,15 @@ export default class Server {
     });
   }
 
+  /**
+   * Invalidates the DNS cache for the server.
+   */
+  public invalidateDns() {
+    this.dnsInfo = {
+      hasResolved: false,
+    };
+  }
+
   /**
    * Returns the name of the server.
    *
@@ -224,13 +229,4 @@ export default class Server {
   public getType(): ServerType {
     return this.type;
   }
-
-  /**
-   * Returns the favicon of the server.
-   *
-   * @returns the favicon
-   */
-  public getFavicon(): string | undefined {
-    return this.favicon;
-  }
 }

src/server/serverManager.ts

@@ -1,18 +1,15 @@
+import cron from "node-cron";
+import { logger } from "../utils/logger";
 import Server, { ServerType } from "./server";
 
+import Config from "../../data/config.json";
 import Servers from "../../data/servers.json";
-import { logger } from "../utils/logger";
 
 export default class ServerManager {
   private servers: Server[] = [];
 
-  constructor() {}
+  constructor() {
-
+    logger.info("Loading servers...");
-  /**
-   * Loads the servers from the config file.
-   */
-  async init() {
-    logger.info("Loading servers");
     for (const configServer of Servers) {
       const server = new Server({
         ip: configServer.ip,
@@ -21,15 +18,29 @@ export default class ServerManager {
       });
       this.servers.push(server);
     }
-    logger.info(`Loaded ${this.servers.length} servers`);
+    logger.info(`Loaded ${this.servers.length} servers!`);
+
+    cron.schedule(Config.pinger.pingCron, async () => {
+      await this.pingServers();
+    });
+
+    cron.schedule(Config.pinger.dnsInvalidationCron, () => {
+      logger.info("Invalidating DNS cache for all servers");
+      for (const server of this.servers) {
+        server.invalidateDns();
+      }
+    });
   }
 
   /**
-   * Returns the servers.
+   * Ping all servers to update their status.
-   *
-   * @returns the servers
    */
-  public getServers(): Server[] {
+  private async pingServers(): Promise<void> {
-    return this.servers;
+    logger.info(`Pinging servers ${this.servers.length}`);
+
+    // ping all servers in parallel
+    await Promise.all(this.servers.map((server) => server.pingServer()));
+
+    logger.info("Finished pinging servers!");
   }
 }

src/utils/fsUtils.ts

@@ -1,41 +0,0 @@
-import fs from "fs";
-
-/**
- * Creates a directory at the given path.
- *
- * @param path the path to the file
- * @param recursive whether to create the directory tree if it doesn't exist (defaults to true)
- * @returns a promise that resolves when the file is created
- */
-export async function createDirectory(
-  path: string,
-  recursive?: boolean
-): Promise<void> {
-  if (recursive == undefined) {
-    recursive = true; // Set to true by default
-  }
-
-  return new Promise((resolve, reject) => {
-    fs.mkdir(path, { recursive: recursive }, (err) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve();
-      }
-    });
-  });
-}
-
-/**
- * Checks if a file exists at the given path.
- *
- * @param path the path to the file
- * @returns a promise that returns true if the file exists, false otherwise
- */
-export async function exists(path: string): Promise<boolean> {
-  return new Promise((resolve) => {
-    fs.exists(path, (exists) => {
-      resolve(exists);
-    });
-  });
-}

src/utils/logger.ts

@@ -9,7 +9,7 @@ interface LogInfo {
 }
 
 const customFormat = format.combine(
-  timestamp({ format: "YY-MM-DD HH:MM:SS" }),
+  timestamp({ format: "YYYY-MM-DD HH:mm:ss" }),
   printf((info: LogInfo) => {
     return `[${info.timestamp}] ${info.level}: ${info.message}`;
   })

src/utils/timeUtils.ts

@@ -1,18 +0,0 @@
-/**
- * Gets the current date as YYYY-MM-DD.
- *
- * @returns the date
- */
-export function getFormattedDate() {
-  return new Date().toISOString().slice(0, 10);
-}
-
-/**
- * Formats a timestamp as YYYY-MM-DD.
- *
- * @param timestamp the timestamp
- * @returns the formatted timestamp
- */
-export function formatTimestamp(timestamp: number) {
-  return new Date(timestamp).toISOString().slice(0, 10);
-}

src/website/website.ts

@@ -0,0 +1,64 @@
+import { Point } from "@influxdata/influxdb-client";
+import axios from "axios";
+import { influx } from "..";
+import { logger } from "../utils/logger";
+
+import Config from "../../data/config.json";
+
+type WebsiteOptions = {
+  name: string;
+  url: string;
+};
+
+export default class Website {
+  /**
+   * The name of the website.
+   */
+  private readonly name: string;
+
+  /**
+   * The url of the website.
+   */
+  private readonly url: string;
+
+  constructor({ name, url }: WebsiteOptions) {
+    this.name = name;
+    this.url = url;
+  }
+
+  /**
+   * Pings a website and gets the response.
+   *
+   * @returns the response
+   */
+  public async pingWebsite(): Promise<void> {
+    try {
+      const before = Date.now();
+      const response = await axios.get(this.url, {
+        validateStatus: () => true, // Don't throw a error on non-200 status codes
+        timeout: Config.pinger.timeout,
+      });
+      if (response.status === 500) {
+        throw new Error("Server returned 500 status code");
+      }
+
+      const responseTime = Date.now() - before;
+
+      influx.writePoint(
+        new Point("websiteStatus")
+          .tag("name", this.name)
+          .booleanField("online", true)
+          .intField("responseTime", responseTime)
+          .timestamp(Date.now())
+      );
+    } catch (err) {
+      logger.warn(`Failed to ping ${this.name}:`, err);
+      influx.writePoint(
+        new Point("websiteStatus")
+          .tag("name", this.name)
+          .booleanField("online", false)
+          .timestamp(Date.now())
+      );
+    }
+  }
+}

src/website/websiteManager.ts

@@ -0,0 +1,38 @@
+import cron from "node-cron";
+import { logger } from "../utils/logger";
+
+import Config from "../../data/config.json";
+import Websites from "../../data/websites.json";
+import Website from "./website";
+
+export default class WebsiteManager {
+  private websites: Website[] = [];
+
+  constructor() {
+    logger.info("Loading websites...");
+    for (const configWebsite of Websites) {
+      const website = new Website({
+        name: configWebsite.name,
+        url: configWebsite.url,
+      });
+      this.websites.push(website);
+    }
+    logger.info(`Loaded ${this.websites.length} websites!`);
+
+    cron.schedule(Config.pinger.pingCron, async () => {
+      await this.pingWebsites();
+    });
+  }
+
+  /**
+   * Ping all websites to update their status.
+   */
+  private async pingWebsites(): Promise<void> {
+    logger.info(`Pinging websites ${this.websites.length}`);
+
+    // ping all websites in parallel
+    await Promise.all(this.websites.map((website) => website.pingWebsite()));
+
+    logger.info("Finished pinging websites!");
+  }
+}

storage-tracker.sh

@@ -0,0 +1,12 @@
+usage_engine=$(du -s /home/tracker/influx/db/engine/data/setme/ | cut -f1)
+usage_wal=$(du -s /home/tracker/influx/db/engine/wal/setme/ | cut -f1)
+
+# Calculate the sum of usage_engine and usage_wal
+total_usage=$((usage_engine + usage_wal))
+
+docker exec influxdb influx write \
+  --org homelab \
+  --bucket influx_metrics \
+  --token setme \
+  --precision s \
+  "storage_usage,db=mc-tracker value=$total_usage"

useful-stuff.md

@@ -0,0 +1,7 @@
+# Useful stuff
+
+## Deleteing a specific server from influx
+
+```bash
+influx delete --bucket mc-tracker --start 2024-01-01T00:00:00Z --stop 2024-01-05T00:00:00Z --org homelab --token nou --predicate '_measurement="playerCount" AND "name"="Grand Theft Minecraft"'
+```