@oneuptime/common 12.0.30 → 12.0.32

package/Models/DatabaseModels/NetworkDevice.ts

@@ -1,6 +1,8 @@
 import Label from "./Label";
 import Monitor from "./Monitor";
 import MonitorStatus from "./MonitorStatus";
+import NetworkDeviceOidTemplate from "./NetworkDeviceOidTemplate";
+import NetworkDeviceRole from "./NetworkDeviceRole";
 import NetworkSite from "./NetworkSite";
 import Probe from "./Probe";
 import Project from "./Project";
@@ -116,6 +118,18 @@ import {
  * free to maintain and the alternative is a full scan per rollup.
  */
 @Index(["projectId", "siteId"])
+/*
+ * "Which devices use this OID Collection Template?" - the count on the
+ * template page, the Template column's filter on the device list, and the
+ * FK's own ON DELETE SET NULL scan.
+ *
+ * Project-prefixed and composite, like every other index on this table and
+ * for the reason written at the top of this block: a bare column index on a
+ * nullable FK is one btree entry per row of the product's hottest table,
+ * paid on every poll, to serve queries that all carry a projectId anyway.
+ * This is the same shape siteId gets above, and deliberately so.
+ */
+@Index(["projectId", "oidTemplateId"])
 /*
  * The other half of the Overview's attention list: reachable devices with the
  * most dark ports.
@@ -588,6 +602,103 @@ export default class NetworkDevice extends BaseModel {
   })
   public siteId?: ObjectID = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkDevice,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkDevice,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkDevice,
+    ],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "oidTemplateId",
+    type: TableColumnType.Entity,
+    modelType: NetworkDeviceOidTemplate,
+    title: "OID Collection Template",
+    description:
+      "The OID Collection Template this device collects, on top of any device-specific Health OIDs below. The link is live: editing the template changes what this device collects on its next poll.",
+  })
+  @ManyToOne(
+    () => {
+      return NetworkDeviceOidTemplate;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "oidTemplateId" })
+  public oidTemplate?: NetworkDeviceOidTemplate = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkDevice,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkDevice,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkDevice,
+    ],
+  })
+  /*
+   * No column-level index here on purpose - the composite
+   * (projectId, oidTemplateId) declared at the top of the class serves every
+   * reader. See the comment there.
+   */
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    canReadOnRelationQuery: true,
+    title: "OID Collection Template ID",
+    description: "ID of the OID Collection Template this device collects",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public oidTemplateId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [
@@ -735,13 +846,22 @@ export default class NetworkDevice extends BaseModel {
       Permission.EditNetworkDevice,
     ],
   })
