@tryghost/metrics 3.6.2 → 3.7.1

package/README.md

@@ -29,6 +29,19 @@ const custom = new metrics.GhostMetrics({
 });
 ```
 
+### Elasticsearch client implementation
+
+`elasticsearch.implementation` picks how the Elasticsearch transport talks to
+the cluster. `legacy` (the default) uses the official `@elastic/elasticsearch`
+client; `fetch` uses Node's built-in `fetch`. The `fetch` implementation will
+become the only one in the next major version.
+
+`elasticsearch.proxy` only works with `legacy`. With `fetch`, it's ignored with
+a warning: set `HTTP_PROXY` or `HTTPS_PROXY` to match the Elasticsearch URL's
+scheme (and `NO_PROXY` as needed), and enable them with `NODE_USE_ENV_PROXY=1`
+or `--use-env-proxy`. This needs Node 22.21.0+ on the 22.x line, or Node 24+,
+and applies to every request the process makes.
+
 ### Sampling
 
 High-volume metrics can be sampled so only a proportion of them are shipped.

package/lib/GhostMetrics.d.ts

@@ -10,8 +10,17 @@ interface ElasticsearchOptions {
     username?: string;
     /** Basic-auth password. */
     password?: string;
-    /** Optional proxy URL; when absent no proxy is used. */
+    /**
+     * Optional proxy URL; when absent no proxy is used. Only supported by the
+     * `legacy` implementation; with `fetch`, set `HTTP_PROXY`/`HTTPS_PROXY` and
+     * `NODE_USE_ENV_PROXY=1` (Node 22.21.0+ or 24+) instead.
+     */
     proxy?: string;
+    /**
+     * Client implementation: `legacy` uses the official Elasticsearch client,
+     * `fetch` uses Node's built-in fetch. @default 'legacy'
+     */
+    implementation?: 'legacy' | 'fetch';
 }
 
 /**

package/lib/GhostMetrics.js

@@ -277,7 +277,17 @@ class GhostMetrics {
     setupElasticsearchShipper() {
         const ElasticSearch = require('@tryghost/elasticsearch');
 
+        const implementation = this.elasticsearch.implementation;
+
+        if (implementation === 'fetch' && this.elasticsearch.proxy) {
+            process.emitWarning(
+                'elasticsearch.proxy is not supported by the fetch implementation and is ignored. Set HTTP_PROXY/HTTPS_PROXY and NODE_USE_ENV_PROXY=1 (Node 22.21.0+ or 24+) to proxy Elasticsearch requests.',
+                { code: 'GHOST_METRICS_ELASTICSEARCH_PROXY' },
+            );
+        }
+
         const elasticSearch = new ElasticSearch({
+            implementation,
             node: this.elasticsearch.host,
             auth: {
                 username: this.elasticsearch.username,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/metrics",
-  "version": "3.6.2",
+  "version": "3.7.1",
   "license": "MIT",
   "author": "Ghost Foundation",
   "repository": {
@@ -19,9 +19,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@tryghost/elasticsearch": "^5.4.13",
-    "@tryghost/pretty-stream": "^2.3.16",
-    "@tryghost/root-utils": "^2.3.16",
+    "@tryghost/elasticsearch": "^6.0.1",
+    "@tryghost/pretty-stream": "^2.3.18",
+    "@tryghost/root-utils": "^2.3.18",
     "json-stringify-safe": "^5.0.1"
   },
   "devDependencies": {
@@ -29,7 +29,7 @@
   },
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing vitest run --coverage",
+    "test": "NODE_ENV=testing vitest run --config ../../vitest.config.ts --root . --coverage",
     "lint": "oxlint -c ../../.oxlintrc.json .",
     "posttest": "pnpm run lint"
   }