{
"id": "@kbn/logging",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger",
"type": "Interface",
"tags": [],
"label": "Logger",
"description": [
"\nLogger exposes all the necessary methods to log any type of information and\nthis is the interface used by the logging consumers including plugins.\n"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.trace",
"type": "Function",
"tags": [],
"label": "trace",
"description": [
"\nLog messages at the most detailed log level\n"
],
"signature": [
"(message: string, meta?: Meta | undefined) => void"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.trace.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [
"- The log message"
],
"signature": [
"string"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.trace.$2",
"type": "Uncategorized",
"tags": [],
"label": "meta",
"description": [
"-"
],
"signature": [
"Meta | undefined"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.debug",
"type": "Function",
"tags": [],
"label": "debug",
"description": [
"\nLog messages useful for debugging and interactive investigation"
],
"signature": [
"(message: string, meta?: Meta | undefined) => void"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.debug.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [
"- The log message"
],
"signature": [
"string"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.debug.$2",
"type": "Uncategorized",
"tags": [],
"label": "meta",
"description": [
"-"
],
"signature": [
"Meta | undefined"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.info",
"type": "Function",
"tags": [],
"label": "info",
"description": [
"\nLogs messages related to general application flow"
],
"signature": [
"(message: string, meta?: Meta | undefined) => void"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.info.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [
"- The log message"
],
"signature": [
"string"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.info.$2",
"type": "Uncategorized",
"tags": [],
"label": "meta",
"description": [
"-"
],
"signature": [
"Meta | undefined"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.warn",
"type": "Function",
"tags": [],
"label": "warn",
"description": [
"\nLogs abnormal or unexpected errors or messages"
],
"signature": [
"(errorOrMessage: string | Error, meta?: Meta | undefined) => void"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.warn.$1",
"type": "CompoundType",
"tags": [],
"label": "errorOrMessage",
"description": [
"- An Error object or message string to log"
],
"signature": [
"string | Error"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.warn.$2",
"type": "Uncategorized",
"tags": [],
"label": "meta",
"description": [
"-"
],
"signature": [
"Meta | undefined"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.error",
"type": "Function",
"tags": [],
"label": "error",
"description": [
"\nLogs abnormal or unexpected errors or messages that caused a failure in the application flow\n"
],
"signature": [
"(errorOrMessage: string | Error, meta?: Meta | undefined) => void"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.error.$1",
"type": "CompoundType",
"tags": [],
"label": "errorOrMessage",
"description": [
"- An Error object or message string to log"
],
"signature": [
"string | Error"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.error.$2",
"type": "Uncategorized",
"tags": [],
"label": "meta",
"description": [
"-"
],
"signature": [
"Meta | undefined"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.fatal",
"type": "Function",
"tags": [],
"label": "fatal",
"description": [
"\nLogs abnormal or unexpected errors or messages that caused an unrecoverable failure\n"
],
"signature": [
"(errorOrMessage: string | Error, meta?: Meta | undefined) => void"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.fatal.$1",
"type": "CompoundType",
"tags": [],
"label": "errorOrMessage",
"description": [
"- An Error object or message string to log"
],
"signature": [
"string | Error"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.fatal.$2",
"type": "Uncategorized",
"tags": [],
"label": "meta",
"description": [
"-"
],
"signature": [
"Meta | undefined"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [
"\nReturns a new {@link Logger} instance extending the current logger context.\n"
],
"signature": [
"(...childContextPaths: string[]) => ",
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Logger.get.$1",
"type": "Array",
"tags": [],
"label": "childContextPaths",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-logging/src/logger.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.LoggerFactory",
"type": "Interface",
"tags": [],
"label": "LoggerFactory",
"description": [
"\nThe single purpose of `LoggerFactory` interface is to define a way to\nretrieve a context-based logger instance.\n"
],
"path": "packages/kbn-logging/src/logger_factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.LoggerFactory.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [
"\nReturns a `Logger` instance for the specified context.\n"
],
"signature": [
"(...contextParts: string[]) => ",
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "packages/kbn-logging/src/logger_factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.LoggerFactory.get.$1",
"type": "Array",
"tags": [],
"label": "contextParts",
"description": [
"- Parts of the context to return logger for. For example\nget('plugins', 'pid') will return a logger for the `plugins.pid` context."
],
"signature": [
"string[]"
],
"path": "packages/kbn-logging/src/logger_factory.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/logging",
"id": "def-server.Ecs",
"type": "Type",
"tags": [],
"label": "Ecs",
"description": [
"\nRepresents the full ECS schema.\n"
],
"signature": [
"EcsBase",
" & ",
"EcsTracing",
" & { ecs: EcsField; agent?: ",
"EcsAgent",
" | undefined; as?: ",
"EcsAutonomousSystem",
" | undefined; client?: ",
"EcsClient",
" | undefined; cloud?: ",
"EcsCloud",
" | undefined; container?: ",
"EcsContainer",
" | undefined; data_stream?: ",
"EcsDataStream",
" | undefined; destination?: ",
"EcsDestination",
" | undefined; dns?: ",
"EcsDns",
" | undefined; email?: ",
"EcsEmail",
" | undefined; error?: ",
"EcsError",
" | undefined; event?: ",
"EcsEvent",
" | undefined; file?: ",
"EcsFile",
" | undefined; group?: ",
"EcsGroup",
" | undefined; host?: ",
"EcsHost",
" | undefined; http?: ",
"EcsHttp",
" | undefined; log?: ",
"EcsLog",
" | undefined; network?: ",
"EcsNetwork",
" | undefined; observer?: ",
"EcsObserver",
" | undefined; orchestrator?: ",
"EcsOrchestrator",
" | undefined; organization?: ",
"EcsOrganization",
" | undefined; package?: ",
"EcsPackage",
" | undefined; process?: ",
"EcsProcess",
" | undefined; registry?: ",
"EcsRegistry",
" | undefined; related?: ",
"EcsRelated",
" | undefined; rule?: ",
"EcsRule",
" | undefined; server?: ",
"EcsServer",
" | undefined; service?: ",
"EcsService",
" | undefined; source?: ",
"EcsSource",
" | undefined; threat?: ",
"EcsThreat",
" | undefined; tls?: ",
"EcsTls",
" | undefined; url?: ",
"EcsUrl",
" | undefined; user?: ",
"EcsUser",
" | undefined; user_agent?: ",
"EcsUserAgent",
" | undefined; vulnerability?: ",
"EcsVulnerability",
" | undefined; }"
],
"path": "packages/kbn-logging/src/ecs/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.EcsEventCategory",
"type": "Type",
"tags": [],
"label": "EcsEventCategory",
"description": [],
"signature": [
"\"network\" | \"web\" | \"database\" | \"package\" | \"host\" | \"session\" | \"file\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\""
],
"path": "packages/kbn-logging/src/ecs/event.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.EcsEventKind",
"type": "Type",
"tags": [],
"label": "EcsEventKind",
"description": [],
"signature": [
"\"alert\" | \"metric\" | \"event\" | \"state\" | \"signal\" | \"pipeline_error\""
],
"path": "packages/kbn-logging/src/ecs/event.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.EcsEventOutcome",
"type": "Type",
"tags": [],
"label": "EcsEventOutcome",
"description": [],
"signature": [
"\"unknown\" | \"success\" | \"failure\""
],
"path": "packages/kbn-logging/src/ecs/event.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.EcsEventType",
"type": "Type",
"tags": [],
"label": "EcsEventType",
"description": [],
"signature": [
"\"start\" | \"end\" | \"user\" | \"info\" | \"group\" | \"error\" | \"connection\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\""
],
"path": "packages/kbn-logging/src/ecs/event.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/logging",
"id": "def-server.LogMeta",
"type": "Type",
"tags": [],
"label": "LogMeta",
"description": [
"\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n"
],
"signature": [
"Pick<",
"EcsBase",
", \"tags\" | \"labels\"> & ",
"EcsTracing",
" & { agent?: ",
"EcsAgent",
" | undefined; as?: ",
"EcsAutonomousSystem",
" | undefined; client?: ",
"EcsClient",
" | undefined; cloud?: ",
"EcsCloud",
" | undefined; container?: ",
"EcsContainer",
" | undefined; destination?: ",
"EcsDestination",
" | undefined; dns?: ",
"EcsDns",
" | undefined; error?: ",
"EcsError",
" | undefined; event?: ",
"EcsEvent",
" | undefined; file?: ",
"EcsFile",
" | undefined; group?: ",
"EcsGroup",
" | undefined; host?: ",
"EcsHost",
" | undefined; http?: ",
"EcsHttp",
" | undefined; log?: Pick<",
"EcsLog",
", \"origin\" | \"file\" | \"syslog\"> | undefined; network?: ",
"EcsNetwork",
" | undefined; observer?: ",
"EcsObserver",
" | undefined; organization?: ",
"EcsOrganization",
" | undefined; package?: ",
"EcsPackage",
" | undefined; process?: ",
"EcsProcess",
" | undefined; registry?: ",
"EcsRegistry",
" | undefined; related?: ",
"EcsRelated",
" | undefined; rule?: ",
"EcsRule",
" | undefined; server?: ",
"EcsServer",
" | undefined; service?: ",
"EcsService",
" | undefined; source?: ",
"EcsSource",
" | undefined; threat?: ",
"EcsThreat",
" | undefined; tls?: ",
"EcsTls",
" | undefined; url?: ",
"EcsUrl",
" | undefined; user?: ",
"EcsUser",
" | undefined; user_agent?: ",
"EcsUserAgent",
" | undefined; vulnerability?: ",
"EcsVulnerability",
" | undefined; }"
],
"path": "packages/kbn-logging/src/log_meta.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}