View This JMSSAF Message Log File
/management/weblogic/{version}/serverConfig/resourceGroups/{name}/SAFAgents/{name}/JMSSAFMessageLogFile
View this JMSSAF message log file.
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:
basic
Description:A user in the Admin security role.
-
Deployer: basic
Type:
basic
Description:A user in the Deployer security role.
-
Monitor: basic
Type:
basic
Description:A user in the Monitor security role.
-
Operator: basic
Type:
basic
Description:A user in the Operator security role.
Response
- application/json
200 Response
Returns this JMSSAF message log file.
object
-
bufferSizeKB(optional):
integer(int32)
Default Value:
8
Gets 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.SimpleDateFormat
class.Constraints
- legal null
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
fileCount(optional):
integer(int32)
Minimum Value:
1
Maximum Value:99999
Default Value:7
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.)
Constraints
- production mode default : 100
-
fileMinSize(optional):
integer(int32)
Minimum Value:
1
Maximum Value:2097150
Default Value:500
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 ofSize
.)Constraints
- production mode default : 5000
-
fileName(optional):
string
-
fileTimeSpan(optional):
integer(int32)
Minimum Value:
1
Default Value:24
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
.) -
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
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.
-
name(optional):
string
Read Only:
true
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
Constraints
- 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:
true
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
orTIME
.)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
-
rotateLogOnStartup(optional):
boolean
Default Value:
true
Specifies 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:00
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
, whereis Hour in day (0-23)
mm
is the minute in hour
-
rotationType(optional):
string
Default Value:
bySize
Allowed Values:[ "bySize", "byTime", "none", "bySizeOrTime" ]
Criteria for moving old log messages to a separate file.
NONE
Messages 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.SIZE
When the log file reaches the size that you specify inFileMinSize
, the server renames the file asSERVER_NAME.lognnnnn
TIME
At 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.
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable