blob: ad3538f9fe8edb0658c7c3697dd5203140be36e6 [file] [log] [blame] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Log </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class Log ">
<meta name="description" content="Provides context aware logging functionality for the Selenium WebDriver.">
<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="docfx:docurl" content="https://github.com/SeleniumHQ/selenium/new/trunk/apiSpec/new?filename=OpenQA_Selenium_Internal_Logging_Log.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.Internal.Logging.Log%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.svg" alt="Selenium .NET API">
Selenium .NET API
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="OpenQA.Selenium.Internal.Logging.Log">
<h1 id="OpenQA_Selenium_Internal_Logging_Log" data-uid="OpenQA.Selenium.Internal.Logging.Log" class="text-break">
Class Log <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Internal/Logging/Log.cs/#L43"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="OpenQA.html">OpenQA</a>.<a class="xref" href="OpenQA.Selenium.html">Selenium</a>.<a class="xref" href="OpenQA.Selenium.Internal.html">Internal</a>.<a class="xref" href="OpenQA.Selenium.Internal.Logging.html">Logging</a></dd></dl>
<dl><dt>Assembly</dt><dd>WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Provides context aware logging functionality for the Selenium WebDriver.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class Log</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">Log</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
</dd></dl>
<h2 id="OpenQA_Selenium_Internal_Logging_Log_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>Use the following code to enable logging to console:</p>
<pre><code class="lang-csharp">Log.SetMinimumLevel(LogEventLevel.Debug)).WithHandler(new ConsoleLogHandler());</code></pre>
<p>Or enable it per limited execution scope:</p>
<pre><code class="lang-csharp">using (var ctx = Log.CreateContext(LogEventLevel.Trace))
{
// do something
}</code></pre>
</div>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_Internal_Logging_Log_Handlers_" data-uid="OpenQA.Selenium.Internal.Logging.Log.Handlers*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_Log_Handlers" data-uid="OpenQA.Selenium.Internal.Logging.Log.Handlers">
Handlers
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Internal/Logging/Log.cs/#L120"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets a list of log handlers for the current log context.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ILogHandlerList Handlers { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Internal.Logging.ILogHandlerList.html">ILogHandlerList</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_Internal_Logging_Log_CreateContext_" data-uid="OpenQA.Selenium.Internal.Logging.Log.CreateContext*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_Log_CreateContext" data-uid="OpenQA.Selenium.Internal.Logging.Log.CreateContext">
CreateContext()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Internal/Logging/Log.cs/#L51"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a new log context with the current context properties and the specified minimum log event level.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ILogContext CreateContext()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Internal.Logging.ILogContext.html">ILogContext</a></dt>
<dd><p>The created log context.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Internal_Logging_Log_CreateContext_" data-uid="OpenQA.Selenium.Internal.Logging.Log.CreateContext*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_Log_CreateContext_OpenQA_Selenium_Internal_Logging_LogEventLevel_" data-uid="OpenQA.Selenium.Internal.Logging.Log.CreateContext(OpenQA.Selenium.Internal.Logging.LogEventLevel)">
CreateContext(LogEventLevel)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Internal/Logging/Log.cs/#L61"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a new log context with with the current context properties and the specified minimum log event level.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ILogContext CreateContext(LogEventLevel minimumLevel)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>minimumLevel</code> <a class="xref" href="OpenQA.Selenium.Internal.Logging.LogEventLevel.html">LogEventLevel</a></dt>
<dd><p>The minimum log event level.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Internal.Logging.ILogContext.html">ILogContext</a></dt>
<dd><p>The created log context.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Internal_Logging_Log_SetLevel_" data-uid="OpenQA.Selenium.Internal.Logging.Log.SetLevel*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_Log_SetLevel_OpenQA_Selenium_Internal_Logging_LogEventLevel_" data-uid="OpenQA.Selenium.Internal.Logging.Log.SetLevel(OpenQA.Selenium.Internal.Logging.LogEventLevel)">
SetLevel(LogEventLevel)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Internal/Logging/Log.cs/#L101"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Sets the minimum log event level for the current log context.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ILogContext SetLevel(LogEventLevel level)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>level</code> <a class="xref" href="OpenQA.Selenium.Internal.Logging.LogEventLevel.html">LogEventLevel</a></dt>
<dd><p>The minimum log event level.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Internal.Logging.ILogContext.html">ILogContext</a></dt>
<dd><p>The current log context.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Internal_Logging_Log_SetLevel_" data-uid="OpenQA.Selenium.Internal.Logging.Log.SetLevel*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_Log_SetLevel_System_Type_OpenQA_Selenium_Internal_Logging_LogEventLevel_" data-uid="OpenQA.Selenium.Internal.Logging.Log.SetLevel(System.Type,OpenQA.Selenium.Internal.Logging.LogEventLevel)">
SetLevel(Type, LogEventLevel)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Internal/Logging/Log.cs/#L112"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Sets the minimum log event level for the specified issuer in the current log context.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ILogContext SetLevel(Type issuer, LogEventLevel level)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>issuer</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
<dd><p>The issuer type.</p>
</dd>
<dt><code>level</code> <a class="xref" href="OpenQA.Selenium.Internal.Logging.LogEventLevel.html">LogEventLevel</a></dt>
<dd><p>The minimum log event level.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Internal.Logging.ILogContext.html">ILogContext</a></dt>
<dd><p>The current log context.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Internal/Logging/Log.cs/#L43" class="edit-link">Edit this page</a>
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>