@tryghost/metrics 3.3.5 → 3.4.1

package/index.d.ts

@@ -0,0 +1,3 @@
+import metrics = require('./lib/metrics');
+
+export = metrics;

package/lib/GhostMetrics.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Elasticsearch transport configuration.
+ */
+interface ElasticsearchOptions {
+    /** Elasticsearch node URL (maps to the client `node` option). */
+    host?: string;
+    /** Basic-auth username. */
+    username?: string;
+    /** Basic-auth password. */
+    password?: string;
+    /** Optional proxy URL; when absent no proxy is used. */
+    proxy?: string;
+}
+
+/**
+ * Metrics-specific configuration, piggy-backed on the logging config.
+ */
+interface MetricsOptions {
+    /** Transports to ship metrics through (e.g. `['stdout', 'elasticsearch']`). */
+    transports?: string[];
+    /** Property bag of metadata values shipped alongside each metric value. */
+    metadata?: Record<string, unknown>;
+}
+
+/**
+ * Options bag accepted by the {@link GhostMetrics} constructor.
+ */
+interface GhostMetricsOptions {
+    /** Metadata for metrics in shared databases. @default 'localhost' */
+    domain?: string;
+    /** Print short or long log form for the stdout shipper. @default 'short' */
+    mode?: string;
+    /** Elasticsearch transport configuration. */
+    elasticsearch?: ElasticsearchOptions;
+    /** Metric transport/metadata configuration. */
+    metrics?: MetricsOptions;
+}
+
+/**
+ * A single metric shipper function keyed by transport name.
+ */
+type MetricShipper = (name: string, value: unknown) => Promise<unknown>;
+
+/**
+ * Metric shipper class built on the loggingrc config used in Ghost projects.
+ */
+declare class GhostMetrics {
+    domain: string;
+    elasticsearch: ElasticsearchOptions;
+    mode: string;
+    transports: string[];
+    metadata: Record<string, unknown>;
+    shippers: Record<string, MetricShipper>;
+
+    constructor(options?: GhostMetricsOptions);
+
+    /**
+     * Setup stdout stream shipper.
+     */
+    setupStdoutShipper(): void;
+
+    /**
+     * Setup ElasticSearch metric shipper. Metrics are shipped to a per-metric
+     * index named `metrics-<name>`; the metric name should be sluggified.
+     */
+    setupElasticsearchShipper(): void;
+
+    /**
+     * Ship a metric through every configured transport.
+     * @param name Metric name, should be slugified for back-end compatibility (e.g. `"memory-usage"`).
+     * @param value Metric value; coerced to an object before being shipped.
+     */
+    metric(name: string, value: unknown): Promise<null>;
+}
+
+declare namespace GhostMetrics {
+    export { ElasticsearchOptions, MetricsOptions, GhostMetricsOptions, MetricShipper };
+}
+
+export = GhostMetrics;

package/lib/metrics.d.ts

@@ -0,0 +1,18 @@
+import GhostMetrics = require('./GhostMetrics');
+
+/**
+ * A pre-configured `GhostMetrics` instance (built from `loggingrc` if present),
+ * with the `GhostMetrics` class attached for creating additional instances.
+ */
+declare const metrics: GhostMetrics & {
+    GhostMetrics: typeof GhostMetrics;
+};
+
+declare namespace metrics {
+    export type ElasticsearchOptions = GhostMetrics.ElasticsearchOptions;
+    export type MetricsOptions = GhostMetrics.MetricsOptions;
+    export type GhostMetricsOptions = GhostMetrics.GhostMetricsOptions;
+    export type MetricShipper = GhostMetrics.MetricShipper;
+}
+
+export = metrics;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/metrics",
-  "version": "3.3.5",
+  "version": "3.4.1",
   "license": "MIT",
   "author": "Ghost Foundation",
   "repository": {
@@ -10,17 +10,19 @@
   },
   "files": [
     "index.js",
+    "index.d.ts",
     "lib"
   ],
   "main": "index.js",
+  "types": "index.d.ts",
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
     "json-stringify-safe": "5.0.1",
-    "@tryghost/elasticsearch": "5.4.2",
-    "@tryghost/pretty-stream": "2.3.5",
-    "@tryghost/root-utils": "2.3.5"
+    "@tryghost/elasticsearch": "5.4.4",
+    "@tryghost/pretty-stream": "2.3.7",
+    "@tryghost/root-utils": "2.3.7"
   },
   "devDependencies": {
     "rewire": "9.0.1",