kibana/api_docs/monitoring.json

186 lines
5.8 KiB
JSON
Raw Normal View History

{
"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": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 94
},
"deprecated": false,
"children": [
{
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader.getKibanaStats",
"type": "Function",
"tags": [],
"label": "getKibanaStats",
"description": [],
"signature": [
"() => any"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 95
},
"deprecated": false
},
{
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 96
},
"deprecated": false
},
{
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
") => void"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 97
},
"deprecated": false
},
{
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader.handleNotEnabled",
"type": "Function",
"tags": [],
"label": "handleNotEnabled",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 98
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "monitoring",
"id": "def-server.KibanaSettingsCollector",
"type": "Type",
"tags": [],
"label": "KibanaSettingsCollector",
"description": [],
"signature": [
"Collector<EmailSettingData | undefined, {}> & KibanaSettingsCollectorExtraOptions"
],
"source": {
"path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_settings_collector.ts",
API docs clean up (#93508) (#93881) * Fix links to github * Fix links to github * Update docs to latest * Sort, remove unneccessary path info, reduce tags * Go back to having DocDef create the link to avoid backport conflicts * update api docs # Conflicts: # api_docs/actions.json # api_docs/advanced_settings.json # api_docs/alerting.json # api_docs/apm.json # api_docs/apm_oss.json # api_docs/banners.json # api_docs/beats_management.json # api_docs/bfetch.json # api_docs/canvas.json # api_docs/case.json # api_docs/charts.json # api_docs/cloud.json # api_docs/console.json # api_docs/core.json # api_docs/core_application.json # api_docs/core_chrome.json # api_docs/core_http.json # api_docs/core_saved_objects.json # api_docs/dashboard.json # api_docs/dashboard_enhanced.json # api_docs/dashboard_mode.json # api_docs/data.json # api_docs/data_autocomplete.json # api_docs/data_enhanced.json # api_docs/data_field_formats.json # api_docs/data_index_patterns.json # api_docs/data_query.json # api_docs/data_search.json # api_docs/data_ui.json # api_docs/dev_tools.json # api_docs/discover.json # api_docs/discover_enhanced.json # api_docs/embeddable.json # api_docs/embeddable_enhanced.json # api_docs/encrypted_saved_objects.json # api_docs/enterprise_search.json # api_docs/es_ui_shared.json # api_docs/event_log.json # api_docs/expressions.json # api_docs/features.json # api_docs/file_upload.json # api_docs/fleet.json # api_docs/global_search.json # api_docs/home.json # api_docs/index_lifecycle_management.json # api_docs/index_management.json # api_docs/index_pattern_field_editor.json # api_docs/index_pattern_management.json # api_docs/infra.json # api_docs/ingest_pipelines.json # api_docs/inspector.json # api_docs/kibana_legacy.json # api_docs/kibana_react.json # api_docs/kibana_utils.json # api_docs/lens.json # api_docs/license_management.json # api_docs/licensing.json # api_docs/lists.json # api_docs/management.json # api_docs/maps.json # api_docs/maps_legacy.json # api_docs/ml.json # api_docs/monitoring.json # api_docs/navigation.json # api_docs/newsfeed.json # api_docs/observability.json # api_docs/osquery.json # api_docs/presentation_util.json # api_docs/remote_clusters.json # api_docs/reporting.json # api_docs/rollup.json # api_docs/runtime_fields.json # api_docs/saved_objects.json # api_docs/saved_objects_management.json # api_docs/saved_objects_tagging.json # api_docs/saved_objects_tagging_oss.json # api_docs/security.json # api_docs/security_oss.json # api_docs/security_solution.json # api_docs/share.json # api_docs/snapshot_restore.json # api_docs/spaces.json # api_docs/spaces_oss.json # api_docs/stack_alerts.json # api_docs/task_manager.json # api_docs/telemetry.json # api_docs/telemetry_collection_manager.json # api_docs/telemetry_collection_xpack.json # api_docs/telemetry_management_section.json # api_docs/triggers_actions_ui.json # api_docs/ui_actions.json # api_docs/ui_actions_enhanced.json # api_docs/uptime.json # api_docs/url_forwarding.json # api_docs/usage_collection.json # api_docs/vis_type_timeseries.json # api_docs/visualizations.json
2021-03-06 16:05:27 +01:00
"lineNumber": 79
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "monitoring",
"id": "def-server.MonitoringConfig",
"type": "Type",
"tags": [],
"label": "MonitoringConfig",
"description": [],
"signature": [
"{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; metricbeat: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; agent: Readonly<{} & { interval: string; }>; licensing: Readonly<{} & { api_polling_frequency: ",
"Duration",
"; }>; cluster_alerts: Readonly<{} & { enabled: boolean; allowedSpaces: string[]; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }"
],
"source": {
"path": "x-pack/plugins/monitoring/server/config.ts",
"lineNumber": 93
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "monitoring",
"id": "def-server.MonitoringPluginSetup",
"type": "Interface",
"tags": [],
"label": "MonitoringPluginSetup",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 101
},
"deprecated": false,
"children": [
{
"parentPluginId": "monitoring",
"id": "def-server.MonitoringPluginSetup.getKibanaStats",
"type": "Function",
"tags": [],
"label": "getKibanaStats",
"description": [],
"signature": [
"() => any"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 102
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}