logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityStructuredLogInstallationStep

    Installs the structured log sinks, one instance per configured settings asset.

    Inheritance
    object
    UnityStructuredLogInstallationStep
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.StructuredLogging.Installation.Installers
    Assembly: Serenity.UnityStructuredLogging.Installation.dll
    Syntax
    public class UnityStructuredLogInstallationStep
    Remarks

    Unlike the console and file sinks this one is optional: with an empty settings list a single zero-config pass runs with null settings so the installer's Addressables-label fallback keeps working, and a failed install — most commonly "no settings found" — is reported as a warning instead of aborting boot. Routes that select a structured logger key simply fall back to the console logger until an instance exists.

    Strict multi-instance identity rules (see StructuredLogSinkResolver): with more than one configured instance, an instance with an empty Id is skipped with a warning, and a duplicate non-empty Id keeps the first instance and skips the rest with a warning. Installed instances are addressable via the structured:{Id} logger key; the bare structured key only resolves while exactly one instance is installed.

    WebGL exemption: mirrors the file sink's WebGL guard, applied per instance. Every structured backend except Http reads or writes the local file system or PlayerPrefs synchronously, which risks the same IDBFS stall. Http instances are exempt because they talk to a remote service over the network.

    Constructors

    UnityStructuredLogInstallationStep()

    Declaration
    public UnityStructuredLogInstallationStep()

    Methods

    Install(IUnityInstallationContext, UnityStructuredLogInstallationStepInput)

    Installs every configured sink instance, filling the caller's installer list and id map.

    Declaration
    public void Install(IUnityInstallationContext installationContext, UnityStructuredLogInstallationStepInput input)
    Parameters
    Type Name Description
    IUnityInstallationContext installationContext

    The composition root this step installs into.

    UnityStructuredLogInstallationStepInput input

    The configured settings, plus the collections installed instances are recorded in.

    In this article
    © 2026 Serenity. All Rights Reserved