docs.unity3d.com
    Show / Hide Table of Contents

    Class FileSinkSystemExt

    Extension class for LoggerWriterConfig .File

    Inheritance
    Object
    FileSinkSystemExt
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Logging.Sinks
    Syntax
    public static class FileSinkSystemExt

    Methods

    File(LoggerWriterConfig, String, FormatterStruct, Int64, Int32, TimeSpan, Nullable<Boolean>, Nullable<LogLevel>, Nullable<FixedString512Bytes>)

    Write logs to the file in a text form

    Declaration
    public static LoggerConfig File(this LoggerWriterConfig writeTo, string absFileName, FormatterStruct formatter = default(FormatterStruct), long maxFileSizeBytes = 5242880L, int maxRoll = 15, TimeSpan maxTimeSpan = default(TimeSpan), bool? captureStackTrace = null, LogLevel? minLevel = null, FixedString512Bytes? outputTemplate = null)
    Parameters
    Type Name Description
    LoggerWriterConfig writeTo

    Logger config

    String absFileName

    Absolute file path to the log file

    FormatterStruct formatter

    Formatter that should be used by this sink. Text is default

    Int64 maxFileSizeBytes

    Threshold of file size in bytes after which new file should be created (rolling). Default of 5 MB. Set to 0 MB if no rolling by file size is needed

    Int32 maxRoll

    Max amount of rolls after which old files will be rewritten

    TimeSpan maxTimeSpan

    Threshold of time after which new file should be created (rolling). 'default' if no rolling by time is needed

    Nullable<Boolean> captureStackTrace

    True if stack traces should be captured

    Nullable<LogLevel> minLevel

    Minimal level of logs for this particular sink. Null if common level should be used

    Nullable<FixedString512Bytes> outputTemplate

    Output message template for this particular sink. Null if common template should be used

    Returns
    Type Description
    LoggerConfig

    Logger config

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023