@oneuptime/common 12.0.12 → 12.0.14

package/Types/Monitor/MonitorType.ts

@@ -65,6 +65,14 @@ export interface MonitorTypeProps {
   description: string;
   title: string;
   icon: IconProp;
+  /*
+   * Words a user is likely to type that do not appear in the title or the
+   * description - product names, protocols and synonyms ("k8s", "postgres",
+   * "heartbeat", "tls"). The type picker searches these alongside the visible
+   * copy, so someone who knows their own vocabulary does not have to learn
+   * ours to find the right monitor.
+   */
+  keywords: Array<string>;
 }
 
 export interface MonitorTypeCategory {
@@ -187,216 +195,498 @@ export class MonitorTypeHelper {
         monitorType: MonitorType.API,
         title: "API",
         description:
-          "This monitor type lets you monitor any API - GET, POST, PUT, DELETE or more.",
+          "Call any HTTP endpoint - GET, POST, PUT, DELETE - and alert on the response.",
         icon: IconProp.Code,
+        keywords: [
+          "rest",
+          "endpoint",
+          "http",
+          "https",
+          "json",
+          "graphql",
+          "get",
+          "post",
+          "put",
+          "delete",
+          "service",
+        ],
       },
       {
         monitorType: MonitorType.Manual,
         title: "Manual",
         description:
-          "This monitor is a static monitor and will not actually monitor anything. It will however help you to integrate OneUptime with external monitoring tools and utilities.",
+          "No automatic checks. You set the status yourself, or from an external tool.",
         icon: IconProp.EmptyCircle,
+        keywords: [
+          "static",
+          "external",
+          "integration",
+          "placeholder",
+          "no check",
+          "third party",
+        ],
       },
       {
         monitorType: MonitorType.Website,
         title: "Website",
         description:
-          "This monitor type lets you monitor landing pages like home page of your company / blog or more.",
+          "Check a page loads and responds - status code, page content, and response time.",
         icon: IconProp.Globe,
+        keywords: [
+          "url",
+          "http",
+          "https",
+          "web",
+          "webpage",
+          "site",
+          "landing page",
+          "home page",
+          "uptime",
+        ],
       },
       {
         monitorType: MonitorType.Ping,
         title: "Ping",
-        description:
-          "This monitor type does the basic ping test of an endpoint.",
+        description: "ICMP reachability and round trip time for a host.",
         icon: IconProp.Signal,
+        keywords: [
+          "icmp",
+          "echo",
+          "reachable",
+          "reachability",
+          "latency",
+          "rtt",
+          "packet loss",
+        ],
       },
       {
         monitorType: MonitorType.Kubernetes,
         title: "Kubernetes",
-        description:
-          "This monitor type lets you monitor Kubernetes clusters, workloads, nodes, and pods.",
+        description: "Cluster, node, workload, and pod health.",
         icon: IconProp.Cube,
+        keywords: [
+          "k8s",
+          "cluster",
+          "pod",
+          "node",
+          "workload",
+          "deployment",
+          "namespace",
+          "container",
+          "eks",
+          "gke",
+          "aks",
+          "openshift",
+        ],
       },
       {
         monitorType: MonitorType.Docker,
         title: "Docker Container",
         description:
-          "This monitor type lets you monitor Docker containers — CPU, memory, network, restarts, and lifecycle events.",
+          "Container CPU, memory, network, restarts, and lifecycle events.",
         icon: IconProp.Cube,
+        keywords: [
+          "container",
+          "dockerd",
+          "image",
+          "restart",
+          "compose",
+          "oci",
+        ],
       },
       {
         monitorType: MonitorType.Host,
         title: "Host",
         description:
-          "This monitor type lets you monitor OpenTelemetry-instrumented hosts and servers (the Hosts product) — CPU, memory, disk, network, load average, and process count via the OneUptime Infrastructure Agent. It is the telemetry-metric counterpart to the agent-push Server / VM Monitor.",
+          "CPU, memory, disk, network, and load for hosts running the Infrastructure Agent.",
         icon: IconProp.Server,
+        keywords: [
+          "server",
+          "vm",
+          "machine",
+          "cpu",
+          "memory",
+          "ram",
+          "disk",
+          "load average",
+          "otel",
+          "opentelemetry",
+          "agent",
+          "linux",
+          "infrastructure",
+        ],
       },
       {
         monitorType: MonitorType.Podman,
         title: "Podman Container",
         description:
-          "This monitor type lets you monitor Podman containers — CPU, memory, network, restarts, and lifecycle events.",
+          "Container CPU, memory, network, restarts, and lifecycle events.",
         icon: IconProp.Podman,
+        keywords: [
+          "container",
+          "rootless",
+          "redhat",
+          "oci",
+          "quadlet",
+          "buildah",
+        ],
       },
       {
         monitorType: MonitorType.DockerSwarm,
         title: "Docker Swarm",
         description:
-          "This monitor type lets you monitor Docker Swarm clusters — per-task container CPU, memory, network, process count, and uptime across the cluster's services and nodes.",
+          "Per task container health across the cluster's services and nodes.",
         icon: IconProp.DockerSwarm,
+        keywords: [
+          "swarm",
+          "cluster",
+          "service",
+          "task",
+          "orchestration",
+          "stack",
+          "docker",
+        ],
       },
       {
         monitorType: MonitorType.Proxmox,
         title: "Proxmox",
         description:
-          "This monitor type lets you monitor Proxmox VE clusters — node availability, VM and container (guest) health, CPU, memory, storage, and HA state.",
+          "Node availability, VM and container guests, storage, and HA state.",
         icon: IconProp.Proxmox,
+        keywords: [
+          "pve",
+          "hypervisor",
+          "vm",
+          "virtual machine",
+          "lxc",
+          "guest",
+          "virtualization",
+          "ha",
+          "cluster",
+        ],
       },
       {
         monitorType: MonitorType.Ceph,
         title: "Ceph",
         description:
-          "This monitor type lets you monitor Ceph storage clusters — cluster health, monitor quorum, OSD availability, pool capacity, and placement group states.",
+          "Cluster health, monitor quorum, OSD availability, and pool capacity.",
         icon: IconProp.Ceph,
+        keywords: [
+          "storage",
+          "osd",
+          "placement group",
+          "pool",
+          "quorum",
+          "rados",
+          "cluster",
+          "object storage",
+        ],
       },
       {
         monitorType: MonitorType.IoTDevice,
         title: "IoT Device",
         description:
-          "This monitor type lets you monitor IoT device fleets — device availability, battery level, connectivity and signal strength, temperature, and system health across your devices and gateways.",
+          "Device fleet availability, battery, connectivity, and signal strength.",
         icon: IconProp.IoT,
+        keywords: [
+          "iot",
+          "device",
+          "fleet",
+          "sensor",
+          "battery",
+          "gateway",
+          "embedded",
+          "signal",
+        ],
       },
       {
         monitorType: MonitorType.IP,
         title: "IP",
-        description:
-          "This monitor type lets you monitor any IPv4 or IPv6 addresses.",
+        description: "Reachability of any IPv4 or IPv6 address.",
         icon: IconProp.AltGlobe,
+        keywords: ["ipv4", "ipv6", "address", "reachability", "host"],
       },
       {
         monitorType: MonitorType.IncomingRequest,
         title: "Incoming Request",
         description:
-          "This monitor type lets you ping OneUptime from any external device or service with a custom payload.",
+          "Have something call OneUptime - heartbeats, cron jobs, and webhooks.",
         icon: IconProp.Webhook,
+        keywords: [
+          "webhook",
+          "heartbeat",
+          "push",
+          "cron",
+          "inbound",
+          "dead man switch",
+          "alertmanager",
+          "curl",
+        ],
       },
       {
         monitorType: MonitorType.IncomingEmail,
         title: "Incoming Email",
         description:
-          "This monitor type triggers alerts when emails are received at a unique email address with matching criteria.",
+          "Alert when email arrives at a unique address and matches your criteria.",
         icon: IconProp.Email,
+        keywords: ["email", "mail", "inbox", "smtp", "imap", "mailbox"],
       },
       {
         monitorType: MonitorType.Port,
         title: "Port",
-        description: "This monitor type lets you monitor any TCP or UDP port.",
+        description: "Whether a TCP or UDP port accepts connections.",
         icon: IconProp.Terminal,
+        keywords: ["tcp", "udp", "socket", "telnet", "open port", "connection"],
       },
       {
         monitorType: MonitorType.Server,
         title: "Server / VM",
         description:
-          "This monitor type lets you monitor any server, VM, or any machine.",
+          "Any server, VM, or machine, reporting in through the OneUptime agent.",
         icon: IconProp.Cube,
+        keywords: [
+          "vm",
+          "machine",
+          "agent",
+          "linux",
+          "windows",
+          "cpu",
+          "memory",
+          "disk",
+        ],
       },
       {
         monitorType: MonitorType.SSLCertificate,
         title: "SSL Certificate",
-        description:
-          "This monitor type lets you monitor SSL certificates of any domain.",
+        description: "Certificate validity and expiry for a domain.",
         icon: IconProp.ShieldCheck,
+        keywords: [
+          "tls",
+          "ssl",
+          "cert",
+          "certificate",
+          "https",
+          "expiry",
+          "expiration",
+          "x509",
+          "chain",
+          "handshake",
+        ],
       },
       {
         monitorType: MonitorType.SQLQuery,
         title: "SQL Query",
         description:
-          "This monitor type runs a read-only SQL query on a schedule against a database (PostgreSQL, MySQL, or Microsoft SQL Server) and alerts on the result — row count, a scalar value, execution time, or query errors. Requires a probe with network access to your database.",
+          "Run a read only query on a schedule and alert on rows, values, or errors.",
         icon: IconProp.Database,
+        keywords: [
+          "database",
+          "db",
+          "postgres",
+          "postgresql",
+          "mysql",
+          "mariadb",
+          "mssql",
+          "sql server",
+          "query",
+          "row count",
+        ],
       },
       {
         monitorType: MonitorType.SyntheticMonitor,
         title: "Synthetic Monitor",
         description:
-          "This monitor type lets you monitor your web application UI.",
+          "Drive your web app in a real browser and alert when the journey fails.",
         icon: IconProp.Window,
+        keywords: [
+          "browser",
+          "playwright",
+          "e2e",
+          "user journey",
+          "ui",
+          "click",
+          "flow",
+          "transaction",
+          "headless",
+        ],
       },
       {
         monitorType: MonitorType.CustomJavaScriptCode,
         title: "Custom JavaScript Code",
         description:
-          "This monitor type lets you run custom JavaScript code on a schedule.",
+          "Run your own JavaScript on a schedule and alert on what it returns.",
         icon: IconProp.Code,
+        keywords: [
+          "js",
+          "javascript",
+          "script",
+          "code",
+          "custom",
+          "node",
+          "programmatic",
+        ],
       },
       {
         monitorType: MonitorType.Logs,
         title: "Logs",
-        description: "This monitor type lets you monitor logs from any source.",
+        description:
+          "Alert on log volume or matching log content from any source.",
         icon: IconProp.Logs,
+        keywords: [
+          "log",
+          "otel",
+          "opentelemetry",
+          "log query",
+          "error log",
+          "search logs",
+        ],
       },
       {
         monitorType: MonitorType.Exceptions,
         title: "Exceptions",
-        description:
-          "This monitor type lets you monitor exceptions and error groups from any source.",
+        description: "Alert on exceptions and error groups from any source.",
         icon: IconProp.Bug,
+        keywords: [
+          "exception",
+          "error",
+          "crash",
+          "stack trace",
+          "bug",
+          "error group",
+        ],
       },
       {
         monitorType: MonitorType.Traces,
         title: "Traces",
-        description:
-          "This monitor type lets you monitor traces from any source.",
+        description: "Alert on span latency and error rate from any source.",
         icon: IconProp.Waterfall,
+        keywords: [
+          "trace",
+          "span",
+          "otel",
+          "opentelemetry",
+          "distributed tracing",
+          "apm",
+          "latency",
+        ],
       },
       {
         monitorType: MonitorType.Metrics,
         title: "Metrics",
-        description:
-          "This monitor type lets you monitor metrics from any source.",
+        description: "Alert on any metric you ingest.",
         icon: IconProp.Heartbeat,
+        keywords: [
+          "metric",
+          "otel",
+          "opentelemetry",
+          "gauge",
+          "counter",
+          "histogram",
+          "timeseries",
+          "prometheus",
+        ],
       },
       {
         monitorType: MonitorType.Profiles,
         title: "Profiles",
-        description:
-          "This monitor type lets you monitor continuous profiling data from any source.",
+        description: "Alert on continuous profiling data from any source.",
         icon: IconProp.Fire,
+        keywords: [
+          "profiling",
+          "cpu profile",
+          "flamegraph",
+          "pprof",
+          "continuous profiling",
+        ],
       },
       {
         monitorType: MonitorType.NetworkDevice,
         title: "Network Device",
         description:
-          "This monitor type alerts on a registered Network Device (switch, router, firewall, or access point) — availability, interface status, bandwidth, health OIDs, and traps. The device itself is polled by its assigned probe; the monitor chooses what to alert on.",
+          "Alert on a registered switch, router, firewall, or access point.",
         icon: IconProp.Signal,
+        keywords: [
+          "snmp",
+          "switch",
+          "router",
+          "firewall",
+          "access point",
+          "interface",
+          "oid",
+          "trap",
+          "bandwidth",
+        ],
       },
       {
         monitorType: MonitorType.DNS,
         title: "DNS",
-        description:
-          "This monitor type lets you monitor DNS resolution for your domains, verify record values, and check DNSSEC validity.",
+        description: "Resolution and record values for your domains.",
         icon: IconProp.GlobeAlt,
+        keywords: [
+          "resolution",
+          "resolve",
+          "record",
+          "cname",
+          "mx",
+          "txt",
+          "ns",
+          "srv",
+          "resolver",
+          "nslookup",
+          "dig",
+        ],
       },
       {
         monitorType: MonitorType.DNSSEC,
         title: "DNSSEC",
         description:
-          "This monitor type performs full DNSSEC validation — DNSKEY, DS at the parent zone, RRSIG validity windows, AD-flag/SERVFAIL behavior across public resolvers, and primary/secondary nameserver consistency.",
+          "Full DNSSEC validation - DNSKEY, DS, RRSIG, and resolver behaviour.",
         icon: IconProp.Key,
+        keywords: [
+          "dnskey",
+          "ds record",
+          "rrsig",
+          "signing",
+          "validation",
+          "secure dns",
+          "chain of trust",
+        ],
       },
       {
         monitorType: MonitorType.Domain,
         title: "Domain",
         description:
-          "This monitor type lets you monitor domain registration health — expiry dates, registrar info, nameserver delegation, and WHOIS status.",
+          "Registration health - expiry, registrar, nameservers, and WHOIS status.",
         icon: IconProp.Globe,
+        keywords: [
+          "whois",
+          "registrar",
+          "registration",
+          "expiry",
+          "expiration",
+          "nameserver",
+          "delegation",
+          "tld",
+        ],
       },
       {
         monitorType: MonitorType.ExternalStatusPage,
         title: "External Status Page",
         description:
-          "This monitor type lets you monitor third-party status pages (e.g. AWS, GCP, Azure, GitHub, Cloudflare) and alert when their services degrade.",
+          "Watch a third party status page - AWS, GCP, Azure, GitHub, Cloudflare.",
         icon: IconProp.ExternalLink,
+        keywords: [
+          "third party",
+          "vendor",
+          "upstream",
+          "dependency",
+          "aws",
+          "gcp",
+          "azure",
+          "github",
+          "cloudflare",
+          "statuspage",
+        ],
       },
     ];
 
@@ -433,6 +723,21 @@ export class MonitorTypeHelper {
     return monitorTypeProps[0].title;
   }
 
+  public static getKeywords(monitorType: MonitorType): Array<string> {
+    const monitorTypeProps: Array<MonitorTypeProps> =
+      this.getAllMonitorTypeProps().filter((item: MonitorTypeProps) => {
+        return item.monitorType === monitorType;
+      });
+
+    if (!monitorTypeProps[0]) {
+      throw new BadDataException(
+        `${monitorType} does not have monitorType props`,
+      );
+    }
+
+    return monitorTypeProps[0].keywords;
+  }
+
   /*
    * Monitor types the probe executes on a schedule via MonitorProbe rows.
    *