kibana/api_docs/monitoring.json
Stacey Gammon 503cfcf8c9
Track API stats as part of ci (#95733)
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-15 11:36:10 -04:00

168 lines
5.2 KiB
JSON

{
"id": "monitoring",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-server.IBulkUploader",
"type": "Interface",
"label": "IBulkUploader",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.IBulkUploader.getKibanaStats",
"type": "Function",
"label": "getKibanaStats",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 94
},
"signature": [
"() => any"
]
},
{
"tags": [],
"id": "def-server.IBulkUploader.stop",
"type": "Function",
"label": "stop",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 95
},
"signature": [
"() => void"
]
},
{
"tags": [],
"id": "def-server.IBulkUploader.start",
"type": "Function",
"label": "start",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 96
},
"signature": [
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
") => void"
]
},
{
"tags": [],
"id": "def-server.IBulkUploader.handleNotEnabled",
"type": "Function",
"label": "handleNotEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 97
},
"signature": [
"() => void"
]
}
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 93
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-server.KibanaSettingsCollector",
"type": "Type",
"label": "KibanaSettingsCollector",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_settings_collector.ts",
"lineNumber": 53
},
"signature": [
"Collector<EmailSettingData | undefined, {}> & KibanaSettingsCollectorExtraOptions"
],
"initialIsOpen": false
},
{
"id": "def-server.MonitoringConfig",
"type": "Type",
"label": "MonitoringConfig",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/config.ts",
"lineNumber": 92
},
"signature": [
"{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; metricbeat: Readonly<{} & { index: string; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; licensing: Readonly<{} & { api_polling_frequency: ",
"Duration",
"; }>; agent: Readonly<{} & { interval: string; }>; cluster_alerts: Readonly<{} & { enabled: boolean; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }"
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-server.MonitoringPluginSetup",
"type": "Interface",
"label": "MonitoringPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.MonitoringPluginSetup.getKibanaStats",
"type": "Function",
"label": "getKibanaStats",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 101
},
"signature": [
"() => any"
]
}
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 100
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}