IServerLogQuery Interface

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

Members

Name Description
Read/write property EndTime The end time in the ArcGIS Server logs at which to end the query.
Read/write property Level The log level at which to query (1-5).
Read/write property Machine The machine name for which to query.
Read/write property MaxRecords The maximum number of records to retrieve with the query.
Read/write property StartIndex The starting index at which to start retrieving records from the query.
Read/write property StartTime The start time in the ArcGIS Server logs at which to begin the query.
Read/write property Target The log target name.

IServerLogQuery.EndTime Property

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

Public Property EndTime As DateTime
public DateTime EndTime {get; set;}

IServerLogQuery.Level Property

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

Public Property Level As Integer
public int Level {get; set;}

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.

IServerLogQuery.Machine Property

The machine name for which to query.

Public Property Machine As String
public string Machine {get; set;}

Remarks

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

IServerLogQuery.MaxRecords Property

The maximum number of records to retrieve with the query.

Public Property MaxRecords As Integer
public int MaxRecords {get; set;}

IServerLogQuery.StartIndex Property

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

Public Property StartIndex As Integer
public int StartIndex {get; set;}

IServerLogQuery.StartTime Property

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

Public Property StartTime As DateTime
public DateTime StartTime {get; set;}

IServerLogQuery.Target Property

The log target name.

Public Property Target As String
public string Target {get; set;}

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.

Classes that implement IServerLogQuery

Classes Description

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).

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.