Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in / Register
Toggle navigation
S
spring-boot
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DEMO
spring-boot
Commits
68ed4dec
Commit
68ed4dec
authored
Apr 16, 2015
by
izeye
Committed by
Andy Wilkinson
Apr 21, 2015
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Polish production ready features documentation
Closes gh-2832
parent
b8a45d91
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
15 deletions
+15
-15
production-ready-features.adoc
...oot-docs/src/main/asciidoc/production-ready-features.adoc
+15
-15
No files found.
spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View file @
68ed4dec
...
@@ -70,7 +70,7 @@ The following endpoints are available:
...
@@ -70,7 +70,7 @@ The following endpoints are available:
|
true
|
true
|`
beans
`
|`
beans
`
|
Displays
a
complete
list
of
all
the
Spring
B
eans
in
your
application
.
|
Displays
a
complete
list
of
all
the
Spring
b
eans
in
your
application
.
|
true
|
true
|`
configprops
`
|`
configprops
`
...
@@ -111,7 +111,7 @@ unauthenticated connection or full message details when authenticated).
...
@@ -111,7 +111,7 @@ unauthenticated connection or full message details when authenticated).
|true
|true
|===
|===
NOTE: Depending on how an endpoint is exposed, the `sensitive` p
arameter
may be used as
NOTE: Depending on how an endpoint is exposed, the `sensitive` p
roperty
may be used as
a security hint. For example, sensitive endpoints will require a username/password when
a security hint. For example, sensitive endpoints will require a username/password when
they are accessed over HTTP (or simply disabled if web security is not enabled).
they are accessed over HTTP (or simply disabled if web security is not enabled).
...
@@ -427,7 +427,7 @@ you should carefully consider which endpoints you enable. See
...
@@ -427,7 +427,7 @@ you should carefully consider which endpoints you enable. See
===
Customizing
the
management
server
context
path
===
Customizing
the
management
server
context
path
Sometimes
it
is
useful
to
group
all
management
endpoints
under
a
single
path
.
For
example
,
Sometimes
it
is
useful
to
group
all
management
endpoints
under
a
single
path
.
For
example
,
your
application
might
already
use
`/
info
`
for
another
purpose
.
You
can
use
the
your
application
might
already
use
`/
info
`
for
another
purpose
.
You
can
use
the
`
management
.
context
P
ath
`
property
to
set
a
prefix
for
your
management
endpoint
:
`
management
.
context
-
p
ath
`
property
to
set
a
prefix
for
your
management
endpoint
:
[
source
,
properties
,
indent
=
0
]
[
source
,
properties
,
indent
=
0
]
----
----
...
@@ -500,7 +500,7 @@ If you don't want to expose endpoints over HTTP you can set the management port
...
@@ -500,7 +500,7 @@ If you don't want to expose endpoints over HTTP you can set the management port
[[
production
-
ready
-
health
-
access
-
restrictions
]]
[[
production
-
ready
-
health
-
access
-
restrictions
]]
===
HTTP
H
ealth
endpoint
access
restrictions
===
HTTP
h
ealth
endpoint
access
restrictions
The
information
exposed
by
the
health
endpoint
varies
depending
on
whether
or
not
it
's
The
information
exposed
by
the
health
endpoint
varies
depending
on
whether
or
not
it
's
accessed anonymously. By default, when accessed anonymously, any details about the
accessed anonymously. By default, when accessed anonymously, any details about the
server'
s
health
are
hidden
and
the
endpoint
will
simply
indicate
whether
or
not
the
server
server'
s
health
are
hidden
and
the
endpoint
will
simply
indicate
whether
or
not
the
server
...
@@ -611,7 +611,7 @@ dependency to `spring-boot-starter-remote-shell`:
...
@@ -611,7 +611,7 @@ dependency to `spring-boot-starter-remote-shell`:
</
dependency
>
</
dependency
>
----
----
TIP
:
If
you
want
to
also
enable
telnet
access
you
r
will
additionally
need
a
dependency
TIP
:
If
you
want
to
also
enable
telnet
access
you
will
additionally
need
a
dependency
on
`
org
.
crsh
:
crsh
.
shell
.
telnet
`.
on
`
org
.
crsh
:
crsh
.
shell
.
telnet
`.
...
@@ -646,7 +646,7 @@ download and install http://www.putty.org/[PuTTY].
...
@@ -646,7 +646,7 @@ download and install http://www.putty.org/[PuTTY].
::
Spring
Boot
::
(
v
{
spring
-
boot
-
version
})
on
myhost
::
Spring
Boot
::
(
v
{
spring
-
boot
-
version
})
on
myhost
----
----
Type
`
help
`
for
a
list
of
commands
.
Spring
b
oot
provides
`
metrics
`,
`
beans
`,
`
autoconfig
`
Type
`
help
`
for
a
list
of
commands
.
Spring
B
oot
provides
`
metrics
`,
`
beans
`,
`
autoconfig
`
and
`
endpoint
`
commands
.
and
`
endpoint
`
commands
.
...
@@ -676,7 +676,7 @@ for details). By default Spring Boot will search for commands in the following l
...
@@ -676,7 +676,7 @@ for details). By default Spring Boot will search for commands in the following l
*
`+
classpath
*:/
commands
/**+`
*
`+
classpath
*:/
commands
/**+`
*
`+
classpath
*:/
crash
/
commands
/**+`
*
`+
classpath
*:/
crash
/
commands
/**+`
TIP
:
You
can
change
the
search
path
by
settings
a
`
shell
.
command
PathP
atterns
`
property
.
TIP
:
You
can
change
the
search
path
by
settings
a
`
shell
.
command
-
path
-
p
atterns
`
property
.
Here
is
a
simple
'`hello world`'
command
that
could
be
loaded
from
Here
is
a
simple
'`hello world`'
command
that
could
be
loaded
from
`
src
/
main
/
resources
/
commands
/
hello
.
groovy
`
`
src
/
main
/
resources
/
commands
/
hello
.
groovy
`
...
@@ -793,13 +793,13 @@ NOTE: In this example we are actually accessing the endpoint over HTTP using the
...
@@ -793,13 +793,13 @@ NOTE: In this example we are actually accessing the endpoint over HTTP using the
===
System
metrics
===
System
metrics
The
following
system
metrics
are
exposed
by
Spring
Boot
:
The
following
system
metrics
are
exposed
by
Spring
Boot
:
*
The
total
system
memory
in
K
b
(`
mem
`)
*
The
total
system
memory
in
K
B
(`
mem
`)
*
The
amount
of
free
memory
in
K
b
(`
mem
.
free
`)
*
The
amount
of
free
memory
in
K
B
(`
mem
.
free
`)
*
The
number
of
processors
(`
processors
`)
*
The
number
of
processors
(`
processors
`)
*
The
system
uptime
in
milliseconds
(`
uptime
`)
*
The
system
uptime
in
milliseconds
(`
uptime
`)
*
The
application
context
uptime
in
milliseconds
(`
instance
.
uptime
`)
*
The
application
context
uptime
in
milliseconds
(`
instance
.
uptime
`)
*
The
average
system
load
(`
systemload
.
average
`)
*
The
average
system
load
(`
systemload
.
average
`)
*
Heap
information
in
K
b
(`
heap
`,
`
heap
.
committed
`,
`
heap
.
init
`,
`
heap
.
used
`)
*
Heap
information
in
K
B
(`
heap
`,
`
heap
.
committed
`,
`
heap
.
init
`,
`
heap
.
used
`)
*
Thread
information
(`
threads
`,
`
thread
.
peak
`,
`
thead
.
daemon
`)
*
Thread
information
(`
threads
`,
`
thread
.
peak
`,
`
thead
.
daemon
`)
*
Class
load
information
(`
classes
`,
`
classes
.
loaded
`,
`
classes
.
unloaded
`)
*
Class
load
information
(`
classes
`,
`
classes
.
loaded
`,
`
classes
.
unloaded
`)
*
Garbage
collection
information
(`
gc
.
xxx
.
count
`,
`
gc
.
xxx
.
time
`)
*
Garbage
collection
information
(`
gc
.
xxx
.
count
`,
`
gc
.
xxx
.
time
`)
...
@@ -822,13 +822,13 @@ for each data source:
...
@@ -822,13 +822,13 @@ for each data source:
*
If
the
data
source
is
the
primary
data
source
(
that
is
either
the
only
available
data
*
If
the
data
source
is
the
primary
data
source
(
that
is
either
the
only
available
data
source
or
the
one
flagged
`@
Primary
`
amongst
the
existing
ones
),
the
prefix
is
source
or
the
one
flagged
`@
Primary
`
amongst
the
existing
ones
),
the
prefix
is
`
datasource
.
primary
`.
`
datasource
.
primary
`.
*
If
the
data
source
bean
name
ends
with
`
d
ataSource
`,
the
prefix
is
the
name
of
the
bean
*
If
the
data
source
bean
name
ends
with
`
D
ataSource
`,
the
prefix
is
the
name
of
the
bean
without
`
d
ataSource
`
(
i
.
e
.
`
datasource
.
batch
`
for
`
batchDataSource
`).
without
`
D
ataSource
`
(
i
.
e
.
`
datasource
.
batch
`
for
`
batchDataSource
`).
*
In
all
other
cases
,
the
name
of
the
bean
is
used
.
*
In
all
other
cases
,
the
name
of
the
bean
is
used
.
It
is
possible
to
override
part
or
all
of
those
defaults
by
registering
a
bean
with
a
It
is
possible
to
override
part
or
all
of
those
defaults
by
registering
a
bean
with
a
customized
version
of
`
DataSourcePublicMetrics
`.
By
default
,
Spring
Boot
provides
metadata
customized
version
of
`
DataSourcePublicMetrics
`.
By
default
,
Spring
Boot
provides
metadata
for
all
supported
data
sources
;
you
can
add
additional
`
DataSourcePoolMetadataProvider
`
for
all
supported
data
sources
;
you
can
add
additional
`
DataSourcePoolMetadataProvider
`
beans
if
your
favorite
data
source
isn
't supported out of the box. See
beans
if
your
favorite
data
source
isn
't supported out of the box. See
`DataSourcePoolMetadataProvidersConfiguration` for examples.
`DataSourcePoolMetadataProvidersConfiguration` for examples.
...
@@ -918,7 +918,7 @@ automatically find that Spring Boot metrics are published to
...
@@ -918,7 +918,7 @@ automatically find that Spring Boot metrics are published to
Spring bean will be created when you declare a dependency to the
Spring bean will be created when you declare a dependency to the
`io.dropwizard.metrics:metrics-core` library; you can also register you own `@Bean`
`io.dropwizard.metrics:metrics-core` library; you can also register you own `@Bean`
instance if you need customizations. Metrics from the `MetricRegistry` are also
instance if you need customizations. Metrics from the `MetricRegistry` are also
automatically exposed via the `/metrics` endpoint
automatically exposed via the `/metrics` endpoint
.
Users can create Dropwizard metrics by prefixing their metric names with the appropriate
Users can create Dropwizard metrics by prefixing their metric names with the appropriate
type (e.g. `+histogram.*+`, `+meter.*+`).
type (e.g. `+histogram.*+`, `+meter.*+`).
...
@@ -991,7 +991,7 @@ and obtain basic information about the last few requests:
...
@@ -991,7 +991,7 @@ and obtain basic information about the last few requests:
=== Custom tracing
=== Custom tracing
If you need to trace additional events you can inject a
If you need to trace additional events you can inject a
{sc-spring-boot-actuator}/trace/TraceRepository.{sc-ext}[`TraceRepository`] into your
{sc-spring-boot-actuator}/trace/TraceRepository.{sc-ext}[`TraceRepository`] into your
Spring
B
eans. The `add` method accepts a single `Map` structure that will be converted to
Spring
b
eans. The `add` method accepts a single `Map` structure that will be converted to
JSON and logged.
JSON and logged.
By default an `InMemoryTraceRepository` will be used that stores the last 100 events. You
By default an `InMemoryTraceRepository` will be used that stores the last 100 events. You
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment