Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update of the documentation related to latest changes in logging #24072

Merged
merged 1 commit into from
Aug 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -781,8 +781,8 @@ public class HelloWorld extends HttpServlet {
pw.println("SimpleService says " + greeter.saySomething());
pw.println("<br>");
}
} catch(Exception e) {
e.printStackTrace();
} catch(Exception e) {
e.printStackTrace();
}
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
type=page
status=published
title=Subcommands for the asadmin Utility
prev=part-appendixes.html
next=loe.adoc
prev=part-appendixes.adoc
~~~~~~

= Subcommands for the asadmin Utility
Expand Down Expand Up @@ -667,7 +666,7 @@ link:reference-manual/delete-lifecycle-module.html#GSRFM00095[`delete-lifecycle-
link:reference-manual/collect-log-files.html#GSRFM00007[`collect-log-files`]::
Collects all available log files and creates a ZIP archive. Supported
in remote mode only. For procedural information in this guide, see
link:logging.html#gklbi[To Collect Log Files into a ZIP Archive].
xref:logging.adoc#to-collect-log-files-into-a-zip-archive[To Collect Log Files into a ZIP Archive].
link:reference-manual/disable-monitoring.html#GSRFM00120[`disable-monitoring`]::
Disables the monitoring service. Supported in remote mode only. For
procedural information in this guide, see link:monitoring.html#gglcu[To
Expand All @@ -679,15 +678,14 @@ link:reference-manual/enable-monitoring.html#GSRFM00128[`enable-monitoring`]::
link:reference-manual/list-log-attributes.html#GSRFM00182[`list-log-attributes`]::
Lists log file attributes. Supported in remote mode only. For
procedural information in this guide, see
link:logging.html#gklmn[Configuring the Logging Service].
xref:logging.adoc#configuring[Configuring the Logging Service].
link:reference-manual/list-log-levels.html#GSRFM00183[`list-log-levels`]::
Lists the existing loggers. Supported in remote mode only. For
procedural information in this guide, see link:logging.html#gjirr[To
List Log Levels].
Lists the existing loggers. Supported in remote mode only.
For procedural information in this guide,
see xref:logging.adoc#to-list-log-levels[To List Log Levels].
link:reference-manual/list-loggers.html#GSRFM869[`list-loggers`]::
Lists all public loggers in your distribution of {productName}. Internal loggers are not listed. For procedural
information in this guide, see link:logging.html#CEGGICGF[To List
Loggers].
information in this guide, see xref:logging.adoc#to-list-loggers[To List Loggers].
link:reference-manual/monitor.html#GSRFM00212[`monitor`]::
Displays monitoring information for the common {productName}
resources. Supported in remote mode only. For procedural information
Expand All @@ -696,20 +694,19 @@ link:reference-manual/monitor.html#GSRFM00212[`monitor`]::
link:reference-manual/rotate-log.html#GSRFM00224[`rotate-log`]::
Rotates the `server.log` file and stores the old data in a
time-stamped file. Supported in remote mode only. For procedural
information in this guide, see link:logging.html#gkmau[To Rotate Log
Files Manually].
information in this guide, see xref:logging.adoc#to-rotate-log-files-manually[To Rotate Log Files Manually].
link:reference-manual/set-log-attributes.html#GSRFM00227[`set-log-attributes`]::
Sets log file attributes. Supported in remote mode only. For
procedural information in this guide, see
link:logging.html#gklmn[Configuring the Logging Service].
xref:logging.adoc#configuring[Configuring the Logging Service].
link:reference-manual/set-log-file-format.html#GSRFM879[`set-log-file-format`]::
Sets the formatter used to format log records in log files. For
procedural information in this guide, see
link:logging.html#CEGDJEBG[Setting the Log File Format].
xref:logging.adoc#setting-the-log-file-format[Setting the Log File Format].
link:reference-manual/set-log-levels.html#GSRFM00228[`set-log-levels`]::
Sets the log level for a module. Supported in remote mode only. For
procedural information in this guide, see
link:logging.html#gklml[Setting Log Levels].
xref:logging.adoc#gklml[Setting Log Levels].

[[giusq]][[GSADG00620]][[orb-subcommands]]

Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/batch.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering Batch Jobs
next=part-res-and-svcs-admin.html
prev=lifecycle-modules.html
next=part-res-and-svcs-admin.adoc
prev=lifecycle-modules.adoc
~~~~~~

= Administering Batch Jobs
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/concurrent.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering Concurrent Resources
next=orb.html
prev=http_https.html
next=orb.adoc
prev=http_https.adoc
~~~~~~

= Administering Concurrent Resources
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/connectors.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering EIS Connectivity
next=http_https.html
prev=jdbc.html
next=http_https.adoc
prev=jdbc.adoc
~~~~~~

= Administering EIS Connectivity
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/domains.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering Domains
next=jvm.html
prev=general-administration.html
next=jvm.adoc
prev=general-administration.adoc
~~~~~~

= Administering Domains
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=General Administration
next=domains.html
prev=part-runtime-admin.html
next=domains.adoc
prev=part-runtime-admin.adoc
~~~~~~

= General Administration
Expand Down Expand Up @@ -3003,7 +3001,7 @@ The JSON representation of a log record in a record list is as follows:
"loggedDateTimeInMS":logged-date,
"loggedLevel":"log-level",
"productName":"product-name",
"loggerName":"logger-class-name",
"loggerName":"logger-name",
"nameValuePairs":"_ThreadID=thread-id;_ThreadName=thread-name;",
"messageID":"message-id",
"Message":"message-text"
Expand All @@ -3016,18 +3014,18 @@ record-number::
A serial number in the form of a decimal integer that uniquely
identifies the log record.
logged-date::
The date and time in UNIX time that the record was created.
time when the record was created - a number of milliseconds from the epoch
of `1970-01-01T00:00:00Z`.
log-level::
The severity level of the message in the log record. For more
information, see link:logging.html#gklml[Setting Log Levels].
information, see xref:logging.adoc#setting-log-levels[Setting Log Levels].
product-name::
The application that created the log message, for example, `glassfish7`.
logger-class-name::
The fully qualified name of the Java class of the logger class that
created the log message. Each component of {productName} provides
its own logger class. For detailed information about the names of
logger classes in {productName}, see link:logging.html#gkres[Logger
Namespaces].
The application that created the log message, for example, `GlassFish 7.0`.
logger-name::
The logger name, which is usually a fully qualified name of the Java class
owning the logger class that created the log record. For detailed information
how to get names of logger classes used in {productName},
see xref:logging.adoc#listing-loggers[Listing Loggers].
thread-id::
The numerical identifier of the thread that created the message.
thread-name::
Expand Down Expand Up @@ -3127,16 +3125,16 @@ The XML representation of a log record is as follows:
The replaceable items in this format are as follows:

logged-date::
The date and time in UNIX time that the record was created.
time when the record was created - a number of milliseconds from the epoch
of `1970-01-01T00:00:00Z`.
log-level::
The severity level of the message in the log record. For more
information, see link:logging.html#gklml[Setting Log Levels].
information, see xref:logging.adoc#setting-log-levels[Setting Log Levels].
logger-class-name::
The fully qualified name of the Java class of the logger class that
created the log message. Each component of {productName} provides
its own logger class. For detailed information about the names of
logger classes in {productName}, see link:logging.html#gkres[Logger
Namespaces].
logger classes in {productName}, see xref:logging.adoc#listing-loggers[Listing Loggers].
message-id::
A unique identifier for the message. For messages from {productName}, this identifier consists of a module code and a numerical
value, for example, `CORE5004`. All `SEVERE` and `WARNING` messages
Expand All @@ -3147,8 +3145,7 @@ thread-id::
thread-name::
The name of the thread that created the message.
product-name::
The application that created the log message, for example,
`glassfish7`.
The application that created the log message, for example, `GlassFish 7.0`.
record-number::
A serial number in the form of a decimal integer that uniquely
identifies the log record.
Expand Down Expand Up @@ -3190,17 +3187,14 @@ The {productName} REST interfaces support the following types in the
content-type header of a client request:

* http://www.json.org/[JSON]
* XML
* http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1[Form URL
encoded]
* https://www.w3.org/XML/[XML]
* http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1[Form URL encoded]

How to specify the type in the content-type header depends on how you
are sending the request. For example, if you are using the cURL utility,
specify the type through the `-H` option as follows:

* For JSON, specify `-H "Content-type: application/json"`.
* For XML, specify `-H "Content-type: application/xml"`.
* For form URL encoded, specify
`-H "Content-type: application/x-www-form-urlencoded"`.

* For form URL encoded, specify `-H "Content-type: application/x-www-form-urlencoded"`.

6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/http_https.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering Internet Connectivity
next=concurrent.html
prev=connectors.html
next=concurrent.adoc
prev=connectors.adoc
~~~~~~

= Administering Internet Connectivity
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/javamail.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering the JavaMail Service
next=jms.html
prev=orb.html
next=jms.adoc
prev=orb.adoc
~~~~~~

= Administering the JavaMail Service
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/jdbc.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering Database Connectivity
next=connectors.html
prev=part-res-and-svcs-admin.html
next=connectors.adoc
prev=part-res-and-svcs-admin.adoc
~~~~~~

= Administering Database Connectivity
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/jms.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering the Java Message Service (JMS)
next=jndi.html
prev=javamail.html
next=jndi.adoc
prev=javamail.adoc
~~~~~~

