diff --git a/docs/calling/navigation.html b/docs/calling/navigation.html index af1ba200d2d..75ab5a093fc 100644 --- a/docs/calling/navigation.html +++ b/docs/calling/navigation.html @@ -1591,6 +1591,31 @@ +
+LoggerType in order from lowest to the highest severity level.
the Config object which contains the configuration of the logger
the Tag object which identifies the source of the log message. Can combine multiple data and turns it into structured String used by the KermitLogger so that it can be parsed back again to the Tag object. To know more how it behaves and what are the possibilities, take a look at the Tag sealed class and its subtypes.
User-related data tag. Contains String text prefix and UserClientData (userId and clientId). It will be added to the tag in the standard pattern: "taguserId|clientId", so it can be combined with a Tag.Text type by adding the tag text as a prefix in this one.
Defined types of tags that can be provided to the KaliumLogger as a String text.
Simple String text tag.
User-related data tag. Contains String text prefix and UserClientData (userId and clientId). It will be added to the tag in the standard pattern: "taguserId|clientId", so it can be combined with a Tag.Text type by adding the tag text as a prefix in this one.
Parses the user-related data from the String tag in the standard pattern: "taguserId|clientId". Returns null if the tag doesn't match the pattern, which means it does not contain user-related data.
the logWriter is to create a custom writer other than the existing log writers from kermit to intercept the logs in the android case we use it to write the logs on file
Custom logger writer which uses multiplatform KermitLogger underneath to allow to customize log message or tag.
the Config object which contains the configuration of the logger
the Tag object which identifies the source of the log message. Can combine multiple data and turns it into structured String used by the KermitLogger so that it can be parsed back again to the Tag object. To know more how it behaves and what are the possibilities, take a look at the Tag sealed class and its subtypes.
Defined types of tags that can be provided to the KaliumLogger as a String text.
Creates a new logger with custom tag that replaces the old tag and allows to specify which specific app flow, one of ApplicationFlow, the logs sent by this logger relate to. When the logger already contains Tag.UserClientText type of logs, then user-related tag data will still be included, and this featureId tag part will be added as a prefix, to keep the standard pattern of the tag: "taguserId|clientId". In this case it will become "featureId:featureNameuserId|clientId". When current type of tag is Tag.Text, then it will just replace it with the new one: "featureId:featureName".
Creates a new logger with custom tag that replaces the old tag and allows to add user-related data to the tag. When the logger already contains Tag.UserClientText type of tag, then user-related tag data part will be replaced, and if it contained already some text tag prefix part, then the same prefix will be also included in the new one, to keep the standard pattern of the tag: "taguserId|clientId".
Creates a new logger with custom tag that replaces the old tag and allows to specify which specific app flow, one of ApplicationFlow, the logs sent by this logger relate to. When the logger already contains Tag.UserClientText type of logs, then user-related tag data will still be included, and this featureId tag part will be added as a prefix, to keep the standard pattern of the tag: "taguserId|clientId". In this case it will become "featureId:featureNameuserId|clientId". When current type of tag is Tag.Text, then it will just replace it with the new one: "featureId:featureName".
Creates a new logger with custom tag that replaces the old tag and allows to add user-related data to the tag. When the logger already contains Tag.UserClientText type of tag, then user-related tag data part will be replaced, and if it contained already some text tag prefix part, then the same prefix will be also included in the new one, to keep the standard pattern of the tag: "taguserId|clientId".
the logWriter is to create a custom writer other than the existing log writers from kermit to intercept the logs in the android case we use it to write the logs on file
Custom logger writer which uses multiplatform KermitLogger underneath to allow to customize log message or tag.