6723fa583f
* Add packages * Update docs * Fix test and types * debug heap size * remove debug heap line * updated docs
1181 lines
38 KiB
JSON
1181 lines
38 KiB
JSON
{
|
|
"id": "@kbn/analytics",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ApplicationUsageTracker",
|
|
"description": [],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "reporter",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Reporter",
|
|
"text": "Reporter"
|
|
}
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.serializeKey",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "serializeKey",
|
|
"description": [],
|
|
"signature": [
|
|
"({ appId, viewId }: ApplicationKey) => string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.serializeKey.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ appId, viewId }",
|
|
"description": [],
|
|
"signature": [
|
|
"ApplicationKey"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.updateViewClickCounter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateViewClickCounter",
|
|
"description": [],
|
|
"signature": [
|
|
"(viewId: string) => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.updateViewClickCounter.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "viewId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.setCurrentAppId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setCurrentAppId",
|
|
"description": [],
|
|
"signature": [
|
|
"(appId: string) => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.setCurrentAppId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.trackApplicationViewUsage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "trackApplicationViewUsage",
|
|
"description": [],
|
|
"signature": [
|
|
"(viewId: string) => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.trackApplicationViewUsage.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "viewId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.pauseTrackingAll",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pauseTrackingAll",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.resumeTrackingAll",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "resumeTrackingAll",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.flushTrackedView",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "flushTrackedView",
|
|
"description": [],
|
|
"signature": [
|
|
"(viewId: string) => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ApplicationUsageTracker.flushTrackedView.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "viewId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/application_usage_tracker.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "Reporter",
|
|
"description": [],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.checkInterval",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "checkInterval",
|
|
"description": [],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.ReporterConfig",
|
|
"text": "ReporterConfig"
|
|
}
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportUiCounter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportUiCounter",
|
|
"description": [],
|
|
"signature": [
|
|
"(appName: string, type: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
},
|
|
", eventNames: string | string[], count?: number | undefined) => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportUiCounter.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportUiCounter.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
}
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportUiCounter.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "eventNames",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportUiCounter.$4",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportUserAgent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportUserAgent",
|
|
"description": [],
|
|
"signature": [
|
|
"(appName: string) => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportUserAgent.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportApplicationUsage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportApplicationUsage",
|
|
"description": [],
|
|
"signature": [
|
|
"(appUsageReport: ",
|
|
"ApplicationUsageMetric",
|
|
") => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.reportApplicationUsage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "appUsageReport",
|
|
"description": [],
|
|
"signature": [
|
|
"ApplicationUsageMetric"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Reporter.sendReports",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "sendReports",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ReportManager",
|
|
"description": [],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.REPORT_VERSION",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "REPORT_VERSION",
|
|
"description": [],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.report",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "report",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
}
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "report",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.createReport",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createReport",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
}
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.clearReport",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clearReport",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.isReportEmpty",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isReportEmpty",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.assignReports",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "assignReports",
|
|
"description": [],
|
|
"signature": [
|
|
"(newMetrics: ",
|
|
"ApplicationUsageMetric",
|
|
" | ",
|
|
"UiCounterMetric",
|
|
" | ",
|
|
"UserAgentMetric",
|
|
" | ",
|
|
"Metric",
|
|
"[]) => { report: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.assignReports.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "newMetrics",
|
|
"description": [],
|
|
"signature": [
|
|
"ApplicationUsageMetric",
|
|
" | ",
|
|
"UiCounterMetric",
|
|
" | ",
|
|
"UserAgentMetric",
|
|
" | ",
|
|
"Metric",
|
|
"[]"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.createMetricKey",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createMetricKey",
|
|
"description": [],
|
|
"signature": [
|
|
"(metric: ",
|
|
"Metric",
|
|
") => string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportManager.createMetricKey.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "metric",
|
|
"description": [],
|
|
"signature": [
|
|
"Metric"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Report",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Report",
|
|
"description": [],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Report.reportVersion",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "reportVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"3"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Report.uiCounter",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiCounter",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, { key: string; appName: string; eventName: string; type: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
},
|
|
"; total: number; }> | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Report.userAgent",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "userAgent",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, { userAgent: string; key: string; type: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.METRIC_TYPE",
|
|
"text": "METRIC_TYPE"
|
|
},
|
|
".USER_AGENT; appName: string; }> | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Report.application_usage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "application_usage",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, { appId: string; viewId: string; minutesOnScreen: number; numberOfClicks: number; }> | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/report.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReporterConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReporterConfig",
|
|
"description": [],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReporterConfig.http",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [],
|
|
"signature": [
|
|
"(report: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
},
|
|
") => Promise<void>"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReporterConfig.http.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "report",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
}
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReporterConfig.storage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "storage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Storage",
|
|
"text": "Storage"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
},
|
|
", void> | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReporterConfig.checkInterval",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "checkInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReporterConfig.debug",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "debug",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReporterConfig.storageKey",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "storageKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Storage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Storage",
|
|
"text": "Storage"
|
|
},
|
|
"<T, S>"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string) => T | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage.get.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string, value: T) => S"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage.set.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage.set.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage.remove",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "remove",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string) => T | undefined"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage.remove.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.Storage.clear",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clear",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/kbn-analytics/src/storage.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.METRIC_TYPE",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "METRIC_TYPE",
|
|
"description": [],
|
|
"path": "packages/kbn-analytics/src/metrics/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportHTTP",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ReportHTTP",
|
|
"description": [],
|
|
"signature": [
|
|
"(report: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
},
|
|
") => Promise<void>"
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.ReportHTTP.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "report",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.Report",
|
|
"text": "Report"
|
|
}
|
|
],
|
|
"path": "packages/kbn-analytics/src/reporter.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics",
|
|
"id": "def-common.UiCounterMetricType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UiCounterMetricType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.METRIC_TYPE",
|
|
"text": "METRIC_TYPE"
|
|
},
|
|
".COUNT | ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.METRIC_TYPE",
|
|
"text": "METRIC_TYPE"
|
|
},
|
|
".LOADED | ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.METRIC_TYPE",
|
|
"text": "METRIC_TYPE"
|
|
},
|
|
".CLICK"
|
|
],
|
|
"path": "packages/kbn-analytics/src/metrics/ui_counter.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |