View This Log
/management/weblogic/{version}/domainConfig/servers/{name}/log
View this log.
Request
-
name: string
The name property of the instance in the collection.
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basicDescription:A user in the Admin security role. -
Deployer: basic
Type:
basicDescription:A user in the Deployer security role. -
Monitor: basic
Type:
basicDescription:A user in the Monitor security role. -
Operator: basic
Type:
basicDescription:A user in the Operator security role.
Response
- application/json
200 Response
Returns this log.
This method can return the following links:
- rel=domainLogBroadcastFilter
This resource's domainLogBroadcastFilter reference to a log filter resource.
- rel=logFileFilter
This resource's logFileFilter reference to a log filter resource.
- rel=stdoutFilter
This resource's stdoutFilter reference to a log filter resource.
object-
bufferSizeKB(optional):
integer(int32)
Default Value:
8Gets the underlying log buffer size in kilobytes
-
dateFormatPattern(optional):
string
The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the
java.text.SimpleDateFormatclass.Constraints
- legal null
-
domainLogBroadcasterBufferSize(optional):
integer(int32)
Minimum Value:
1Maximum Value:100Default Value:1Broadcasts log messages to the domain log in batch mode.
The size of the buffer for log messages that are sent to the domain log. The buffer is maintained on the Managed Server and is broadcasted to the domain log when it is full.
If you notice performance issues due to a high rate of log messages being generated, set this value higher. This will cause the buffer to be broadcasted less frequently from the Managed Server to the domain log. In production environments, it is not recommended to set the buffer size lower than the production default of 10.
Constraints
- production mode default : 10
-
domainLogBroadcastFilter(optional):
array Log Filter Reference
Title:
Log Filter ReferenceContains the log filter reference.The filter configuration for log events being sent to the domain log.
-
domainLogBroadcastSeverity(optional):
string
Default Value:
NoticeAllowed Values:[ "Debug", "Info", "Warning", "Error", "Notice", "Critical", "Alert", "Emergency", "Off" ]The minimum severity of log messages going to the domain log from this server's log broadcaster. Messages with a lower severity than the specified value will not be published to the domain log.
-
dynamicallyCreated(optional):
boolean
Read Only:
trueDefault Value:falseReturn whether the MBean was created dynamically or is persisted to config.xml
-
fileCount(optional):
integer(int32)
Minimum Value:
1Maximum Value:99999Default Value:7The 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.)
Constraints
- production mode default : 100
-
fileMinSize(optional):
integer(int32)
Minimum Value:
1Maximum Value:2097150Default Value:500The 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.lognnnnnand create a new one to store subsequent messages. (Requires that you specify a file rotation type ofSize.)Constraints
- production mode default : 5000
-
fileName(optional):
string
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.logHowever, 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.SimpleDateFormatvariables 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 namedmyserver_yyyy_mm_dd_hh_mm.logWhen 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.log00001If you do not include a time and date stamp, the rotated log files are numbered in order of creation. For example,
myserver.log00007 -
fileTimeSpan(optional):
integer(int32)
Minimum Value:
1Default Value:24The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of
TIME.) -
id(optional):
integer(int64)
Read Only:
trueReturn the unique id of this MBean instance
-
logFileFilter(optional):
array Log Filter Reference
Title:
Log Filter ReferenceContains the log filter reference.The filter configuration for the server log file.
A filter configuration defines simple filtering rules to limit the volume of log messages written to the log file.
-
logFileRotationDir(optional):
string
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.
-
logFileSeverity(optional):
string
Default Value:
TraceAllowed Values:[ "Trace", "Debug", "Info", "Notice", "Warning" ]The minimum severity of log messages going to the server log file. By default all messages go to the log file.
-
loggerSeverity(optional):
string
Default Value:
InfoAllowed Values:[ "Trace", "Debug", "Info", "Notice", "Warning" ]The minimum severity of log messages going to all log destinations.
-
loggerSeverityProperties(optional):
object Properties
Title:
PropertiesAdditional Properties Allowed: additionalPropertiesThe configuration of the different logger severities keyed by name. The values are one of the predefined Severity strings namely Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug, Trace.
-
logMonitoringEnabled(optional):
boolean
Default Value:
trueEnable or disable log monitoring.
-
logMonitoringIntervalSecs(optional):
integer(int32)
Minimum Value:
5Default Value:30Timer interval in seconds to check the counts of messages logged during the interval.
-
logMonitoringMaxThrottleMessageSignatureCount(optional):
integer(int32)
Minimum Value:
100Maximum Value:5000Default Value:1000Maximum number of unique message signatures that will be monitored during the throttle interval.
-
logMonitoringThrottleMessageLength(optional):
integer(int32)
Minimum Value:
10Maximum Value:500Default Value:50Cut-off length of the log message for evaluation during throttle period. The log message length is truncated to this length for evaluation of repeated logging events.
-
logMonitoringThrottleThreshold(optional):
integer(int32)
Minimum Value:
5Default Value:1500The threshold number of messages logged during the evaluation period which enables or disables the throttling.
Once throttling is enabled messages with the same repeating message signatures are throttled. Every nth repeated message specified by this attribute is logged in a monitoring cycle.
-
name(optional):
string
Read Only:
trueThe user-specified name of this MBean instance.
This name is included as one of the key properties in the MBean's
javax.management.ObjectNameName=user-specified-nameConstraints
- legal null
-
notes(optional):
string
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<. 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.
-
numberOfFilesLimited(optional):
boolean
Default Value:
trueIndicates 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
SIZEorTIME.)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.
Constraints
- production mode default : true
-
platformLoggerLevels(optional):
object Properties
Title:
PropertiesAdditional Properties Allowed: additionalPropertiesSpecifies the platform logger and the associated level names set through the WebLogic Server configuration.
Note the following behavior:
The configuration is applicable for
java.util.logging.Loggerinstances in the JDK's default global LogManager.WebLogic Server loggers are configured in terms of
weblogic.logging.Severitiesthrough theLoggerSeveritiesattribute. These loggers are not available in the JDK's default global LogManager.If your WebLogic domain includes Oracle JRF and is configured to use Oracle Diagnostic Logging (ODL), the
java.util.logginglevels set on theLogMBean.PlatformLoggerLevelsattribute are ignored. For information about how to configure ODL logging for JDK platform loggers, see Managing Log Files and Diagnostics Data in Administering Oracle Fusion Middleware
-
redirectStderrToServerLogEnabled(optional):
boolean
Specifies whether the stderr of the JVM in which a WebLogic Server instance runs is redirected to the WebLogic Logging system. When this attribute is enabled, the stderr content is published to all the registered log destinations, such as the server terminal console and log file.
Note that JVM messages are redirected asynchronously. In the event of an overload situation, these messages may be dropped. As a best practice, Oracle recommends using one of the supported logging APIs instead.
-
redirectStdoutToServerLogEnabled(optional):
boolean
Specifies whether the stdout of the JVM in which a WebLogic Server instance runs is redirected to the WebLogic logging system. When this attribute is enabled, the stdout content is published to all the registered log destinations, such as the server terminal console and log file.
Note that JVM messages are redirected asynchronously. In the event of an overload situation, these messages may be dropped. As a best practice, Oracle recommends using one of the supported logging APIs instead.
-
rotateLogOnStartup(optional):
boolean
Default Value:
trueSpecifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.
Constraints
- production mode default : false
-
rotationTime(optional):
string
Default Value:
00:00Determines 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, whereis Hour in day (0-23)mmis the minute in hour
-
rotationType(optional):
string
Default Value:
bySizeAllowed Values:[ "bySize", "byTime", "none", "bySizeOrTime" ]Criteria for moving old log messages to a separate file.
NONEMessages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.SIZEWhen the log file reaches the size that you specify inFileMinSize, the server renames the file asSERVER_NAME.lognnnnnTIMEAt each time interval that you specify inTimeSpan, the server renames the file asSERVER_NAME.lognnnnn
After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.
-
stdoutFilter(optional):
array Log Filter Reference
Title:
Log Filter ReferenceContains the log filter reference.The filter configuration for log events being sent to the standard out.
-
stdoutFormat(optional):
string
Default Value:
standardAllowed Values:[ "standard", "noid" ]The output format to use when logging to the console.
-
stdoutLogStack(optional):
boolean
Default Value:
trueSpecifies whether to dump stack traces to the console when included in logged message.
-
stdoutSeverity(optional):
string
Default Value:
NoticeAllowed Values:[ "Trace", "Debug", "Info", "Warning", "Error", "Notice", "Critical", "Alert", "Emergency", "Off" ]The minimum severity of log messages going to the standard out. Messages with a lower severity than the specified value will not be published to standard out.
-
tags(optional):
array Items
Title:
ItemsReturn all tags on this Configuration MBean
-
type(optional):
string
Read Only:
trueReturns the type of the MBean.
Constraints
- unharvestable
arrayLog Filter ReferenceThe filter configuration for log events being sent to the domain log.
arrayLog Filter ReferenceThe filter configuration for the server log file.
A filter configuration defines simple filtering rules to limit the volume of log messages written to the log file.
objectPropertiesThe configuration of the different logger severities keyed by name. The values are one of the predefined Severity strings namely Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug, Trace.
objectPropertiesSpecifies the platform logger and the associated level names set through the WebLogic Server configuration.
Note the following behavior:
The configuration is applicable for
java.util.logging.Loggerinstances in the JDK's default global LogManager.WebLogic Server loggers are configured in terms of
weblogic.logging.Severitiesthrough theLoggerSeveritiesattribute. These loggers are not available in the JDK's default global LogManager.If your WebLogic domain includes Oracle JRF and is configured to use Oracle Diagnostic Logging (ODL), the
java.util.logginglevels set on theLogMBean.PlatformLoggerLevelsattribute are ignored. For information about how to configure ODL logging for JDK platform loggers, see Managing Log Files and Diagnostics Data in Administering Oracle Fusion Middleware
arrayLog Filter ReferenceThe filter configuration for log events being sent to the standard out.