General Settings

The content of this article is also available as a video tutorial.

After installing the package and associating your account with the Project Token, your applications will be protected during compilation. It's that simple ✨. Protection occurs only in release mode, allowing you to configure other options.

Configuration Object

You can initialize ByteHide Logs with

Log.Initialize(new LogSettings
{
    Persist = true,
    FilePath = "logs/app-logs.txt",
    RollingInterval = RollingInterval.Day,
    FileSizeLimitBytes = 10 * 1024 * 1024,
    ConsoleEnabled = true,
    MinimumLevel = LogLevel.Info,
    MaskSensitiveData = new[] { "password", "token" },
    DuplicateSuppressionWindow = TimeSpan.FromSeconds(5),
    MaxFileSize = 5 * 1024 * 1024
});

Choose from different presets, each offering specific protection configurations crafted by cybersecurity experts.

Persist: Guarantees that all logs are securely stored, providing an enduring record of application activity for complete traceability and compliance.
FilePath: Specifies the precise location for log storage, ensuring easy access and organized management of log files within your system.
RollingInterval: Automates log file rotation at set intervals—such as daily or hourly—to maintain optimal file sizes and streamline log analysis.
FileSizeLimitBytes: Enforces a maximum size for individual log files, automatically creating new files to prevent oversized logs and maintain performance.
ConsoleEnabled: Activates immediate logging to the console, offering real-time feedback during development and enhancing debugging efficiency.
MinimumLevel: Sets the threshold for log message severity, capturing only the most relevant information by filtering out less critical entries.
MaskSensitiveData: Protects confidential information by masking specified sensitive data within logs, upholding security standards and preventing data leaks.
DuplicateSuppressionWindow: Reduces log clutter by suppressing duplicate messages within a defined time window, highlighting unique events and simplifying log review.
MaxFileSize: Limits the overall storage consumed by log files, ensuring that logging remains resource-efficient and does not impede system performance.

Settings details

Setting	Type	Required	Description
Persist	bool	false	Indicates whether logs should be saved to a file. If false, they are only shown in the console.
Filepath	string	false	Path to the file where logs will be saved.
RollingInterval	RollingInterval	false	Defines how often a new log file is created (daily, per minute, etc.).
FileSizeLimitBytes	integer	false	Maximum allowed file size before rolling (10 MB in this case).
ConsoleEnabled	bool	false	Enables log output to the console in addition to the file.
MinimumLevel	LogLevel	false	Minimum severity level for logs to be recorded (e.g., Info, Debug, Error).
MaskSensitiveData	object	false	List of keywords to mask sensitive data in the logs.
DuplicateSuppressionWindow	TimeSpan	false	Time window to suppress duplicate log entries.
MaxFileSize	integer	false	Maximum file size if splitting logs by size (5 MB in this case).