Interface IServerLogQuery

Namespace
ESRI.ArcGIS.Server
Assembly
ESRI.Server.Server.dll

Provides access to members that configure a query to the ArcGIS Server logs.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("97D02AC6-AABB-4030-85F1-7280F28785DE")]
public interface IServerLogQuery

Remarks

The IServerLogQuery interface is retrieved from the CreateQuery method of the IServerLog interface. After populating its properties, the IServerLogQuery interface is used as an argument to the GetLogRecords method of the IServerLog interface.

 

The StartTime and EndTime properties can be set programmatically (i.e. not hard coded) by getting a time interval from the IServerTimeRange interface via the IServerStatistics interface (see code example).

Properties

EndTime

The end time in the ArcGIS Server logs at which to end the query.

DateTime EndTime { get; set; }

Property Value

DateTime

Level

The log level at which to query (1-5).

int Level { get; set; }

Property Value

int

Remarks

LogLevel: this is a number between 0 and 5 which indicates the level of detail that the server logs. By default, the LogLevel is 3. The following is a description of the each log level:

  • 0 (None): No logging
  • 1 (Error): Serious problems that require immediate attention
  • 2 (Warning): Problems that require attention
  • 3 (Normal): Common administrative messages of the server
  • 4 (Detailed): Very common messages from user use of the server, including server objects
  • 5 (Debug): verbose messages to aid in troubleshooting

Querying for a specific log level will return log entries for that log level and below.

Machine

The machine name for which to query.

string Machine { get; set; }

Property Value

string

Remarks

The Machine property refers to the name of a particular SOC machine in your ArcGIS Server system.

MaxRecords

The maximum number of records to retrieve with the query.

int MaxRecords { get; set; }

Property Value

int

StartIndex

The starting index at which to start retrieving records from the query.

int StartIndex { get; set; }

Property Value

int

StartTime

The start time in the ArcGIS Server logs at which to begin the query.

DateTime StartTime { get; set; }

Property Value

DateTime

Target

The log target name.

string Target { get; set; }

Property Value

string

Remarks

The Target property refers to the name of objects running in the server. For example, "Server", "SDM.ServerDirectoryManager", "SrvLog.ServerLog", and the various server object configurations that have been deployed.