+  /*
+   * DEPRECATED. Device roles used to be a fixed union stored inline as a
+   * string; they are now the per-project NetworkDeviceRole lookup table
+   * below, so a project can rename them, change what each is drawn as, or add
+   * roles of its own. This column is retained ONLY so the
+   * BackfillNetworkDeviceRoles data migration can read the old value and
+   * point networkDeviceRoleId at the matching role row. It is dropped in a
+   * follow-up PR - do not read or write it from new code.
+   */
   @TableColumn({
     required: false,
     type: TableColumnType.ShortText,
     canReadOnRelationQuery: true,
-    title: "Device Role",
+    title: "Device Role (Deprecated)",
     description:
-      "What this device does on the network — router, switch, access point and so on. Left empty, the role is worked out from the device's own SNMP identity. Set it when there is no SNMP to read: a ping-only device has no identity to classify, and the role decides both the shape it is drawn with and where it sits in the topology hierarchy.",
+      "Deprecated legacy device role key. Use the Network Device Role relation instead; this column exists only for the backfill migration and will be removed.",
     example: "switch",
   })
   @Column({
@@ -751,6 +871,115 @@ export default class NetworkDevice extends BaseModel {
   })
   public deviceRole?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkDevice,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkDevice,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkDevice,
+    ],
+  })
+  /*
+   * The operator's own answer to what this device is, when they gave one.
+   *
+   * Empty is not "unknown": it means "no answer given", and the SNMP
+   * classifier is left to work the role out from the device's own identity.
+   * That is the better source when there IS an identity to read, which is
+   * why this is left empty on SNMP devices by default. On a device nothing
+   * walks - a ping-only device, a monitor-backed one - the classifier has
+   * only a hostname to go on, so this is the only statement about the role
+   * available at all, and it decides both the shape the device is drawn with
+   * and where it sits in the topology hierarchy.
+   *
+   * SET NULL on delete, deliberately: removing a role from the project's
+   * settings must not remove the devices that were using it. They simply go
+   * back to being classified from their SNMP identity.
+   */
+  @TableColumn({
+    manyToOneRelationColumn: "networkDeviceRoleId",
+    type: TableColumnType.Entity,
+    modelType: NetworkDeviceRole,
+    title: "Device Role",
+    description:
+      "What this device does on the network - Router, Switch, Wireless AP and so on. Configured per project in Network > Settings > Device Roles.",
+  })
+  @ManyToOne(
+    () => {
+      return NetworkDeviceRole;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "networkDeviceRoleId" })
+  public networkDeviceRole?: NetworkDeviceRole = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkDevice,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkDevice,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkDevice,
+    ],
+  })
+  @Index()
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ObjectID,
+    canReadOnRelationQuery: true,
+    title: "Device Role ID",
+    description: "ID of the Network Device Role this device is assigned.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public networkDeviceRoleId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,
@@ -1474,9 +1703,9 @@ export default class NetworkDevice extends BaseModel {
   @TableColumn({
     type: TableColumnType.JSON,
     required: false,
-    title: "Health OIDs",
+    title: "Device-Specific Health OIDs",
     description:
-      "SNMP OIDs (CPU, memory, temperature, or any custom OID) collected on each poll. Values are recorded as metrics and can be alerted on through monitor criteria.",
+      "SNMP OIDs collected on each poll for this device ALONE, on top of whatever its OID Collection Template collects. Values are recorded as metrics and can be alerted on through monitor criteria. If several devices need the same OID, put it on a template instead.",
   })
   @Column({
     type: ColumnType.JSON,
@@ -1608,7 +1837,7 @@ export default class NetworkDevice extends BaseModel {
     required: false,
     title: "Last Walk Log",
     description:
-      "The previous poll's raw walk response. Kept so interface rates (bandwidth, utilization, errors/sec) can be computed as counter deltas between polls. Managed by the server.",
+      "The previous poll's interface counters. Kept so interface rates (bandwidth, utilization, errors/sec) can be computed as counter deltas between polls, and stores nothing else - the rest of the walk response has no reader and this column is rewritten on every poll of every device. Managed by the server.",
   })
   @Column({
     type: ColumnType.JSON,

package/Models/DatabaseModels/NetworkDeviceAutoImportRule.ts

@@ -1,4 +1,5 @@
 import MonitorTemplate from "./MonitorTemplate";
+import NetworkDeviceOidTemplate from "./NetworkDeviceOidTemplate";
 import Project from "./Project";
 import User from "./User";
 import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
@@ -551,6 +552,93 @@ export default class NetworkDeviceAutoImportRule extends BaseModel {
   })
   public monitorTemplateId?: ObjectID = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateNetworkDeviceAutoImportRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadNetworkDeviceOidTemplate,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditNetworkDeviceAutoImportRule,
+    ],
+  })
+  /*
+   * The collect half of the pair, sitting beside the alert half above.
+   *
+   * Without it a template is only reachable by hand: a discovery scan would
+   * import a device, the vendor auto-apply would write a two-to-six OID copy
+   * onto it, and somebody would have to go back and bulk-assign the real
+   * template - after every scan, forever. That is the same per-device chore
+   * issue #3507 is about, just moved one step later. This is the OneUptime
+   * shape of Zabbix's "link template on host discovery" action.
+   */
+  @TableColumn({
+    manyToOneRelationColumn: "oidTemplateId",
+    type: TableColumnType.Entity,
+    modelType: NetworkDeviceOidTemplate,
+    title: "OID Collection Template",
+    description:
+      "Optional OID Collection Template to link to devices imported by this rule. The Monitor Template decides what those devices are ALERTED on; this decides what they COLLECT.",
+  })
+  @ManyToOne(
+    () => {
+      return NetworkDeviceOidTemplate;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({
+    name: "oidTemplateId",
+  })
+  public oidTemplate?: NetworkDeviceOidTemplate = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateNetworkDeviceAutoImportRule,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadNetworkDeviceOidTemplate,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditNetworkDeviceAutoImportRule,
+    ],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    canReadOnRelationQuery: true,
+    title: "OID Collection Template ID",
+    description:
+      "ID of the optional OID Collection Template to link to devices imported by this rule",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public oidTemplateId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Models/DatabaseModels/NetworkDeviceDiscoveryScan.ts

@@ -34,6 +34,28 @@ export interface DiscoveredNetworkDevice {
   sysLocation?: string | undefined;
   sysContact?: string | undefined;
   sysUpTimeSeconds?: number | undefined;
+  /*
+   * The host's reverse-DNS (PTR) name, resolved by the probe against the
+   * scanned network's own resolvers (OneUptime issue #3529).
+   *
+   * This is what a ping-only host is NAMED by. Before it existed the Review
+   * dialog could only show such a host as its address, which is what the
+   * issue reported: an estate with DNS records for everything still read as
+   * a list of bare IPs.
+   *
+   * Optional in three different ways that all mean "no name": the address has
+   * no PTR record, the probe has no usable resolver, or the row was stored
+   * before this field existed / by an older probe. Every reader falls back to
+   * the address, so none of the three needs telling apart.
+   *
+   * ATTACKER-INFLUENCED. Its value is chosen by whoever runs DNS for the
+   * scanned subnet, which on a discovery scan is frequently not this project,
+   * and it is stored here verbatim in jsonb. Never render or store it without
+   * ReverseDnsNameUtil.normalizeReverseDnsName — normalizeDiscoveredHosts and
+   * buildDeviceName both apply it, which covers every path that reaches a
+   * screen or a name column.
+   */
+  dnsHostname?: string | undefined;
   isAlreadyRegistered?: boolean | undefined;
   /*
    * False when the host answered ping but not SNMP — such hosts cannot be