CloudSearchMetrics

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-cloud-search-metrics-schema.json",
  "title": "CloudSearchMetrics",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-monitoring-and-logs-api-openapi.yml#/components/schemas/CloudSearchMetrics",
  "properties": {
    "groupId": {
      "description": "Unique 24-hexadecimal digit string that identifies the project.",
      "pattern": "^([a-f0-9]{24})$",
      "readOnly": true,
      "type": "string"
    },
    "hardwareMetrics": {
      "description": "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.",
      "items": {
        "$ref": "#/$defs/FTSMetric"
      },
      "readOnly": true,
      "type": "array"
    },
    "indexMetrics": {
      "description": "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.",
      "items": {
        "$ref": "#/$defs/FTSMetric"
      },
      "readOnly": true,
      "type": "array"
    },
    "links": {
      "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.",
      "items": {
        "$ref": "#/$defs/Link"
      },
      "readOnly": true,
      "type": "array"
    },
    "processId": {
      "description": "Hostname and port that identifies the process.",
      "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$",
      "readOnly": true,
      "type": "string"
    },
    "statusMetrics": {
      "description": "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.",
      "items": {
        "$ref": "#/$defs/FTSMetric"
      },
      "type": "array"
    }
  },
  "required": [
    "groupId",
    "hardwareMetrics",
    "indexMetrics",
    "processId",
    "statusMetrics"
  ],
  "type": "object",
  "$defs": {
    "FTSMetric": {
      "description": "Measurement of one Atlas Search status when MongoDB Atlas received this request.",
      "properties": {
        "metricName": {
          "description": "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.",
          "enum": [
            "INDEX_SIZE_ON_DISK",
            "NUMBER_OF_DELETES",
            "NUMBER_OF_ERROR_QUERIES",
            "NUMBER_OF_GETMORE_COMMANDS",
            "NUMBER_OF_INDEX_FIELDS",
            "NUMBER_OF_INSERTS",
            "NUMBER_OF_SUCCESS_QUERIES",
            "NUMBER_OF_UPDATES",
            "REPLICATION_LAG",
            "TOTAL_NUMBER_OF_QUERIES",
            "FTS_DISK_USAGE",
            "FTS_PROCESS_CPU_KERNEL",
            "FTS_PROCESS_CPU_USER",
            "FTS_PROCESS_NORMALIZED_CPU_KERNEL",
            "FTS_PROCESS_NORMALIZED_CPU_USER",
            "FTS_PROCESS_RESIDENT_MEMORY",
            "FTS_PROCESS_SHARED_MEMORY",
            "FTS_PROCESS_VIRTUAL_MEMORY",
            "JVM_CURRENT_MEMORY",
            "JVM_MAX_MEMORY",
            "PAGE_FAULTS"
          ],
          "readOnly": true,
          "type": "string"
        },
        "units": {
          "description": "Unit of measurement that applies to this Atlas Search metric.",
          "enum": [
            "BYTES",
            "BYTES_PER_SECOND",
            "GIGABYTES",
            "GIGABYTES_PER_HOUR",
            "KILOBYTES",
            "MEGABYTES",
            "MEGABYTES_PER_SECOND",
            "MILLISECONDS",
            "MILLISECONDS_LOGSCALE",
            "PERCENT",
            "SCALAR",
            "SCALAR_PER_SECOND",
            "SECONDS"
          ],
          "readOnly": true,
          "type": "string"
        }
      },
      "readOnly": true,
      "required": [
        "metricName",
        "units"
      ],
      "type": "object"
    },
    "Link": {
      "properties": {
        "href": {
          "description": "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.",
          "type": "string"
        },
        "rel": {
          "description": "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}