Add hostRole config option (#931)

Allow users to configure a role for a host. It's not used a lot in the
product yet, but we generate a metric for it and we can do some more
stuff with it in the future.

Part of appsignal/appsignal-agent#1020

.changesets/add-role-config-option.md

@@ -0,0 +1,6 @@
+---
+bump: "patch"
+type: "add"
+---
+
+Add the `hostRole` config option. This config option can be set per host to generate some metrics automatically per host and possibly do things like grouping in the future.

src/__tests__/config.test.ts

@@ -266,6 +266,7 @@ describe("Configuration", () => {
       expect(env("_APPSIGNAL_FILES_WORLD_ACCESSIBLE")).toEqual("true")
       expect(env("_APPSIGNAL_FILTER_DATA_KEYS")).toBeUndefined()
       expect(env("_APPSIGNAL_HOSTNAME")).toBeUndefined()
+      expect(env("_APPSIGNAL_HOST_ROLE")).toBeUndefined()
       expect(env("_APPSIGNAL_HTTP_PROXY")).toBeUndefined()
       expect(env("_APPSIGNAL_IGNORE_ACTIONS")).toBeUndefined()
       expect(env("_APPSIGNAL_IGNORE_ERRORS")).toBeUndefined()
@@ -314,6 +315,7 @@ describe("Configuration", () => {
           filterParameters: ["password", "confirm_password"],
           filterSessionData: ["key1", "key2"],
           hostname: "MyHostName",
+          hostRole: "host role",
           httpProxy: "http://localhost",
           ignoreActions: ["MyAction", "MyOtherAction"],
           ignoreErrors: ["MyError", "MyOtherError"],
@@ -341,6 +343,7 @@ describe("Configuration", () => {
         )
         expect(env("_APPSIGNAL_FILTER_SESSION_DATA")).toEqual("key1,key2")
         expect(env("_APPSIGNAL_HOSTNAME")).toEqual("MyHostName")
+        expect(env("_APPSIGNAL_HOST_ROLE")).toEqual("host role")
         expect(env("_APPSIGNAL_HTTP_PROXY")).toEqual("http://localhost")
         expect(env("_APPSIGNAL_IGNORE_ACTIONS")).toEqual(
           "MyAction,MyOtherAction"

src/config/configmap.ts

@@ -16,6 +16,7 @@ export const ENV_TO_KEY_MAPPING: Record<string, keyof AppsignalOptions> = {
   APPSIGNAL_FILTER_PARAMETERS: "filterParameters",
   APPSIGNAL_FILTER_SESSION_DATA: "filterSessionData",
   APPSIGNAL_HOSTNAME: "hostname",
+  APPSIGNAL_HOST_ROLE: "hostRole",
   APPSIGNAL_HTTP_PROXY: "httpProxy",
   APPSIGNAL_IGNORE_ACTIONS: "ignoreActions",
   APPSIGNAL_IGNORE_ERRORS: "ignoreErrors",
@@ -50,6 +51,7 @@ export const PRIVATE_ENV_MAPPING: Record<string, keyof AppsignalOptions> = {
   _APPSIGNAL_FILTER_PARAMETERS: "filterParameters",
   _APPSIGNAL_FILTER_SESSION_DATA: "filterSessionData",
   _APPSIGNAL_HOSTNAME: "hostname",
+  _APPSIGNAL_HOST_ROLE: "hostRole",
   _APPSIGNAL_HTTP_PROXY: "httpProxy",
   _APPSIGNAL_IGNORE_ACTIONS: "ignoreActions",
   _APPSIGNAL_IGNORE_ERRORS: "ignoreErrors",
@@ -85,6 +87,7 @@ export const JS_TO_RUBY_MAPPING: Record<keyof AppsignalOptions, string> = {
   filterParameters: "filter_parameters",
   filterSessionData: "filter_session_data",
   hostname: "hostname",
+  hostRole: "host_role",
   httpProxy: "http_proxy",
   ignoreActions: "ignore_actions",
   ignoreErrors: "ignore_errors",

src/config/options.ts

@@ -16,6 +16,7 @@ export type AppsignalOptions = {
   filterParameters: string[]
   filterSessionData: string[]
   hostname: string
+  hostRole: string
   httpProxy: string
   ignoreActions: string[]
   ignoreErrors: string[]