Bot instance metric labels (#87)

* Label all metrics with guild id and instance name

* Improve local scripts and docs

* Bump chart version

Author: maxine4j

README.md

@@ -39,7 +39,7 @@
 1. Run `yarn` to install dependencies for your IDE
 2. Install docker and [kind](https://kind.sigs.k8s.io/docs/user/quick-start).
 3. Install helm by following https://helm.sh/docs/intro/install/
-5. Start a local kubernetes cluster by running `kind create cluster --name tim-local`
+4. Start a local kubernetes cluster by running `kind create cluster --name <cluster-name-here>` where `<cluster-name-here>` is any string (e.g. `local`)
 
 ### Running tests
 
@@ -56,4 +56,4 @@ Script | Description
 `./local-build.sh` | Builds the bot using docker
 `./local-start.sh` | Installs the bot's helm chart
 `./local-stop.sh` | Uninstalls the bot's helm chart
-`./local-tail.sh` | Tails the bot's pod's logs
+`./local-tail.sh` | View the bot's logs

helm/citsbot/Chart.yaml

@@ -1,4 +1,4 @@
 apiVersion: v2
 description: UWA CSDS Discord Bot
 name: citsbot
-version: 1.17.1
+version: 1.18.0

helm/citsbot/templates/deployment.yaml

@@ -19,6 +19,8 @@ spec:
         - name: citsbot
           image: "{{ $.Values.image }}:{{ $.Chart.Version }}"
           env:
+            - name: INSTANCE_NAME
+              value: "{{ $instance.name }}"
             - name: PUSHGATEWAY_URL
               value: "{{ $.Values.pushgatewayUrl }}"
             - name: DISCORD_TOKEN

local-build.sh

@@ -1,14 +1,10 @@
 #!/bin/bash
 
-sh ./local-set-context.sh
+./local-set-context.sh
 
 VERSION=$(cat ./helm/citsbot/Chart.yaml | grep version | awk '{ print $2 }')
 docker build -t citsbot:${VERSION} .
 
-if [[ "$LOCAL_KUBE_CONTEXT" = "minikube" ]]; then
-  # minikube uses a separate daemon to the host, so images built on the host need to be transferred to it
-  docker save citsbot:${VERSION} | (eval $(minikube docker-env) && docker load)
-elif [[ ! -z "$LOCAL_KUBE_CONTEXT" ]]; then
-  # kind uses a separate daemon to the host, so images built on the host need to be transferred to it
-  kind load docker-image citsbot:${VERSION} --name $LOCAL_KUBE_CONTEXT
-fi
+# kind uses a separate daemon to the host, so images built on the host need to be transferred to it
+LOCAL_KUBE_CONTEXT=$(kubectl config get-contexts | grep kind | sed -e 's/^[ |*]*//' | sed -e 's/\(^[^ ]*\).*$/\1/')
+kind load docker-image citsbot:${VERSION} --name "$LOCAL_KUBE_CONTEXT"

local-reset.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 
-sh ./local-set-context.sh
+./local-set-context.sh
 
-sh ./local-stop.sh && ./local-build.sh && ./local-start.sh && ./local-tail.sh
+./local-stop.sh && ./local-build.sh && ./local-start.sh && ./local-tail.sh

local-set-context.sh

@@ -1,5 +1,4 @@
 #!/bin/bash
 
 LOCAL_KUBE_CONTEXT=$(kubectl config get-contexts | grep kind | sed -e 's/^[ |*]*//' | sed -e 's/\(^[^ ]*\).*$/\1/')
-
 kubectl config use-context $LOCAL_KUBE_CONTEXT

local-start.sh

@@ -1,8 +1,8 @@
 #!/bin/bash
 
-sh ./local-set-context.sh
+./local-set-context.sh
 
-. .env
+source .env
 if [ -z "$DISCORD_TOKEN" ]; then
   echo "DISCORD_TOKEN is not set in .env"
   exit 1

local-stop.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 
-sh ./local-set-context.sh
+./local-set-context.sh
 
 sudo helm uninstall -n citsbot citsbot || true

local-tail.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-sh ./local-set-context.sh
+./local-set-context.sh
 
 function is_pod_running() {
   POD_NAME=$(kubectl get pods -n citsbot -o jsonpath="{.items[0].metadata.name}")

src/metrics/process.ts

@@ -1,10 +1,11 @@
-import { Pushgateway } from 'prom-client';
+import client, { Pushgateway } from 'prom-client';
 
-export const initPushgateway = (url: string | undefined) => {
+export const initPushgateway = (url: string | undefined, instance: string, guild: string) => {
   if (!url) {
     console.log(`No pushgateway URL provided. No metrics will be pushed.`);
-    return setInterval(() => undefined, 5000);
+    return setInterval(() => undefined, 5_000);
   }
-  const pushgateway = new Pushgateway(url);
-  return setInterval(() => pushgateway.pushAdd({ jobName: `citsbot` }), 5000);
+  client.register.setDefaultLabels({ instance, guild });
+  const pushgateway = new Pushgateway(url, undefined, client.register);
+  return setInterval(() => pushgateway.pushAdd({ jobName: `citsbot` }), 5_000);
 };