IIS Custom Logging Module Interfaces

This section describes the interfaces that are used to create custom logging modules if none of the existing IIS log file formats meets your needs. Creating your own custom logging module should be your last resort. For alternatives, see IIS Logging Overview.

All interface, function, and data structure definitions are provided in the header file ilogobj.hxx. The header file must be included in any custom logging module project, or any projects that access an IIS logging module.

In This Section

The logging architecture implemented by IIS is built around the following set of COM interfaces.

ILogPlugin Interface

This interface or the ILogPluginEx interface must be implemented by your logging module. These interfaces expose a set of methods to initialize the logging module, to notify the module when a logging event occurs, and to notify the module when the module is about to be unloaded.

ILogPluginEx Interface

This interface or the ILogPlugin interface must be implemented by your logging module. These interfaces expose a set of methods to initialize the logging module, to notify the module when a logging event occurs, and to notify the module when the module is about to be unloaded.

ILogUIPlugin Interface

This interface and the ILogUIPlugin2 interface are considered optional, and are only required if you wish to enhance your custom logging module by providing a user interface module. These interfaces configure the logging user interface module that you have created or selected for use with your custom logging module.

Note

This interface is for use on IIS 5.1 and earlier.

ILogUIPlugin2 Interface

This interface and the ILogUIPlugin interface are considered optional, and are only required if you wish to enhance your custom logging module by providing a user interface module. These interfaces configure the logging user interface module that you have created or selected for use with your custom logging module.

Note

This interface is for use on IIS 6.0 and later.

IInetLogInformation Interface

IIS exposes one interface, a pointer to which is passed in the ILogPlugin::LogInformation method when IIS notifies the custom logging module of a loggable event. This interface can be used by your custom logging module to retrieve specific types of information about the current logging event.

CUSTOM_LOG_DATA Structure

The PCUSTOM_LOG_DATA structure is used by ILogPluginEx::LogCustomInformation to hold information about the custom log fields to be logged by your custom logging module.

Requirements

Client: Requires Windows XP Professional, Windows 2000 Professional, or Windows NT Workstation 4.0.

Server: Requires Windows Server 2003, Windows 2000 Server, or Windows NT Server 4.0.

Product: IIS

Header: Declared in ilogobj.hxx.

See Also