= Administering the Java Message Service (JMS)
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/jndi.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering the Java Naming and Directory Interface (JNDI) Service
next=transactions.html
prev=jms.html
next=transactions.adoc
prev=jms.adoc
~~~~~~

= Administering the Java Naming and Directory Interface (JNDI) Service
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/jvm.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering the Virtual Machine for the Java Platform
next=threadpools.html
prev=domains.html
next=threadpools.adoc
prev=domains.adoc
~~~~~~

= Administering the Virtual Machine for the Java Platform
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=Administering Life Cycle Modules
next=batch.html
prev=monitoring.html
next=batch.adoc
prev=monitoring.adoc
~~~~~~

= Administering Life Cycle Modules
Expand Down
47 changes: 19 additions & 28 deletions docs/administration-guide/src/main/asciidoc/loe.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=List of Examples
next=lof.html
prev=toc.html
next=lof.adoc
prev=toc.adoc
~~~~~~

= List of Examples
Expand Down Expand Up @@ -117,30 +115,23 @@ Domain]
* link:webapps.html#gjjzu[6-6 httpd.conf File for Load Balancing]
* link:webapps.html#gjjzf[6-7 workers.properties File for Load Balancing]
* link:webapps.html#gjpnc[6-8 http-ssl.conf File for mod_jk Security]
* link:logging.html#gkmal[7-1 Changing the Name and Location of a
Cluster's Log File]
* link:logging.html#gkmgz[7-2 Setting the java.util.logging.config.file
System Property]
* link:logging.html#gjiti[7-3 Listing Logger Levels for Modules]
* link:logging.html#gkkot[7-4 Listing Log Levels for an Instance]
* link:logging.html#ghmfi[7-5 Changing the Global Log Level for All
Module Loggers]
* link:logging.html#ghmev[7-6 Setting the Log Level for a Module Logger]
* link:logging.html#gjkat[7-7 Setting Log Levels for Multiple Loggers]
* link:logging.html#sthref23[7-8 Setting the Log File Format using
set-log-file-format]
* link:logging.html#sthref24[7-9 Setting the Log File Format using
set-log-attributes]
* link:logging.html#sthref25[7-10 Excluding Fields in Log Records]
* link:logging.html#sthref26[7-11 Setting Multiline Mode]
* link:logging.html#gkmay[7-12 Changing the Rotation Size]
* link:logging.html#gkmbc[7-13 Changing the Rotation Interval]
* link:logging.html#gkmaq[7-14 Changing the Limit Number of Retained
Files]
* link:logging.html#gkmav[7-15 Rotating Log Files Manually]
* link:logging.html#ghphb[7-16 Adding a New Log Handler]
* link:logging.html#gklap[7-17 Creating a ZIP Archive]
* link:logging.html#sthref27[7-18 Listing Loggers]
* xref:logging.adoc#example-7-1[7-1 Changing the Name and Location of a Cluster's Log File]
* xref:logging.adoc#example-7-2[7-2 Listing Logger Levels for DAS]
* xref:logging.adoc#example-7-3[7-3 Listing Logger Levels for an Instance]
* xref:logging.adoc#example-7-4[7-4 Changing the Logger Log Level for a Cluster]
* xref:logging.adoc#example-7-5[7-5 Setting Log Levels for Multiple Loggers]
* xref:logging.adoc#example-7-6[7-6 Changing the Handler Log Level]
* xref:logging.adoc#example-7-7[7-7 Setting the Log File Format using set-log-file-format]
* xref:logging.adoc#example-7-8[7-8 Setting the Log File Format using set-log-attributes]
* xref:logging.adoc#example-7-9[7-9 Excluding Fields in the ODLLogFormatter]
* xref:logging.adoc#example-7-10[7-10 Excluding Fields in the GlassFishLogHandler]
* xref:logging.adoc#example-7-11[7-11 Disabling the Multiline Mode in the Log File]
* xref:logging.adoc#example-7-12[7-12 Changing the Rotation Size]
* xref:logging.adoc#example-7-13[7-13 Changing the Rotation Interval]
* xref:logging.adoc#example-7-14[7-14 Changing the Limit Number of Archived Log Files]
* xref:logging.adoc#example-7-15[7-15 Rotating Log Files Manually]
* xref:logging.adoc#example-7-16[7-16 Collecting and Downloading Log Files as a ZIP File]
* xref:logging.adoc#example-7-17[7-17 Listing Loggers]
* link:monitoring.html#gixri[8-1 Enabling the Monitoring Service
Dynamically]
* link:monitoring.html#gixre[8-2 Enabling Monitoring for Modules
Expand Down
6 changes: 2 additions & 4 deletions docs/administration-guide/src/main/asciidoc/lof.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
type=page
status=published
title=List of Figures
next=lot.html
prev=loe.html
next=lot.adoc
prev=loe.adoc
~~~~~~

= List of Figures
Expand Down
Loading