{ "id": "monitoringCollection", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "monitoringCollection", "id": "def-server.Metric", "type": "Interface", "tags": [], "label": "Metric", "description": [], "signature": [ { "pluginId": "monitoringCollection", "scope": "server", "docId": "kibMonitoringCollectionPluginApi", "section": "def-server.Metric", "text": "Metric" }, "" ], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "monitoringCollection", "id": "def-server.Metric.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "monitoringCollection", "id": "def-server.Metric.schema", "type": "Object", "tags": [], "label": "schema", "description": [], "signature": [ "{ [Key in keyof Required]: Required[Key] extends (infer U)[] ? { type: \"array\"; items: ", "RecursiveMakeSchemaFrom", "; } : ", "RecursiveMakeSchemaFrom", "[Key]>; }" ], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "monitoringCollection", "id": "def-server.Metric.fetch", "type": "Function", "tags": [], "label": "fetch", "description": [], "signature": [ "() => Promise<", { "pluginId": "monitoringCollection", "scope": "server", "docId": "kibMonitoringCollectionPluginApi", "section": "def-server.MetricResult", "text": "MetricResult" }, " | ", { "pluginId": "monitoringCollection", "scope": "server", "docId": "kibMonitoringCollectionPluginApi", "section": "def-server.MetricResult", "text": "MetricResult" }, "[]>" ], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "monitoringCollection", "id": "def-server.MetricResult", "type": "Type", "tags": [], "label": "MetricResult", "description": [], "signature": [ "T & ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.JsonObject", "text": "JsonObject" } ], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "monitoringCollection", "id": "def-server.MonitoringCollectionConfig", "type": "Type", "tags": [], "label": "MonitoringCollectionConfig", "description": [], "signature": [ "{ readonly enabled: boolean; readonly opentelemetry: Readonly<{} & { metrics: Readonly<{} & { otlp: Readonly<{ headers?: Record | undefined; url?: string | undefined; } & { exportIntervalMillis: number; logLevel: string; }>; prometheus: Readonly<{} & { enabled: boolean; }>; }>; }>; }" ], "path": "x-pack/plugins/monitoring_collection/server/config.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "monitoringCollection", "id": "def-server.MonitoringCollectionSetup", "type": "Interface", "tags": [], "label": "MonitoringCollectionSetup", "description": [], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "monitoringCollection", "id": "def-server.MonitoringCollectionSetup.registerMetric", "type": "Function", "tags": [], "label": "registerMetric", "description": [], "signature": [ "(metric: ", { "pluginId": "monitoringCollection", "scope": "server", "docId": "kibMonitoringCollectionPluginApi", "section": "def-server.Metric", "text": "Metric" }, ") => void" ], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "monitoringCollection", "id": "def-server.MonitoringCollectionSetup.registerMetric.$1", "type": "Object", "tags": [], "label": "metric", "description": [], "signature": [ { "pluginId": "monitoringCollection", "scope": "server", "docId": "kibMonitoringCollectionPluginApi", "section": "def-server.Metric", "text": "Metric" }, "" ], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }