LogFileMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Configures the location, file-rotation criteria, and number of files that a WebLogic Server uses to store log messages. The methods in this class configure both server and domain log files.

       
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.LogFileMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Subtypes The following MBeans extend or implement this MBean type:


Attributes

This section describes the following attributes:


BufferSizeKB

Gets the underlying log buffer size in kilobytes

       
Privileges Read/Write
Typeint
Default Value8

CachingDisabled

Private property that disables caching in proxies.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

DateFormatPattern

The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.

       
Privileges Read/Write
Typejava.lang.String

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

FileCount

The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)

For more information, see:

       
Privileges Read/Write
Typeint
Default Value7
Minimum value1
Maximum value99999

FileMinSize

The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as SERVER_NAME.lognnnnn and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)

For more information, see:

       
Privileges Read/Write
Typeint
Default Value500
Minimum value1
Maximum value2097150

FileName

The name of the file that stores current log messages. Usually it is a computed value based on the name of the parent of this MBean. For example, for a server log, it is SERVER_NAME.log.

However, if the name of the parent cannot be obtained, the file name is weblogic.log. If you specify a relative pathname, it is interpreted as relative to the server's root directory.

To include a time and date stamp in the file name when the log file is rotated, add java.text.SimpleDateFormat variables to the file name. Surround each variable with percentage (%) characters.

For example, if the file name is defined to be myserver_%yyyy%_%MM%_%dd%_%hh%_%mm%.log, the log file will be named myserver_yyyy_mm_dd_hh_mm.log.

When the log file is rotated, the rotated file name contains the date stamp. For example, if the log file is rotated for the first time on 2 April, 2003 at 10:05 AM, the log file that contains the old messages will be named myserver_2003_04_02_10_05.log00001.

If you do not include a time and date stamp, the rotated log files are numbered in order of creation. For example, myserver.log00007.

       
Privileges Read/Write
Typejava.lang.String

FileTimeSpan

The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)

For more information, see:

       
Privileges Read/Write
Typeint
Default Value24
Minimum value1

Id

Return the unique id of this MBean instance

       
Privileges Read only
Typelong
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

LogFileRotationDir

The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.

       
Privileges Read/Write
Typejava.lang.String

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

       
Privileges Read only
Typejavax.management.MBeanInfo
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

       
Privileges Read/Write
Typejava.lang.String

Notes

Optional information that you can include to describe this configuration.

WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

           
Privileges Read/Write
Security rolesWrite access is granted only to the following roles:
  • Deployer
  • Operator
Typejava.lang.String

NumberOfFilesLimited

Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)

After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.

If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.

For more information, see:

       
Privileges Read/Write
Typeboolean
Default Valuetrue

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

       
Privileges Read only
Typeweblogic.management.WebLogicObjectName
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Parent

Return the immediate parent for this MBean

       
Privileges Read/Write
Type

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

RotateLogOnStartup

Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

RotationTime

Determines the start time (hour and minute) for a time-based rotation sequence.

At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.

Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.

Use the following format: H:mm, where

For more information, see:

       
Privileges Read/Write
Typejava.lang.String
Default Value00:00

RotationType

Criteria for moving old log messages to a separate file.

After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.

       
Privileges Read/Write
Typejava.lang.String
Default ValuebySize
Legal Values
  • bySize
  • byTime
  • none

Tags

Return all tags on this Configuration MBean

       
Available Since Release 12.2.1.0.0
Privileges Read/Write
Typeclass java.lang.String[]

Type

Returns the type of the MBean.

       
Privileges Read only
Typejava.lang.String
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


Operations

This section describes the following operations:


addTag

Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

   
Operation Name"addTag"
ParametersObject [] {  tag }

where:

  • tag is an object of type java.lang.String that specifies:

    tag to be added to the MBean

SignatureString [] { "java.lang.String" }
Returns boolean
Exceptions
  • java.lang.IllegalArgumentException
    IllegalArgumentException if the tag contains illegal punctuation

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note: To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

   
Operation Name"freezeCurrentValue"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException
  • javax.management.MBeanException

getInheritedProperties

Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

   
Operation Name"getInheritedProperties"
ParametersObject [] {  propertyNames }

where:

  • propertyNames is an object of type [Ljava.lang.String; that specifies:

    properties to check

SignatureString [] { "[Ljava.lang.String;" }
Returns class

isInherited

Check if the value of a property is inherited from template mbean or not.

   
Operation Name"isInherited"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    the name of the property

SignatureString [] { "java.lang.String" }
Returns boolean

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

   
Operation Name"isSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to check

SignatureString [] { "java.lang.String" }
Returns boolean

removeTag

Remove a tag from this Configuration MBean

   
Operation Name"removeTag"
ParametersObject [] {  tag }

where:

  • tag is an object of type java.lang.String that specifies:

    tag to be removed from the MBean

SignatureString [] { "java.lang.String" }
Returns boolean
Exceptions
  • java.lang.IllegalArgumentException
    IllegalArgumentException if the tag contains illegal punctuation

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

   
Operation Name"restoreDefaultValue"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException

unSet

Restore the given property to its default value.

   
Operation Name"unSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to restore

SignatureString [] { "java.lang.String" }
Returns void