CentralW3CLogFile Class1

Article
05/20/2022

Configures settings for World Wide Web Consortium (W3C) centralized logging on a server.

Syntax

class CentralW3CLogFile : EmbeddedObject

Methods

This class contains no methods.

Properties

The following table lists the properties exposed by the CentralW3CLogFile class.

Name	Description
`Directory`	A nonempty read/write `string` value that specifies the directory to which log entries should be written. The default is "%SystemDrive%\inetpub\logs\LogFiles".
`Enabled`	A read/write `boolean` value. `true` if W3C centralized logging is enabled; otherwise, `false`. The default is `true`.
`LocalTimeRollover`	A read/write `boolean` value. `true` if a new log file is based on local time; `false` if it is based on Coordinated Universal Time (UTC). The default is `false`.
`LogExtFileFlags`	A read/write `sint32` value that contains a mask that specifies the attributes to be recorded in the log file. The possible values are listed later in the Remarks section.
`Period`	A read/write `sint32` enumeration that specifies how frequently the current log file is closed and a new log file is started. The possible values are listed later in the Remarks section.
`TruncateSize`	A read/write `string` value that specifies, in bytes, the size at which the log file contents should be truncated. This attribute must be configured when `Period` is set to `MaxSize`. The size must be between 1048576 (1 megabyte) and 4294967295 (4 gigabytes). The default is 20971520 (20 megabytes).

Subclasses

This class contains no subclasses.

Remarks

Instances of this class are contained in the CentralW3CLogFile property of the LogSection class.

The following table lists the possible values for the LogExtFileFlags property. The default attributes are ClientIP, Date, HttpStatus, HttpSubStatus, Method, ServerIP, ServerPort, SiteName, Time, UriQuery, UriStem, UserAgent, UserName, and Win32Status.

Value	Attribute
1	`Date`
2	`Time`
4	`ClientIP`
8	`UserName`
16	`SiteName`
32	`ComputerName`
64	`ServerIP`
128	`Method`
256	`UriStem`
512	`UriQuery`
1024	`HttpStatus`
2048	`Win32Status`
4096	`BytesSent`
8192	`BytesRecv`
16384	`TimeTaken`
32768	`ServerPort`
65536	`UserAgent`
131072	`Cookie`
262144	`Referer`
524288	`ProtocolVersion`
1048576	`Host`
2097152	`HttpSubStatus`

The following table lists the possible values for the Period property. The default is 1 (Daily).

Value	Keyword	Description
0	`MaxSize`	The log file is closed and a new log file is started when the value in `TruncateSize` is reached.
1	`Daily`	The log file is closed and a new log file is started once per day.
2	`Weekly`	The log file is closed and a new log file is started once per week.
3	`Monthly`	The log file is closed and a new log file is started once per month.
4	`Hourly`	The log file is closed and a new log file is started once per hour.

Example

The following code example sets the log file mode to CentralW3C, enables centralW3C logging, sets the Period property to MaxSize, specifies that log files use local time, and limits the log size to 100 megabytes. Helper functions display the settings before and after the changes are made.

' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin = GetObject("winmgmts:root\WebAdministration")  
  
' Get the log configuration section.  
Set oSection = oWebAdmin.Get("LogSection.Path=" & _  
   "'MACHINE/WEBROOT/APPHOST',Location=''")  
  
' Show the initial settings.  
DisplaySettings("Initial Values")  
  
' Set the log file mode to CentralW3C.  
oSection.CentralLogFileMode = 2  
  
' Enable central W3C logging.  
oSection.CentralW3CLogFile.Enabled = True  
  
' Set local time rollover to true.  
oSection.CentralW3CLogFile.LocalTimeRollover = True  
  
' Set the Period property to MaxSize.  
oSection.CentralW3CLogFile.Period = 0  
  
' Set the log truncate size to 100 megabytes.  
oSection.CentralW3CLogFile.TruncateSize = 104857600  
  
' Save the values to configuration.  
oSection.Put_  
  
' Refresh the oSection object variable with the new values.  
oSection.Refresh_  
  
' Show the changed settings.  
Call DisplaySettings("New Values")  
  
' ==== This section contains helper functions. ====  
Function DisplaySettings(HeadingText)  
   WScript.Echo String(Len(HeadingText), "=")  
   WScript.Echo HeadingText  
   WScript.Echo String(Len(HeadingText), "=")  
  
   ' Display the current central log file mode.  
   WScript.Echo "CentralLogFileMode: " & _  
      oSection.CentralLogFileMode  
  
   ' Display the current W3C log file properties.  
   Call ShowPropVals(oSection.CentralW3CLogFile)  
  
End Function  
  
' Display the property values.  
Function ShowPropVals(oObject)  
  
   For Each Prop In oObject.Properties_  
      WScript.Echo Prop.Name & ": " & Prop.Value  
   Next  
  
   WScript.Echo  
  
End Function

Inheritance Hierarchy

EmbeddedObject

CentralW3CLogFile

Requirements

Type	Description
Client	- IIS 7.0 on Windows Vista - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10
Server	- IIS 7.0 on Windows Server 2008 - IIS 7.5 on Windows Server 2008 R2 - IIS 8.0 on Windows Server 2012 - IIS 8.5 on Windows Server 2012 R2 - IIS 10.0 on Windows Server 2016
Product	- IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
MOF file	WebAdministration.mof

Share via