@oneuptime/common 14.0.3 → 14.0.6

package/Tests/Types/DatabaseServer/DatabaseServerMetricCatalog.test.ts

@@ -0,0 +1,1161 @@
+import {
+  DATABASE_SERVER_INSTANCE_ATTRIBUTE_KEYS,
+  DATABASE_SERVER_METRICS,
+  DatabaseServerMetricDefinition,
+  findDatabaseServerMetricByName,
+  getDatabaseServerMetricGroupKeys,
+  getDatabaseServerMetricId,
+  getDatabaseServerMetrics,
+} from "../../../Types/DatabaseServer/DatabaseServerMetricCatalog";
+import {
+  DatabaseSystemDescriptor,
+  getDatabaseSystemDescriptor,
+} from "../../../Types/DatabaseServer/DatabaseSystem";
+import AggregationType from "../../../Types/BaseDatabase/AggregationType";
+import { describe, expect, test } from "@jest/globals";
+import fs from "fs";
+import path from "path";
+
+const AGENT_CONFIG_DIR: string = path.join(
+  __dirname,
+  "..",
+  "..",
+  "..",
+  "..",
+  "..",
+  "agents",
+  "DatabaseAgent",
+  "configs",
+);
+
+// The Database Agent's config for a receiver (sqlserver.yaml, oracledb.yaml).
+function readAgentConfig(receiver: string): string {
+  return fs.readFileSync(
+    path.join(AGENT_CONFIG_DIR, `${receiver}.yaml`),
+    "utf8",
+  );
+}
+
+const CURATED_SYSTEMS: Array<string> = [
+  "postgresql",
+  "mysql",
+  "redis",
+  "mongodb",
+  "microsoft.sql_server",
+  "oracle.db",
+  "elasticsearch",
+  "memcached",
+];
+
+/*
+ * Cumulative monotonic sums per the receivers' metadata.yaml (research map
+ * otel-db-receivers.md §2). Each MUST be a "counter" — charting the raw value
+ * would draw an ever-rising line.
+ */
+const KNOWN_CUMULATIVE_COUNTERS: Array<string> = [
+  "postgresql.commits",
+  "postgresql.rollbacks",
+  "mysql.handlers",
+  "mysql.row_operations",
+  "mysql.row_locks",
+  "redis.commands.processed",
+  "redis.keyspace.hits",
+  "redis.keyspace.misses",
+  "redis.keys.evicted",
+  "mongodb.operation.count",
+  "mongodb.operation.time",
+  "mongodb.cache.operations",
+  "oracledb.executions",
+  "oracledb.user_commits",
+  "oracledb.physical_reads",
+  "oracledb.db.time",
+  /*
+   * Named "*.rate", but over a direct connection the receiver passes SQL
+   * Server's cumulative cntr_value through: a live capture read
+   * batch.request.rate 8, 13, 18, 23, 28, 33 on consecutive 10 s scrapes of
+   * an idle server. Charted as a gauge they would show an ever-growing
+   * number labelled per second.
+   */
+  "sqlserver.batch.request.rate",
+  "sqlserver.batch.sql_compilation.rate",
+  "sqlserver.lock.wait.rate",
+  "sqlserver.deadlock.rate",
+  "elasticsearch.node.operations.completed",
+  "memcached.operations",
+  "memcached.commands",
+  "memcached.evictions",
+];
+
+/*
+ * Receiver-computed per-second gauges and point-in-time values: never a
+ * counter (a rate of a rate is meaningless).
+ */
+const KNOWN_GAUGES: Array<string> = [
+  "postgresql.backends",
+  "postgresql.connection.max",
+  "postgresql.db_size",
+  "redis.commands",
+  "redis.memory.used",
+  "sqlserver.processes.blocked",
+  "sqlserver.page.buffer_cache.hit_ratio",
+  "oracledb.sessions.usage",
+  "oracledb.sga.usage",
+  "oracledb.tablespace.utilization",
+  // Non-monotonic sums: a level, however the receiver types it.
+  "mysql.buffer_pool.pages",
+  "elasticsearch.cluster.health",
+  "elasticsearch.cluster.nodes",
+  "elasticsearch.cluster.shards",
+  "elasticsearch.cluster.pending_tasks",
+  "elasticsearch.node.fs.disk.available",
+  "jvm.memory.heap.utilization",
+  "memcached.connections.current",
+  "memcached.bytes",
+  "memcached.current_items",
+];
+
+/*
+ * Off-by-default receiver metrics (otel-db-receivers.md §8.5) the Database
+ * Agent does NOT switch on. Nothing arrives for them on a default setup, so
+ * none of these may appear.
+ */
+const OFF_BY_DEFAULT: Array<string> = [
+  "postgresql.deadlocks",
+  "postgresql.blks_hit",
+  "postgresql.blks_read",
+  "postgresql.database.locks",
+  "mysql.query.count",
+  "mysql.query.slow.count",
+  "mysql.commands",
+  "mysql.connection.count",
+  "mysql.replica.time_behind_source",
+  "redis.maxmemory",
+  "redis.cmd.latency",
+  "mongodb.replica_set.lag",
+  "mongodb.lock.deadlock.count",
+  "sqlserver.lock.timeout.rate",
+  "sqlserver.memory.usage",
+  "oracledb.logons",
+  "oracledb.transaction.rollbacks",
+];
+
+/*
+ * Default-on in the receiver's metadata, yet measured never to arrive on
+ * the Database Agent's default setups (collector-contrib 0.161.0): SQL
+ * Server 2022 on Linux, connected directly, has no Windows performance
+ * counters behind the first two; Oracle Free 23 connected to its pluggable
+ * database (FREEPDB1) returned neither of the last two in 90 seconds. A
+ * tile for one of them would stay empty forever.
+ */
+const NEVER_ARRIVE_ON_DEFAULT_SETUPS: Array<string> = [
+  "sqlserver.transaction.rate",
+  "sqlserver.transaction_log.usage",
+  "oracledb.processes.usage",
+  "oracledb.sessions.limit",
+];
+
+/*
+ * The datapoint attributes each curated metric carries, from the v0.161.0
+ * receivers' metadata.yaml (with name_override applied, as ingest stores
+ * them). Every one of them splits the metric into several series, so each
+ * catalog entry has to say what happens to it: pinned by `attributes`,
+ * added up / maxed through `seriesKeys`, or pooled as a repeat through
+ * `duplicatedAcross`.
+ */
+const RECEIVER_DATAPOINT_ATTRIBUTES: Record<string, Array<string>> = {
+  "postgresql.backends": ["db.namespace"],
+  "postgresql.commits": ["db.namespace"],
+  "postgresql.rollbacks": ["db.namespace"],
+  "postgresql.db_size": ["db.namespace"],
+  "postgresql.replication.data_delay": ["replication_client"],
+  "mysql.threads": ["kind"],
+  "mysql.buffer_pool.usage": ["status"],
+  "mysql.handlers": ["kind"],
+  "mysql.row_operations": ["operation"],
+  "mysql.row_locks": ["kind"],
+  "mongodb.connection.count": ["type", "db.namespace"],
+  "mongodb.memory.usage": ["type", "db.namespace"],
+  "mongodb.data.size": ["db.namespace"],
+  "mongodb.operation.count": ["operation"],
+  "mongodb.operation.time": ["operation"],
+  "mongodb.cache.operations": ["type"],
+  "sqlserver.page.life_expectancy": ["performance_counter.object_name"],
+  "oracledb.sessions.usage": [
+    "session_type",
+    "session_status",
+    "oracle.db.pdb",
+  ],
+  "oracledb.tablespace_size.usage": ["tablespace_name", "oracle.db.pdb"],
+  "oracledb.executions": ["oracle.db.pdb"],
+  "oracledb.user_commits": ["oracle.db.pdb"],
+  "oracledb.physical_reads": ["oracle.db.pdb"],
+  "oracledb.db.time": ["oracledb.session.type"],
+  "oracledb.sga.usage": ["oracledb.sga.component.name"],
+  "oracledb.tablespace.utilization": ["tablespace_name", "oracle.db.pdb"],
+  "mysql.buffer_pool.pages": ["kind"],
+  "elasticsearch.cluster.health": ["status"],
+  "elasticsearch.cluster.shards": ["state"],
+  "elasticsearch.node.operations.completed": ["operation"],
+  // Recorded once per node: the node is a resource attribute.
+  "elasticsearch.node.fs.disk.available": ["resource.elasticsearch.node.name"],
+  "jvm.memory.heap.utilization": ["resource.elasticsearch.node.name"],
+  "memcached.commands": ["command"],
+  "memcached.operations": ["type", "operation"],
+};
+
+/*
+ * Every metric the e2e run's Database Agents (collector-contrib 0.161.0)
+ * delivered for these engines, read back from ClickHouse: Elasticsearch
+ * 8.15.3, OpenSearch 2.17.1 (the same receiver), Memcached 1.6, MySQL
+ * 8.4.11 and MariaDB 11.4.13 (the same receiver). A curated tile for
+ * anything else would stay empty.
+ */
+const SEEN_ARRIVING_FROM_AGENT: Record<string, Array<string>> = {
+  mysql: [
+    "mysql.buffer_pool.data_pages",
+    "mysql.buffer_pool.limit",
+    "mysql.buffer_pool.operations",
+    "mysql.buffer_pool.page_flushes",
+    "mysql.buffer_pool.pages",
+    "mysql.buffer_pool.usage",
+    "mysql.client.network.io",
+    "mysql.commands",
+    "mysql.connection.count",
+    "mysql.connection.errors",
+    "mysql.double_writes",
+    "mysql.handlers",
+    "mysql.locks",
+    "mysql.log_operations",
+    "mysql.max_used_connections",
+    "mysql.mysqlx_connections",
+    "mysql.opened_resources",
+    "mysql.operations",
+    "mysql.page_operations",
+    "mysql.prepared_statements",
+    "mysql.query.count",
+    "mysql.query.slow.count",
+    "mysql.row_locks",
+    "mysql.row_operations",
+    "mysql.sorts",
+    "mysql.threads",
+    "mysql.tmp_resources",
+    "mysql.uptime",
+  ],
+  // No mysql.row_operations: MariaDB has no Innodb_rows_* status counters.
+  mariadb: [
+    "mysql.buffer_pool.data_pages",
+    "mysql.buffer_pool.limit",
+    "mysql.buffer_pool.operations",
+    "mysql.buffer_pool.page_flushes",
+    "mysql.buffer_pool.pages",
+    "mysql.buffer_pool.usage",
+    "mysql.client.network.io",
+    "mysql.commands",
+    "mysql.connection.count",
+    "mysql.connection.errors",
+    "mysql.double_writes",
+    "mysql.handlers",
+    "mysql.locks",
+    "mysql.log_operations",
+    "mysql.max_used_connections",
+    "mysql.opened_resources",
+    "mysql.operations",
+    "mysql.page_operations",
+    "mysql.prepared_statements",
+    "mysql.query.count",
+    "mysql.query.slow.count",
+    "mysql.row_locks",
+    "mysql.sorts",
+    "mysql.threads",
+    "mysql.tmp_resources",
+    "mysql.uptime",
+  ],
+  elasticsearch: [
+    "elasticsearch.breaker.memory.estimated",
+    "elasticsearch.breaker.memory.limit",
+    "elasticsearch.breaker.tripped",
+    "elasticsearch.cluster.data_nodes",
+    "elasticsearch.cluster.health",
+    "elasticsearch.cluster.in_flight_fetch",
+    "elasticsearch.cluster.nodes",
+    "elasticsearch.cluster.pending_tasks",
+    "elasticsearch.cluster.shards",
+    "elasticsearch.cluster.state_queue",
+    "elasticsearch.index.documents",
+    "elasticsearch.index.operations.completed",
+    "elasticsearch.node.cache.evictions",
+    "elasticsearch.node.documents",
+    "elasticsearch.node.fs.disk.available",
+    "elasticsearch.node.fs.disk.total",
+    "elasticsearch.node.http.connections",
+    "elasticsearch.node.operations.completed",
+    "elasticsearch.node.operations.current",
+    "elasticsearch.node.thread_pool.tasks.finished",
+    "elasticsearch.node.thread_pool.tasks.queued",
+    "elasticsearch.os.cpu.usage",
+    "elasticsearch.process.cpu.usage",
+    "jvm.memory.heap.max",
+    "jvm.memory.heap.used",
+    "jvm.memory.heap.utilization",
+  ],
+  opensearch: [
+    "elasticsearch.breaker.tripped",
+    "elasticsearch.cluster.data_nodes",
+    "elasticsearch.cluster.health",
+    "elasticsearch.cluster.nodes",
+    "elasticsearch.cluster.pending_tasks",
+    "elasticsearch.cluster.shards",
+    "elasticsearch.index.documents",
+    "elasticsearch.node.documents",
+    "elasticsearch.node.fs.disk.available",
+    "elasticsearch.node.operations.completed",
+    "elasticsearch.node.operations.current",
+    "elasticsearch.node.thread_pool.tasks.finished",
+    "jvm.memory.heap.max",
+    "jvm.memory.heap.used",
+    "jvm.memory.heap.utilization",
+  ],
+  memcached: [
+    "memcached.bytes",
+    "memcached.commands",
+    "memcached.connections.current",
+    "memcached.connections.total",
+    "memcached.cpu.usage",
+    "memcached.current_items",
+    "memcached.evictions",
+    "memcached.network",
+    "memcached.operation_hit_ratio",
+    "memcached.operations",
+    "memcached.threads",
+  ],
+};
+
+function metricByName(name: string): DatabaseServerMetricDefinition {
+  const metric: DatabaseServerMetricDefinition | undefined =
+    DATABASE_SERVER_METRICS.find(
+      (candidate: DatabaseServerMetricDefinition): boolean => {
+        return candidate.metricName === name;
+      },
+    );
+  expect(metric).toBeDefined();
+  return metric!;
+}
+
+function entriesNamed(name: string): Array<DatabaseServerMetricDefinition> {
+  return DATABASE_SERVER_METRICS.filter(
+    (candidate: DatabaseServerMetricDefinition): boolean => {
+      return candidate.metricName === name;
+    },
+  );
+}
+
+describe("DATABASE_SERVER_METRICS", () => {
+  test.each(CURATED_SYSTEMS)("%s has 5-8 curated metrics", (system: string) => {
+    const count: number = getDatabaseServerMetrics(system).length;
+    expect(count).toBeGreaterThanOrEqual(5);
+    expect(count).toBeLessThanOrEqual(8);
+  });
+
+  test("only the curated engines have entries", () => {
+    const systems: Set<string> = new Set<string>(
+      DATABASE_SERVER_METRICS.map(
+        (metric: DatabaseServerMetricDefinition): string => {
+          return metric.system;
+        },
+      ),
+    );
+    expect(Array.from(systems).sort()).toEqual([...CURATED_SYSTEMS].sort());
+  });
+
+  test("entry ids are unique; names are lowercase, as ingest stores them", () => {
+    const ids: Array<string> = DATABASE_SERVER_METRICS.map(
+      (metric: DatabaseServerMetricDefinition): string => {
+        return getDatabaseServerMetricId(metric);
+      },
+    );
+    expect(new Set(ids).size).toBe(ids.length);
+    for (const metric of DATABASE_SERVER_METRICS) {
+      expect(metric.metricName).toBe(metric.metricName.toLowerCase());
+      expect(metric.metricName).toBe(metric.metricName.trim());
+    }
+  });
+
+  test("a metric backs several entries only when each pins a different value", () => {
+    const byName: Map<
+      string,
+      Array<DatabaseServerMetricDefinition>
+    > = new Map();
+    for (const metric of DATABASE_SERVER_METRICS) {
+      byName.set(metric.metricName, [
+        ...(byName.get(metric.metricName) || []),
+        metric,
+      ]);
+    }
+    for (const [, entries] of byName) {
+      if (entries.length < 2) {
+        continue;
+      }
+      for (const entry of entries) {
+        expect(Object.keys(entry.attributes || {}).length).toBeGreaterThan(0);
+      }
+    }
+  });
+
+  test("every metric carries its engine's receiver prefix", () => {
+    for (const metric of DATABASE_SERVER_METRICS) {
+      const descriptor: DatabaseSystemDescriptor | null =
+        getDatabaseSystemDescriptor(metric.system);
+      expect(descriptor).not.toBeNull();
+      /*
+       * The Elasticsearch receiver also emits the node JVM's `jvm.*`
+       * metrics in the same batch — the one sanctioned exception.
+       */
+      if (
+        metric.system === "elasticsearch" &&
+        metric.metricName.startsWith("jvm.")
+      ) {
+        continue;
+      }
+      expect(
+        descriptor!.receiverMetricPrefixes.some((prefix: string): boolean => {
+          return metric.metricName.startsWith(prefix);
+        }),
+      ).toBe(true);
+    }
+  });
+
+  test("every entry is fully described", () => {
+    for (const metric of DATABASE_SERVER_METRICS) {
+      expect(metric.title.trim().length).toBeGreaterThan(0);
+      expect(metric.description.trim().length).toBeGreaterThan(0);
+      expect(metric.unit.trim().length).toBeGreaterThan(0);
+      expect(Object.values(AggregationType)).toContain(metric.aggregation);
+      expect(["gauge", "counter"]).toContain(metric.kind);
+      expect(["sum", "max", "min", "avg"]).toContain(metric.seriesCombine);
+    }
+  });
+
+  test("titles are unique within an engine", () => {
+    for (const system of CURATED_SYSTEMS) {
+      const titles: Array<string> = getDatabaseServerMetrics(system).map(
+        (metric: DatabaseServerMetricDefinition): string => {
+          return metric.title;
+        },
+      );
+      expect(new Set(titles).size).toBe(titles.length);
+    }
+  });
+
+  test.each(KNOWN_CUMULATIVE_COUNTERS)(
+    "%s is a counter (charted as a rate)",
+    (name: string) => {
+      expect(metricByName(name).kind).toBe("counter");
+    },
+  );
+
+  test("counters read Max per series per bucket, and their rates add up", () => {
+    for (const metric of DATABASE_SERVER_METRICS) {
+      if (metric.kind === "counter") {
+        // The latest cumulative value of ONE series in the bucket.
+        expect(metric.aggregation).toBe(AggregationType.Max);
+        // Rates of separate series are parts of one total.
+        expect(metric.seriesCombine).toBe("sum");
+        // Counters are split by their whole attribute set, never by a list.
+        expect(metric.seriesKeys).toBeUndefined();
+        expect(metric.duplicatedAcross).toBeUndefined();
+      }
+    }
+  });
+
+  test.each(KNOWN_GAUGES)("%s is a gauge", (name: string) => {
+    expect(metricByName(name).kind).toBe("gauge");
+  });
+
+  test("SQL Server's *.rate metrics are charted as rates of running totals", () => {
+    /*
+     * The agent connects directly, where the receiver reports each
+     * "per second" counter as SQL Server's cumulative cntr_value.
+     */
+    const kinds: Record<string, string> = {};
+    for (const metric of getDatabaseServerMetrics("microsoft.sql_server")) {
+      kinds[metric.metricName] = metric.kind;
+    }
+    expect(kinds).toEqual({
+      "sqlserver.user.connection.count": "gauge",
+      "sqlserver.batch.request.rate": "counter",
+      "sqlserver.batch.sql_compilation.rate": "counter",
+      "sqlserver.page.buffer_cache.hit_ratio": "gauge",
+      "sqlserver.page.life_expectancy": "gauge",
+      "sqlserver.lock.wait.rate": "counter",
+      "sqlserver.deadlock.rate": "counter",
+      "sqlserver.processes.blocked": "gauge",
+    });
+    for (const metric of getDatabaseServerMetrics("microsoft.sql_server")) {
+      if (metric.kind === "counter") {
+        // A rate is computed from the latest total in each bucket.
+        expect(metric.aggregation).toBe(AggregationType.Max);
+        expect(metric.unit).not.toContain("/s");
+      }
+    }
+  });
+
+  test("every engine has at least one gauge for the Overview tiles", () => {
+    for (const system of CURATED_SYSTEMS) {
+      expect(
+        getDatabaseServerMetrics(system).some(
+          (metric: DatabaseServerMetricDefinition): boolean => {
+            return metric.kind === "gauge";
+          },
+        ),
+      ).toBe(true);
+    }
+  });
+
+  test.each(OFF_BY_DEFAULT)(
+    "%s (off by default, and left off by the agent) is not curated",
+    (name: string) => {
+      expect(
+        DATABASE_SERVER_METRICS.some(
+          (metric: DatabaseServerMetricDefinition): boolean => {
+            return metric.metricName === name;
+          },
+        ),
+      ).toBe(false);
+    },
+  );
+
+  test.each(NEVER_ARRIVE_ON_DEFAULT_SETUPS)(
+    "%s (never arrives on the agent's default setup) is not curated",
+    (name: string) => {
+      expect(entriesNamed(name)).toEqual([]);
+    },
+  );
+
+  /*
+   * An optional receiver metric is curated only because the Database Agent
+   * switches it on; if the agent's config stopped doing so, the tile would
+   * go empty. Every other entry must not be switched OFF by the agent.
+   */
+  test("every off-by-default entry is switched on by the agent's config for its receiver", () => {
+    const optional: Array<DatabaseServerMetricDefinition> =
+      DATABASE_SERVER_METRICS.filter(
+        (metric: DatabaseServerMetricDefinition): boolean => {
+          return metric.enabledByDefault === false;
+        },
+      );
+    expect(
+      optional
+        .map((metric: DatabaseServerMetricDefinition): string => {
+          return metric.metricName;
+        })
+        .sort(),
+    ).toEqual([
+      "jvm.memory.heap.utilization",
+      "oracledb.db.time",
+      "oracledb.sga.usage",
+      "oracledb.tablespace.utilization",
+      "sqlserver.deadlock.rate",
+      "sqlserver.processes.blocked",
+    ]);
+
+    for (const metric of optional) {
+      const receiver: string = getDatabaseSystemDescriptor(metric.system)!
+        .receiverTypes[0]!;
+      const config: string = readAgentConfig(receiver);
+      expect({
+        metric: metric.metricName,
+        enabledByAgent: config.includes(
+          `      ${metric.metricName}:\n        enabled: true`,
+        ),
+      }).toEqual({ metric: metric.metricName, enabledByAgent: true });
+      // The tile's (i) tells a team with its own collector to switch it on.
+      expect(metric.description).toContain("Off by default");
+      expect(metric.description).toContain("Database Agent switches it on");
+    }
+  });
+
+  test("no default-on entry is switched off by the agent", () => {
+    for (const metric of DATABASE_SERVER_METRICS) {
+      const descriptor: DatabaseSystemDescriptor | null =
+        getDatabaseSystemDescriptor(metric.system);
+      const config: string = readAgentConfig(descriptor!.receiverTypes[0]!);
+      expect({
+        metric: metric.metricName,
+        disabled: config.includes(
+          `      ${metric.metricName}:\n        enabled: false`,
+        ),
+      }).toEqual({ metric: metric.metricName, disabled: false });
+      if (metric.enabledByDefault !== false) {
+        expect(metric.description).not.toContain("Off by default");
+      }
+    }
+  });
+
+  test("SQL Server's tiles are the ones a directly connected server fills", () => {
+    expect(
+      getDatabaseServerMetrics("microsoft.sql_server").map(
+        (metric: DatabaseServerMetricDefinition): string => {
+          return metric.metricName;
+        },
+      ),
+    ).toEqual([
+      "sqlserver.user.connection.count",
+      "sqlserver.batch.request.rate",
+      "sqlserver.batch.sql_compilation.rate",
+      "sqlserver.page.buffer_cache.hit_ratio",
+      "sqlserver.page.life_expectancy",
+      "sqlserver.lock.wait.rate",
+      "sqlserver.deadlock.rate",
+      "sqlserver.processes.blocked",
+    ]);
+  });
+
+  test("Oracle's tiles are the ones a pluggable-database connection fills", () => {
+    expect(
+      getDatabaseServerMetrics("oracle.db").map(
+        (metric: DatabaseServerMetricDefinition): string => {
+          return metric.metricName;
+        },
+      ),
+    ).toEqual([
+      "oracledb.sessions.usage",
+      "oracledb.db.time",
+      "oracledb.sga.usage",
+      "oracledb.tablespace.utilization",
+      "oracledb.tablespace_size.usage",
+      "oracledb.executions",
+      "oracledb.user_commits",
+      "oracledb.physical_reads",
+    ]);
+  });
+});
+
+/*
+ * The audit's failure scenarios: a tile that averaged MongoDB's available
+ * connections into "Connections", averaged MySQL's lifetime Threads_created
+ * into "Threads", showed the per-database MEAN of PostgreSQL backends next
+ * to the server-wide max_connections, and took the Max of MySQL's row-lock
+ * waits and row-lock TIME counters.
+ */
+describe("how each metric's series combine", () => {
+  test.each(Object.keys(RECEIVER_DATAPOINT_ATTRIBUTES))(
+    "%s declares what happens to every attribute that splits it",
+    (name: string) => {
+      const entries: Array<DatabaseServerMetricDefinition> = entriesNamed(name);
+      expect(entries.length).toBeGreaterThan(0);
+
+      for (const entry of entries) {
+        if (entry.kind === "counter") {
+          // Every distinct attribute set is its own series; nothing to list.
+          continue;
+        }
+        const maxOfMax: boolean =
+          entry.aggregation === AggregationType.Max &&
+          entry.seriesCombine === "max";
+        for (const attribute of RECEIVER_DATAPOINT_ATTRIBUTES[name]!) {
+          const declared: boolean =
+            Object.keys(entry.attributes || {}).includes(attribute) ||
+            (entry.seriesKeys || []).includes(attribute) ||
+            (entry.duplicatedAcross || []).includes(attribute) ||
+            maxOfMax;
+          expect({ metric: name, attribute, declared }).toEqual({
+            metric: name,
+            attribute,
+            declared: true,
+          });
+        }
+      }
+    },
+  );
+
+  test("MongoDB connections are the CURRENT ones, never averaged with available", () => {
+    const connections: DatabaseServerMetricDefinition = metricByName(
+      "mongodb.connection.count",
+    );
+    expect(connections.attributes).toEqual({ type: "current" });
+    // Repeated once per database by the receiver: pooled, not added up.
+    expect(connections.duplicatedAcross).toContain("db.namespace");
+    expect(connections.seriesKeys).toBeUndefined();
+  });
+
+  test("MongoDB memory is resident memory, not resident averaged with virtual", () => {
+    const memory: DatabaseServerMetricDefinition = metricByName(
+      "mongodb.memory.usage",
+    );
+    expect(memory.attributes).toEqual({ type: "resident" });
+    expect(memory.title).toBe("Resident memory");
+  });
+
+  test("MySQL threads are split into connected and running; created and cached never mix in", () => {
+    const threads: Array<DatabaseServerMetricDefinition> =
+      entriesNamed("mysql.threads");
+    expect(
+      threads.map((entry: DatabaseServerMetricDefinition) => {
+        return [entry.title, entry.attributes];
+      }),
+    ).toEqual([
+      ["Connected threads", { kind: "connected" }],
+      ["Running threads", { kind: "running" }],
+    ]);
+  });
+
+  test("PostgreSQL connections add up across databases", () => {
+    const backends: DatabaseServerMetricDefinition = metricByName(
+      "postgresql.backends",
+    );
+    expect(backends.seriesCombine).toBe("sum");
+    expect(backends.seriesKeys).toEqual([
+      "db.namespace",
+      "resource.postgresql.database.name",
+    ]);
+  });
+
+  test("the InnoDB buffer pool adds its clean and dirty pages", () => {
+    const pool: DatabaseServerMetricDefinition = metricByName(
+      "mysql.buffer_pool.usage",
+    );
+    expect(pool.seriesKeys).toEqual(["status"]);
+    expect(pool.seriesCombine).toBe("sum");
+  });
+
+  test("Oracle sessions add every type, status and PDB", () => {
+    const sessions: DatabaseServerMetricDefinition = metricByName(
+      "oracledb.sessions.usage",
+    );
+    expect(sessions.seriesKeys).toEqual([
+      "session_type",
+      "session_status",
+      "oracle.db.pdb",
+    ]);
+    expect(sessions.seriesCombine).toBe("sum");
+  });
+
+  test("row lock waits count waits, never the cumulative lock time", () => {
+    expect(metricByName("mysql.row_locks").attributes).toEqual({
+      kind: "waits",
+    });
+  });
+
+  test("worst-of metrics keep the worst series", () => {
+    for (const name of [
+      "postgresql.replication.data_delay",
+      "postgresql.db_size",
+      "postgresql.wal.age",
+      "oracledb.tablespace_size.usage",
+      "oracledb.tablespace.utilization",
+    ]) {
+      expect({ name, combine: metricByName(name).seriesCombine }).toEqual({
+        name,
+        combine: "max",
+      });
+    }
+    // The member that restarted last, not the longest-running one.
+    expect(metricByName("mysql.uptime").seriesCombine).toBe("min");
+    expect(metricByName("sqlserver.page.life_expectancy").seriesCombine).toBe(
+      "min",
+    );
+  });
+
+  test("ratios are averaged, never added", () => {
+    for (const name of [
+      "redis.memory.fragmentation_ratio",
+      "sqlserver.page.buffer_cache.hit_ratio",
+    ]) {
+      expect(metricByName(name).seriesCombine).toBe("avg");
+    }
+  });
+
+  test("settings are not added up across replicas", () => {
+    for (const name of [
+      "postgresql.connection.max",
+      "postgresql.database.count",
+      "mysql.buffer_pool.pages",
+    ]) {
+      expect(metricByName(name).seriesCombine).toBe("max");
+    }
+  });
+
+  test("Oracle DB time is the users' load: foreground sessions only, as a rate", () => {
+    const dbTime: DatabaseServerMetricDefinition =
+      metricByName("oracledb.db.time");
+    expect(dbTime.kind).toBe("counter");
+    expect(dbTime.attributes).toEqual({
+      "oracledb.session.type": "foreground",
+    });
+    expect(dbTime.unit).toBe("s");
+  });
+
+  test("the SGA adds its components; tablespace fullness is a 0..1 share", () => {
+    const sga: DatabaseServerMetricDefinition =
+      metricByName("oracledb.sga.usage");
+    expect(sga.seriesKeys).toEqual(["oracledb.sga.component.name"]);
+    expect(sga.seriesCombine).toBe("sum");
+    expect(sga.unit).toBe("bytes");
+
+    const fullest: DatabaseServerMetricDefinition = metricByName(
+      "oracledb.tablespace.utilization",
+    );
+    // The receiver reports 0..1 (unit "1"); the tile shows a percentage.
+    expect(fullest.unit).toBe("fraction");
+    expect(fullest.aggregation).toBe(AggregationType.Max);
+  });
+
+  test("SQL Server's blocked processes keep the peak of each interval", () => {
+    const blocked: DatabaseServerMetricDefinition = metricByName(
+      "sqlserver.processes.blocked",
+    );
+    expect(blocked.aggregation).toBe(AggregationType.Max);
+    expect(blocked.kind).toBe("gauge");
+  });
+});
+
+/*
+ * Regression (e2e, collector-contrib 0.161.0): MariaDB 11.4's Overview read
+ * "Buffer pool size 7.9 KiB". The mysql receiver fills
+ * mysql.buffer_pool.limit ("bytes") from information_schema.INNODB_METRICS,
+ * which on MariaDB holds the pool's page count: these are one scrape of
+ * each server as ClickHouse stored it (@@innodb_buffer_pool_size is
+ * 134217728 on both).
+ */
+describe("the InnoDB buffer pool on MySQL and MariaDB alike", () => {
+  const MARIADB_11_4: Record<string, number> = {
+    "mysql.buffer_pool.limit": 8112,
+    "mysql.buffer_pool.pages{kind=total}": 8112,
+    "mysql.buffer_pool.pages{kind=data}": 1273,
+    "mysql.buffer_pool.pages{kind=free}": 6839,
+    "mysql.buffer_pool.pages{kind=misc}": 0,
+  };
+  const MYSQL_8_4: Record<string, number> = {
+    "mysql.buffer_pool.limit": 134217728,
+    "mysql.buffer_pool.pages{kind=total}": 8192,
+    "mysql.buffer_pool.pages{kind=data}": 1186,
+    "mysql.buffer_pool.pages{kind=free}": 7006,
+    "mysql.buffer_pool.pages{kind=misc}": 0,
+  };
+
+  test("no tile reads mysql.buffer_pool.limit, whose unit differs by engine", () => {
+    for (const system of ["mysql", "mariadb"]) {
+      expect(
+        getDatabaseServerMetrics(system).filter(
+          (metric: DatabaseServerMetricDefinition): boolean => {
+            return metric.metricName === "mysql.buffer_pool.limit";
+          },
+        ),
+      ).toEqual([]);
+    }
+    // The fixture holds the trap: the same setting, 16384x apart.
+    expect(
+      MYSQL_8_4["mysql.buffer_pool.limit"]! /
+        MARIADB_11_4["mysql.buffer_pool.limit"]!,
+    ).toBeGreaterThan(16000);
+  });
+
+  test("the size tile reads the total page count, the same measure on both", () => {
+    const size: DatabaseServerMetricDefinition = getDatabaseServerMetrics(
+      "mariadb",
+    ).find((metric: DatabaseServerMetricDefinition): boolean => {
+      return metric.title === "Buffer pool size";
+    })!;
+    expect(getDatabaseServerMetricId(size)).toBe(
+      "mysql.buffer_pool.pages{kind=total}",
+    );
+    expect(size.unit).toBe("pages");
+    expect(size.kind).toBe("gauge");
+    // Pinned: kind total is the sum of the other kinds, never added to them.
+    for (const scrape of [MARIADB_11_4, MYSQL_8_4]) {
+      const size16k: number = scrape[getDatabaseServerMetricId(size)]! * 16384;
+      expect(size16k).toBeGreaterThan(128 * 1024 * 1024 * 0.95);
+      expect(size16k).toBeLessThanOrEqual(128 * 1024 * 1024);
+      expect(
+        scrape["mysql.buffer_pool.pages{kind=data}"]! +
+          scrape["mysql.buffer_pool.pages{kind=free}"]! +
+          scrape["mysql.buffer_pool.pages{kind=misc}"]!,
+      ).toBe(scrape["mysql.buffer_pool.pages{kind=total}"]);
+    }
+  });
+
+  test("buffer pool usage stays in bytes: MariaDB reports those as bytes", () => {
+    const usage: DatabaseServerMetricDefinition = metricByName(
+      "mysql.buffer_pool.usage",
+    );
+    expect(usage.unit).toBe("bytes");
+    // MariaDB 11.4, same scrape: 16203776 dirty bytes = 989 dirty pages.
+    expect(16203776 / 16384).toBe(989);
+  });
+});
+
+/*
+ * Regression (e2e): Elasticsearch, OpenSearch and Memcached databases were
+ * connected, 69 to 76 metrics arriving every 30 s, and their Overview said
+ * there was no curated overview for the engine.
+ */
+describe("Elasticsearch, OpenSearch and Memcached have a curated overview", () => {
+  test.each([
+    ["elasticsearch", "elasticsearch"],
+    ["opensearch", "opensearch"],
+    ["memcached", "memcached"],
+  ])(
+    "every %s tile reads a metric the agent delivered",
+    (system: string, arrivedFrom: string) => {
+      const metrics: Array<DatabaseServerMetricDefinition> =
+        getDatabaseServerMetrics(system);
+      expect(metrics.length).toBeGreaterThanOrEqual(5);
+      for (const metric of metrics) {
+        expect({
+          system,
+          metric: metric.metricName,
+          arrived: SEEN_ARRIVING_FROM_AGENT[arrivedFrom]!.includes(
+            metric.metricName,
+          ),
+        }).toEqual({ system, metric: metric.metricName, arrived: true });
+      }
+    },
+  );
+
+  test("OpenSearch gets Elasticsearch's set: the same receiver reads both", () => {
+    expect(getDatabaseServerMetrics("opensearch")).toEqual(
+      getDatabaseServerMetrics("elasticsearch"),
+    );
+  });
+
+  test("Elasticsearch's tiles, in display order", () => {
+    expect(
+      getDatabaseServerMetrics("elasticsearch").map(
+        (metric: DatabaseServerMetricDefinition): [string, string] => {
+          return [getDatabaseServerMetricId(metric), metric.kind];
+        },
+      ),
+    ).toEqual([
+      ["elasticsearch.cluster.health{status=green}", "gauge"],
+      ["elasticsearch.cluster.nodes", "gauge"],
+      ["elasticsearch.cluster.shards{state=unassigned}", "gauge"],
+      ["elasticsearch.cluster.pending_tasks", "gauge"],
+      ["jvm.memory.heap.utilization", "gauge"],
+      ["elasticsearch.node.fs.disk.available", "gauge"],
+      ["elasticsearch.node.operations.completed{operation=query}", "counter"],
+      ["elasticsearch.node.operations.completed{operation=index}", "counter"],
+    ]);
+  });
+
+  test("cluster health is the share of the interval spent green", () => {
+    /*
+     * The receiver records one 0/1 series per status (green 1, yellow 0,
+     * red 0 on a green cluster): the green series' average is the share,
+     * and the worst reporter decides.
+     */
+    const health: DatabaseServerMetricDefinition = metricByName(
+      "elasticsearch.cluster.health",
+    );
+    expect(health.attributes).toEqual({ status: "green" });
+    expect(health.aggregation).toBe(AggregationType.Avg);
+    expect(health.unit).toBe("fraction");
+    expect(health.seriesCombine).toBe("min");
+  });
+
+  test("node-level tiles keep the node closest to trouble", () => {
+    const heap: DatabaseServerMetricDefinition = metricByName(
+      "jvm.memory.heap.utilization",
+    );
+    // A 0..1 share (unit "1"), per node; the fullest one is shown.
+    expect(heap.unit).toBe("fraction");
+    expect(heap.seriesCombine).toBe("max");
+    expect(heap.seriesKeys).toEqual(["resource.elasticsearch.node.name"]);
+    expect(heap.enabledByDefault).toBe(false);
+
+    const disk: DatabaseServerMetricDefinition = metricByName(
+      "elasticsearch.node.fs.disk.available",
+    );
+    expect(disk.unit).toBe("bytes");
+    expect(disk.aggregation).toBe(AggregationType.Min);
+    expect(disk.seriesCombine).toBe("min");
+    expect(disk.seriesKeys).toEqual(["resource.elasticsearch.node.name"]);
+  });
+
+  test("Memcached's tiles, in display order", () => {
+    expect(
+      getDatabaseServerMetrics("memcached").map(
+        (metric: DatabaseServerMetricDefinition): [string, string] => {
+          return [getDatabaseServerMetricId(metric), metric.kind];
+        },
+      ),
+    ).toEqual([
+      ["memcached.connections.current", "gauge"],
+      ["memcached.bytes", "gauge"],
+      ["memcached.current_items", "gauge"],
+      ["memcached.operations{operation=get,type=hit}", "counter"],
+      ["memcached.operations{operation=get,type=miss}", "counter"],
+      ["memcached.commands", "counter"],
+      ["memcached.evictions", "counter"],
+    ]);
+  });
+
+  test("Memcached's hit ratio is not a tile: it reads 0% on an idle cache", () => {
+    /*
+     * Measured: a Memcached 1.6 nobody had read from reported
+     * memcached.operation_hit_ratio{operation=get} = 0 on all 239 scrapes.
+     */
+    expect(entriesNamed("memcached.operation_hit_ratio")).toEqual([]);
+  });
+});
+
+describe("getDatabaseServerMetrics", () => {
+  test("aliases resolve to the engine's list", () => {
+    expect(getDatabaseServerMetrics("postgres")).toEqual(
+      getDatabaseServerMetrics("postgresql"),
+    );
+    expect(getDatabaseServerMetrics("MSSQL")).toEqual(
+      getDatabaseServerMetrics("microsoft.sql_server"),
+    );
+  });
+
+  test("a fork its family's receiver monitors gets the family's set", () => {
+    // The redis / mysql receivers report redis.* / mysql.* for these.
+    expect(getDatabaseServerMetrics("valkey")).toEqual(
+      getDatabaseServerMetrics("redis"),
+    );
+    // Less what the receiver never sends for the fork (see below).
+    expect(getDatabaseServerMetrics("mariadb")).toEqual(
+      getDatabaseServerMetrics("mysql").filter(
+        (metric: DatabaseServerMetricDefinition): boolean => {
+          return metric.metricName !== "mysql.row_operations";
+        },
+      ),
+    );
+    expect(getDatabaseServerMetrics("MariaDB")).toEqual(
+      getDatabaseServerMetrics("mariadb"),
+    );
+    expect(getDatabaseServerMetrics("redis").length).toBeGreaterThan(0);
+  });
+
+  /*
+   * Regression (live re-verification): a MariaDB 11.4 Overview showed
+   * "ROW OPERATIONS —" under ~960 handler ops/s. The tile reads
+   * mysql.row_operations, from the Innodb_rows_* status counters, which
+   * MariaDB does not have — `SHOW GLOBAL STATUS LIKE 'Innodb_rows%'` is
+   * empty — so the receiver never sends it there and the tile could never
+   * fill.
+   */
+  test.each([["mysql"], ["mariadb"]])(
+    "every %s tile reads a metric the agent delivered",
+    (system: string) => {
+      const metrics: Array<DatabaseServerMetricDefinition> =
+        getDatabaseServerMetrics(system);
+      expect(metrics.length).toBeGreaterThanOrEqual(5);
+      for (const metric of metrics) {
+        expect({
+          system,
+          metric: metric.metricName,
+          arrived: SEEN_ARRIVING_FROM_AGENT[system]!.includes(
+            metric.metricName,
+          ),
+        }).toEqual({ system, metric: metric.metricName, arrived: true });
+      }
+    },
+  );
+
+  test("notEmittedFor names only forks of the entry's own engine", () => {
+    for (const metric of DATABASE_SERVER_METRICS) {
+      for (const fork of metric.notEmittedFor || []) {
+        const descriptor: DatabaseSystemDescriptor | null =
+          getDatabaseSystemDescriptor(fork);
+        expect({
+          metric: metric.metricName,
+          fork,
+          family: descriptor?.family,
+          isItself: descriptor?.system === metric.system,
+        }).toEqual({
+          metric: metric.metricName,
+          fork,
+          family: metric.system,
+          isItself: false,
+        });
+      }
+    }
+  });
+
+  test("returns only that engine's metrics, in catalog order", () => {
+    const metrics: Array<DatabaseServerMetricDefinition> =
+      getDatabaseServerMetrics("redis");
+    for (const metric of metrics) {
+      expect(metric.system).toBe("redis");
+    }
+    expect(metrics[0]!.metricName).toBe("redis.clients.connected");
+  });
+
+  test("engines without a curated set, and junk, give []", () => {
+    expect(getDatabaseServerMetrics("cockroachdb")).toEqual([]);
+    expect(getDatabaseServerMetrics("couchdb")).toEqual([]);
+    expect(getDatabaseServerMetrics("tidb")).toEqual([]);
+    expect(getDatabaseServerMetrics("")).toEqual([]);
+    expect(getDatabaseServerMetrics(null)).toEqual([]);
+    expect(getDatabaseServerMetrics(undefined)).toEqual([]);
+  });
+
+  test("the returned array is a copy (callers may not mutate the catalog)", () => {
+    const first: Array<DatabaseServerMetricDefinition> =
+      getDatabaseServerMetrics("mysql");
+    first.pop();
+    expect(getDatabaseServerMetrics("mysql").length).toBe(first.length + 1);
+  });
+});
+
+describe("catalog helpers", () => {
+  test("an entry's id is its name, plus its pins in key order", () => {
+    expect(getDatabaseServerMetricId(metricByName("postgresql.backends"))).toBe(
+      "postgresql.backends",
+    );
+    const [connected, running] = entriesNamed("mysql.threads");
+    expect(getDatabaseServerMetricId(connected!)).toBe(
+      "mysql.threads{kind=connected}",
+    );
+    expect(getDatabaseServerMetricId(running!)).toBe(
+      "mysql.threads{kind=running}",
+    );
+    expect(
+      getDatabaseServerMetricId({
+        ...metricByName("postgresql.backends"),
+        attributes: { z: "1", a: "2" },
+      }),
+    ).toBe("postgresql.backends{a=2,z=1}");
+  });
+
+  test("gauges group by their series keys, then the reporting instance", () => {
+    expect(
+      getDatabaseServerMetricGroupKeys(metricByName("postgresql.backends")),
+    ).toEqual([
+      "db.namespace",
+      "resource.postgresql.database.name",
+      ...DATABASE_SERVER_INSTANCE_ATTRIBUTE_KEYS,
+    ]);
+    expect(
+      getDatabaseServerMetricGroupKeys(metricByName("redis.memory.used")),
+    ).toEqual(["resource.server.address", "resource.server.port"]);
+    expect(
+      getDatabaseServerMetricGroupKeys({
+        ...metricByName("redis.memory.used"),
+        seriesKeys: ["resource.server.address", "x"],
+      }),
+    ).toEqual(["resource.server.address", "x", "resource.server.port"]);
+  });
+
+  test("group keys stay within the server's ten-key limit", () => {
+    for (const metric of DATABASE_SERVER_METRICS) {
+      expect(getDatabaseServerMetricGroupKeys(metric).length).toBeLessThan(10);
+    }
+  });
+
+  test("a metric name finds its entry, preferring one that pins nothing", () => {
+    expect(
+      findDatabaseServerMetricByName("postgres", " postgresql.commits ")?.title,
+    ).toBe("Commits");
+    // Every mysql.threads entry pins; the first one is used.
+    expect(
+      findDatabaseServerMetricByName("mysql", "mysql.threads")?.title,
+    ).toBe("Connected threads");
+    expect(
+      findDatabaseServerMetricByName("mysql", "postgresql.commits"),
+    ).toBeNull();
+    expect(findDatabaseServerMetricByName(null, "mysql.threads")).toBeNull();
+    expect(findDatabaseServerMetricByName("mysql", "")).toBeNull();
+  });
+});