"\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":[
"<Meta extends ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
" = ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
">(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":[
"<Meta extends ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
" = ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
">(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":[
"<Meta extends ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
" = ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
">(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":[
"<Meta extends ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
" = ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
">(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":[
"<Meta extends ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
" = ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
">(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":[
"<Meta extends ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
" = ",
{
"pluginId":"@kbn/logging",
"scope":"server",
"docId":"kibKbnLoggingPluginApi",
"section":"def-server.LogMeta",
"text":"LogMeta"
},
">(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"