kibana/api_docs/monitoring.devdocs.json

{
  "id": "monitoring",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "monitoring",
        "id": "def-server.IBulkUploader",
        "type": "Interface",
        "tags": [],
        "label": "IBulkUploader",
        "description": [],
        "path": "x-pack/platform/plugins/private/monitoring/server/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "monitoring",
            "id": "def-server.IBulkUploader.getKibanaStats",
            "type": "Function",
            "tags": [],
            "label": "getKibanaStats",
            "description": [],
            "signature": [
              "() => any"
            ],
            "path": "x-pack/platform/plugins/private/monitoring/server/types.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "monitoring",
            "id": "def-server.IBulkUploader.stop",
            "type": "Function",
            "tags": [],
            "label": "stop",
            "description": [],
            "signature": [
              "() => void"
            ],
            "path": "x-pack/platform/plugins/private/monitoring/server/types.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "monitoring",
            "id": "def-server.IBulkUploader.start",
            "type": "Function",
            "tags": [],
            "label": "start",
            "description": [],
            "signature": [
              "(esClient: ",
              "ElasticsearchClient",
              ") => void"
            ],
            "path": "x-pack/platform/plugins/private/monitoring/server/types.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "monitoring",
                "id": "def-server.IBulkUploader.start.$1",
                "type": "Object",
                "tags": [],
                "label": "esClient",
                "description": [],
                "signature": [
                  "ElasticsearchClient"
                ],
                "path": "x-pack/platform/plugins/private/monitoring/server/types.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "monitoring",
            "id": "def-server.IBulkUploader.handleNotEnabled",
            "type": "Function",
            "tags": [],
            "label": "handleNotEnabled",
            "description": [],
            "signature": [
              "() => void"
            ],
            "path": "x-pack/platform/plugins/private/monitoring/server/types.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "monitoring",
        "id": "def-server.MonitoringConfig",
        "type": "Interface",
        "tags": [],
        "label": "MonitoringConfig",
        "description": [
          "\nA functional representation of the `monitoring.*` configuration tree passed in from kibana.yml"
        ],
        "signature": [
          {
            "pluginId": "monitoring",
            "scope": "server",
            "docId": "kibMonitoringPluginApi",
            "section": "def-server.MonitoringConfig",
            "text": "MonitoringConfig"
          },
          " extends MonitoringConfigTypeOverriddenUI"
        ],
        "path": "x-pack/platform/plugins/private/monitoring/server/config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "monitoring",
            "id": "def-server.MonitoringConfig.ui",
            "type": "Object",
            "tags": [],
            "label": "ui",
            "description": [
              "\nA functional representation of the `monitoring.ui.*` configuration tree passed in from kibana.yml"
            ],
            "signature": [
              "MonitoringConfigTypeOverriddenUIElasticsearch"
            ],
            "path": "x-pack/platform/plugins/private/monitoring/server/config.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "monitoring",
        "id": "def-server.KibanaSettingsCollector",
        "type": "Type",
        "tags": [],
        "label": "KibanaSettingsCollector",
        "description": [],
        "signature": [
          {
            "pluginId": "usageCollection",
            "scope": "server",
            "docId": "kibUsageCollectionPluginApi",
            "section": "def-server.ICollector",
            "text": "ICollector"
          },
          "<EmailSettingData | undefined, {}> & ",
          "KibanaSettingsCollectorExtraOptions"
        ],
        "path": "x-pack/platform/plugins/private/monitoring/server/kibana_monitoring/collectors/get_settings_collector.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "monitoring",
      "id": "def-server.MonitoringPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "MonitoringPluginSetup",
      "description": [],
      "path": "x-pack/platform/plugins/private/monitoring/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "monitoring",
          "id": "def-server.MonitoringPluginSetup.getKibanaStats",
          "type": "Function",
          "tags": [],
          "label": "getKibanaStats",
          "description": [],
          "signature": [
            "() => any"
          ],
          "path": "x-pack/platform/plugins/private/monitoring/server/types.ts",
          "deprecated": false,
          "trackAdoption": false,
          "returnComment": [],
          "children": []
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "monitoring",
        "id": "def-common.formatTimestampToDuration",
        "type": "Function",
        "tags": [],
        "label": "formatTimestampToDuration",
        "description": [],
        "signature": [
          "(timestamp: any, calculationFlag: any, initialTime: any) => string"
        ],
        "path": "x-pack/platform/plugins/private/monitoring/common/format_timestamp_to_duration.js",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "monitoring",
            "id": "def-common.formatTimestampToDuration.$1",
            "type": "Any",
            "tags": [],
            "label": "timestamp",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "x-pack/platform/plugins/private/monitoring/common/format_timestamp_to_duration.js",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "monitoring",
            "id": "def-common.formatTimestampToDuration.$2",
            "type": "Any",
            "tags": [],
            "label": "calculationFlag",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "x-pack/platform/plugins/private/monitoring/common/format_timestamp_to_duration.js",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "monitoring",
            "id": "def-common.formatTimestampToDuration.$3",
            "type": "Any",
            "tags": [],
            "label": "initialTime",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "x-pack/platform/plugins/private/monitoring/common/format_timestamp_to_duration.js",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}