Setup axiom logging configuration

Author: JoeeGrigg

.env.example

@@ -9,8 +9,15 @@ TINYBIRD_TRACKER_TOKEN=p.eyJxxxxxxxx
 # Google Cloud Project Configuration (required when using firestore salt store)
 GOOGLE_CLOUD_PROJECT=traffic-analytics-dev
 
+# Optional Axiom secondary log transport for production logging
+# AXIOM_DATASET=traffic-analytics
+# AXIOM_TOKEN=xaat-xxxxxxxx
+# AXIOM_ORG_ID=
+# AXIOM_URL=https://api.axiom.co
+# AXIOM_LOG_LEVEL=info
+
 # Firestore Configuration (required when using firestore salt store)
 FIRESTORE_DATABASE_ID=
 
 # Pub/Sub Configuration (required for pub/sub functionality)
-PUBSUB_TOPIC_PAGE_HITS_RAW=
+PUBSUB_TOPIC_PAGE_HITS_RAW=

package.json

@@ -57,6 +57,7 @@
     "vitest": "4.1.2"
   },
   "dependencies": {
+    "@axiomhq/pino": "^1.5.0",
     "@fastify/cors": "11.2.0",
     "@fastify/reply-from": "12.6.1",
     "@fastify/type-provider-typebox": "5.2.0",

src/utils/logger-config.ts

@@ -1,4 +1,4 @@
-import type {LoggerOptions} from 'pino';
+import type {LoggerOptions, TransportTargetOptions} from 'pino';
 import type {PrettyOptions} from 'pino-pretty';
 import type {FastifyRequest, FastifyReply} from 'fastify';
 import {createGcpLoggingPinoConfig} from '@google-cloud/pino-logging-gcp-config';
@@ -11,6 +11,50 @@ function getServiceContext(): {service: string; version?: string} {
     return version ? {service, version} : {service};
 }
 
+function getStdoutTransportTarget(): TransportTargetOptions {
+    return {
+        target: 'pino/file',
+        options: {
+            destination: 1
+        }
+    };
+}
+
+function getAxiomTransportTarget(): TransportTargetOptions | undefined {
+    const token = process.env.AXIOM_TOKEN;
+    const dataset = process.env.AXIOM_DATASET;
+
+    if (!token || !dataset) {
+        return undefined;
+    }
+
+    return {
+        target: '@axiomhq/pino',
+        level: process.env.AXIOM_LOG_LEVEL || process.env.LOG_LEVEL || 'info',
+        options: {
+            token,
+            dataset,
+            ...(process.env.AXIOM_ORG_ID ? {orgId: process.env.AXIOM_ORG_ID} : {}),
+            ...(process.env.AXIOM_URL ? {url: process.env.AXIOM_URL} : {})
+        }
+    };
+}
+
+function getProductionTransport(): LoggerOptions['transport'] | undefined {
+    const axiomTarget = getAxiomTransportTarget();
+
+    if (!axiomTarget) {
+        return undefined;
+    }
+
+    return {
+        targets: [
+            getStdoutTransportTarget(),
+            axiomTarget
+        ]
+    };
+}
+
 /**
  * Get logger configuration based on environment
  */
@@ -51,7 +95,7 @@ export function getLoggerConfig(): LoggerOptions {
     }
 
     // Production / staging configuration - GCP optimized JSON logs
-    return createGcpLoggingPinoConfig(
+    const config = createGcpLoggingPinoConfig(
         {
             serviceContext: getServiceContext(),
             inihibitDiagnosticMessage: Boolean(process.env.VITEST)
@@ -60,4 +104,8 @@ export function getLoggerConfig(): LoggerOptions {
             level: process.env.LOG_LEVEL || 'info'
         }
     );
+
+    const transport = getProductionTransport();
+
+    return transport ? {...config, transport} : config;
 }

test/unit/utils/logger.test.ts

@@ -87,6 +87,51 @@ describe('Logger Config', () => {
             expect(config.formatters).toHaveProperty('log');
             expect(config.serializers).toBeUndefined();
         });
+
+        it('should add an Axiom transport in production when dataset and token are configured', () => {
+            vi.stubEnv('NODE_ENV', 'production');
+            vi.stubEnv('LOG_LEVEL', 'info');
+            vi.stubEnv('AXIOM_DATASET', 'traffic-logs');
+            vi.stubEnv('AXIOM_TOKEN', 'axiom-token');
+            vi.stubEnv('AXIOM_ORG_ID', 'ghost');
+            vi.stubEnv('AXIOM_URL', 'https://api.axiom.test');
+            vi.stubEnv('AXIOM_LOG_LEVEL', 'error');
+
+            const config = getLoggerConfig();
+
+            expect(config.transport).toMatchObject({
+                targets: [
+                    {
+                        target: 'pino/file',
+                        options: {
+                            destination: 1
+                        }
+                    },
+                    {
+                        target: '@axiomhq/pino',
+                        level: 'error',
+                        options: {
+                            dataset: 'traffic-logs',
+                            token: 'axiom-token',
+                            orgId: 'ghost',
+                            url: 'https://api.axiom.test'
+                        }
+                    }
+                ]
+            });
+            expect(config.formatters).toHaveProperty('log');
+        });
+
+        it('should skip the Axiom transport when dataset or token are missing', () => {
+            vi.stubEnv('NODE_ENV', 'production');
+            vi.stubEnv('LOG_LEVEL', 'info');
+            vi.stubEnv('AXIOM_DATASET', 'traffic-logs');
+
+            const config = getLoggerConfig();
+
+            expect(config.transport).toBeUndefined();
+            expect(config.formatters).toHaveProperty('log');
+        });
     });
 
     describe('production logging output', () => {

yarn.lock

@@ -2,6 +2,21 @@
 # yarn lockfile v1
 
 
+"@axiomhq/js@1.5.0":
+  version "1.5.0"
+  resolved "https://registry.yarnpkg.com/@axiomhq/js/-/js-1.5.0.tgz#2501d488fe1baa69f87172d88cef506cc904cf92"
+  integrity sha512-7SkfgnrKpjRs86h4TIcoZQ1TltKG0+WcQtMkBa5N3iSuGT5+aIpnbLFrRfbfhwhxzysQkF01qNW4fNUtePqjDg==
+  dependencies:
+    fetch-retry "^6.0.0"
+
+"@axiomhq/pino@^1.5.0":
+  version "1.5.0"
+  resolved "https://registry.yarnpkg.com/@axiomhq/pino/-/pino-1.5.0.tgz#c97896f72551189810d53190e9a8976ffd2e6704"
+  integrity sha512-DaKaauddf+HuEqdwUrvU9RzXavCwjY/ZrVS4lHZpSbRw4i7hET5y8moE3Uo93em/S7ZaUFSOSYsRujZxGecq0A==
+  dependencies:
+    "@axiomhq/js" "1.5.0"
+    pino-abstract-transport "^1.2.0"
+
 "@babel/code-frame@^7.0.0":
   version "7.29.0"
   resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.29.0.tgz#7cd7a59f15b3cc0dcd803038f7792712a7d0b15c"
@@ -2066,7 +2081,7 @@ balanced-match@^4.0.2:
   resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-4.0.4.tgz#bfb10662feed8196a2c62e7c68e17720c274179a"
   integrity sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==
 
-base64-js@^1.3.0:
+base64-js@^1.3.0, base64-js@^1.3.1:
   version "1.5.1"
   resolved "https://registry.yarnpkg.com/base64-js/-/base64-js-1.5.1.tgz#1b1b440160a5bf7ad40b650f095963481903930a"
   integrity sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==
@@ -2103,6 +2118,14 @@ buffer-equal-constant-time@^1.0.1:
   resolved "https://registry.yarnpkg.com/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz#f8e71132f7ffe6e01a5c9697a4c6f3e48d5cc819"
   integrity sha512-zRpUiDwd/xk6ADqPMATG8vc9VPrkck7T07OIx0gnjmJAnHnTVXNQG3vfvWNuiZIkwu9KrKdA1iJKfsfTVxE6NA==
 
+buffer@^6.0.3:
+  version "6.0.3"
+  resolved "https://registry.yarnpkg.com/buffer/-/buffer-6.0.3.tgz#2ace578459cc8fbe2a70aaa8f52ee63b6a74c6c6"
+  integrity sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==
+  dependencies:
+    base64-js "^1.3.1"
+    ieee754 "^1.2.1"
+
 builtin-modules@^3.3.0:
   version "3.3.0"
   resolved "https://registry.yarnpkg.com/builtin-modules/-/builtin-modules-3.3.0.tgz#cae62812b89801e9656336e46223e030386be7b6"
@@ -2734,6 +2757,11 @@ eventid@^2.0.0, eventid@^2.0.1:
   dependencies:
     uuid "^8.0.0"
 
+events@^3.3.0:
+  version "3.3.0"
+  resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400"
+  integrity sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==
+
 expect-type@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/expect-type/-/expect-type-1.3.0.tgz#0d58ed361877a31bbc4dd6cf71bbfef7faf6bd68"
@@ -2849,6 +2877,11 @@ fetch-blob@^3.1.2, fetch-blob@^3.1.4:
     node-domexception "^1.0.0"
     web-streams-polyfill "^3.0.3"
 
+fetch-retry@^6.0.0:
+  version "6.0.0"
+  resolved "https://registry.yarnpkg.com/fetch-retry/-/fetch-retry-6.0.0.tgz#4ffdf92c834d72ae819e42a4ee2a63f1e9454426"
+  integrity sha512-BUFj1aMubgib37I3v4q78fYo63Po7t4HUPTpQ6/QE6yK6cIQrP+W43FYToeTEyg5m2Y7eFUtijUuAv/PDlWuag==
+
 file-entry-cache@^6.0.1:
   version "6.0.1"
   resolved "https://registry.yarnpkg.com/file-entry-cache/-/file-entry-cache-6.0.1.tgz#211b2dd9659cb0394b073e7323ac3c933d522027"
@@ -3278,6 +3311,11 @@ husky@9.1.7:
   resolved "https://registry.yarnpkg.com/husky/-/husky-9.1.7.tgz#d46a38035d101b46a70456a850ff4201344c0b2d"
   integrity sha512-5gs5ytaNjBrh5Ow3zrvdUUY+0VxIuWVL4i9irt6friV+BqdCfmV11CQTWMiBYWHbXhco+J1kHfTOUkePhCDvMA==
 
+ieee754@^1.2.1:
+  version "1.2.1"
+  resolved "https://registry.yarnpkg.com/ieee754/-/ieee754-1.2.1.tgz#8eb7a10a63fff25d15a57b001586d177d1b0d352"
+  integrity sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==
+
 ignore@^5.2.0, ignore@^5.3.2:
   version "5.3.2"
   resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.2.tgz#3cd40e729f3643fd87cb04e50bf0eb722bc596f5"
@@ -4005,6 +4043,14 @@ picomatch@^4.0.2, picomatch@^4.0.3, picomatch@^4.0.4:
   resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-4.0.4.tgz#fd6f5e00a143086e074dffe4c924b8fb293b0589"
   integrity sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==
 
+pino-abstract-transport@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/pino-abstract-transport/-/pino-abstract-transport-1.2.0.tgz#97f9f2631931e242da531b5c66d3079c12c9d1b5"
+  integrity sha512-Guhh8EZfPCfH+PMXAb6rKOjGQEoy0xlAIn+irODG5kgfYV+BQ0rGYYWTIel3P5mmyXqkYkPmdIkywsn6QKUR1Q==
+  dependencies:
+    readable-stream "^4.0.0"
+    split2 "^4.0.0"
+
 pino-abstract-transport@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/pino-abstract-transport/-/pino-abstract-transport-3.0.0.tgz#b21e5f33a297e8c4c915c62b3ce5dd4a87a52c23"
@@ -4118,6 +4164,11 @@ process-warning@^5.0.0:
   resolved "https://registry.yarnpkg.com/process-warning/-/process-warning-5.0.0.tgz#566e0bf79d1dff30a72d8bbbe9e8ecefe8d378d7"
   integrity sha512-a39t9ApHNx2L4+HBnQKqxxHNs1r7KF+Intd8Q/g1bUh6q0WIp9voPXJ/x0j+ZL45KF1pJd9+q2jLIRMfvEshkA==
 
+process@^0.11.10:
+  version "0.11.10"
+  resolved "https://registry.yarnpkg.com/process/-/process-0.11.10.tgz#7332300e840161bda3e69a1d1d91a7d4bc16f182"
+  integrity sha512-cdGef/drWFoydD1JsMzuFf8100nZl+GT+yacc2bEced5f9Rjk4z+WtFUTBu9PhOi9j/jfmBPu0mMEY4wIdAF8A==
+
 proto3-json-serializer@^2.0.2:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/proto3-json-serializer/-/proto3-json-serializer-2.0.2.tgz#5b705203b4d58f3880596c95fad64902617529dd"
@@ -4222,6 +4273,17 @@ readable-stream@^3.1.1:
     string_decoder "^1.1.1"
     util-deprecate "^1.0.1"
 
+readable-stream@^4.0.0:
+  version "4.7.0"
+  resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-4.7.0.tgz#cedbd8a1146c13dfff8dab14068028d58c15ac91"
+  integrity sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==
+  dependencies:
+    abort-controller "^3.0.0"
+    buffer "^6.0.3"
+    events "^3.3.0"
+    process "^0.11.10"
+    string_decoder "^1.3.0"
+
 real-require@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/real-require/-/real-require-0.2.0.tgz#209632dea1810be2ae063a6ac084fee7e33fba78"
@@ -4567,7 +4629,7 @@ string-width@^5.0.1, string-width@^5.1.2:
     emoji-regex "^9.2.2"
     strip-ansi "^7.0.1"
 
-string_decoder@^1.1.1:
+string_decoder@^1.1.1, string_decoder@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e"
   integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==