mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
0cb1087fb4
* [api-docs] Add pipeline to build api_docs daily * Fix kibanamachine remote * Add --repo * Fix PR creation * [api-docs] Daily api_docs build Co-authored-by: Brian Seeders <brian.seeders@elastic.co>
328 lines
No EOL
12 KiB
JSON
328 lines
No EOL
12 KiB
JSON
{
|
|
"id": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ElasticV3ServerShipper",
|
|
"description": [
|
|
"\nElastic V3 shipper to use on the server side."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnAnalyticsShippersElasticV3ServerPluginApi",
|
|
"section": "def-server.ElasticV3ServerShipper",
|
|
"text": "ElasticV3ServerShipper"
|
|
},
|
|
" implements ",
|
|
"IShipper"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.shipperName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "shipperName",
|
|
"description": [
|
|
"Shipper's unique name"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.telemetryCounter$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "telemetryCounter$",
|
|
"description": [
|
|
"Observable to emit the stats of the processed events."
|
|
],
|
|
"signature": [
|
|
"Subject",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [
|
|
"\nCreates a new instance of the {@link ElasticV3ServerShipper}."
|
|
],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"{@link ElasticV3ShipperOptions }"
|
|
],
|
|
"signature": [
|
|
"ElasticV3ShipperOptions"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initContext",
|
|
"description": [
|
|
"{@link AnalyticsClientInitContext }"
|
|
],
|
|
"signature": [
|
|
"AnalyticsClientInitContext"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.extendContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "extendContext",
|
|
"description": [
|
|
"\nUses the `cluster_uuid` and `license_id` from the context to hold them in memory for the generation of the headers\nused later on in the HTTP request."
|
|
],
|
|
"signature": [
|
|
"(newContext: ",
|
|
"EventContext",
|
|
") => void"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.extendContext.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newContext",
|
|
"description": [
|
|
"The full new context to set {@link EventContext }"
|
|
],
|
|
"signature": [
|
|
"EventContext"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.optIn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "optIn",
|
|
"description": [
|
|
"\nWhen `false`, it flushes the internal queue and stops sending events."
|
|
],
|
|
"signature": [
|
|
"(isOptedIn: boolean) => void"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.optIn.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isOptedIn",
|
|
"description": [
|
|
"`true` for resume sending events. `false` to stop."
|
|
],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.reportEvents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportEvents",
|
|
"description": [
|
|
"\nEnqueues the events to be sent via the leaky bucket algorithm."
|
|
],
|
|
"signature": [
|
|
"(events: ",
|
|
"Event",
|
|
"[]) => void"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.reportEvents.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "events",
|
|
"description": [
|
|
"batched events {@link Event }"
|
|
],
|
|
"signature": [
|
|
"Event",
|
|
"[]"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ServerShipper.shutdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shutdown",
|
|
"description": [
|
|
"\nShuts down the shipper.\nTriggers a flush of the internal queue to attempt to send any events held in the queue."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ShipperOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticV3ShipperOptions",
|
|
"description": [
|
|
"\r\nOptions for the Elastic V3 shipper"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ShipperOptions.channelName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "channelName",
|
|
"description": [
|
|
"\r\nThe name of the channel to stream all the events to."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ShipperOptions.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\r\nThe product's version."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ShipperOptions.sendTo",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sendTo",
|
|
"description": [
|
|
"\r\nProvide it to override the Analytics client's default configuration."
|
|
],
|
|
"signature": [
|
|
"\"staging\" | \"production\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-shippers-elastic-v3-server",
|
|
"id": "def-server.ElasticV3ShipperOptions.debug",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "debug",
|
|
"description": [
|
|
"\r\nShould show debug information about the requests it makes to the V3 API."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |