Commit Graph

67 Commits

Author SHA1 Message Date
Phillip Webb 48db5457f1 Polish 2014-12-01 19:32:05 -08:00
Dave Syer 3bb598a421 Only hide /health details if the app is actually secure
Also gives the user the option to override (by setting
endpoints.health.sensitive=false).

Fixes gh-1977 in a slightly different way
2014-11-25 16:40:18 +00:00
Andy Wilkinson a708b28d9d Document restrictions when /health is accessed anonymously
Closes gh-1978
2014-11-25 12:22:23 +00:00
Stephane Nicoll 00961611b2 Move health.* properties to management.health.*
Fixes gh-1841
2014-11-07 07:20:34 +00:00
Phillip Webb edaed415fb Polish 2014-11-04 09:09:26 -08:00
Dave Syer 8be97fa47d Tweak docs on Maven resource filtering some more 2014-11-04 10:41:47 +00:00
Andy Wilkinson bd562c06b6 Merge branch '1.1.x' 2014-10-28 11:06:23 +00:00
Andy Wilkinson f58b8366e1 Correct the syntax that's used for smart single and double quotes
Fixes gh-1753
2014-10-28 11:03:35 +00:00
Andy Wilkinson 7211571969 Fix some grammar issues in docs
Closes gh-1695
2014-10-13 13:18:24 +01:00
Eric Dahl 16937746a0 Fix some grammar issues in docs 2014-10-13 12:22:14 +01:00
Phillip Webb 6281070d0a Merge branch '1.1.x'
Conflicts:
	spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
2014-10-09 13:00:27 -07:00
Phillip Webb 7e842aee77 Escape `...*...` outputs using `+...*...+` 2014-10-09 12:41:39 -07:00
Dave Syer 8ffe7ec4b8 Fix asciidoctor syntax problems and updgrade to asciidoctor 1.5
Points to note for authors:

* Nesting "*" in `literals` does not behave like Markdown - you have to
escape the asterisk (e.g. `foo/\*`)

* Quote ligatures (why we had to use those I don't really know) are
different in asciidoctor 1.5 ('`foo`' instead of ``foo'')

Merge branch '1.1.x'

Conflicts:
	spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
	spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
2014-10-09 10:58:06 +01:00
Dave Syer 6a503d5ca9 Fix loads of asciidoc errors 2014-10-09 10:51:25 +01:00
Phillip Webb 6a423d7ad1 Add EmbeddedServerPortFileWriter
Add a EmbeddedServerPortFileWriter which can be used to write server
port information to a file.

Fixes gh-1275
Closes gh-1491
2014-10-08 23:03:35 -07:00
Phillip Webb 77ccd9a80b Rename ApplicationPidListener
Rename ApplicationPidListener to ApplicationPidFileWriter (keeping the
old class in a deprecated form)

Fixes gh-1673
2014-10-08 21:30:35 -07:00
Andy Wilkinson 97178915a4 Polish disk space health indicator
- Supply auto-configuration for the new indicator
 - As suggested in the pull request, include the free disk space and
   configured threshold in the health details
 - Update the documentation to describe the indicator and its
   two configuration settings
 - Use @ConfigurationProperties to bind the indicator's configuration.
   This should make the changes sympathetic to the work being done
   to automate the configuration properties documentation

Closes gh-1297
2014-10-08 17:24:38 +01:00
Phillip Webb 565e449d89 Merge branch '1.1.x'
Conflicts:
	spring-boot-docs/src/main/asciidoc/howto.adoc
2014-09-15 11:37:50 -07:00
Phillip Webb 5ba86a103d Polish 2014-09-15 11:35:16 -07:00
Andy Wilkinson 8deb88b3c0 Merge branch '1.1.x' 2014-09-15 16:40:42 +01:00
Andy Wilkinson 2ba2cfe23d Document build-time property expansion using Gradle
Closes gh-1540
2014-09-15 16:25:00 +01:00
Dave Syer bfab6b45f5 Merge branch '1.1.x' 2014-09-13 11:01:10 -05:00
Dave Syer 7828f2a5d3 Update docs on metrics names 2014-09-13 11:00:55 -05:00
Phillip Webb 5001b038cb Expose additional pool metrics
Expose `max` and `min`, alongside the existing `active` and `usage`
metrics.
2014-09-01 12:38:31 -07:00
Stephane Nicoll 53c4859a6a Reuse data source validation query in health endpoint
This commit improves DataSourceMetadata to expose the validation
query. This can be used by DataSourceHealthIndicator as the query
to use instead of "guessing" which query could be applied according
to the database type.

Fixes gh-1282
2014-08-29 14:58:01 +02:00
Stephane Nicoll 3dc932db88 DataSource metrics
This commit adds an abstraction that provides a standard manner to
retrieve various metadata that are shared by most data sources.

DataSourceMetadata is implemented by the three data source
implementations that boot supports out-of-the-box: Tomcat, Hikari and
Commons dbcp.

This abstraction is used to provide two additional metrics per data
source defined in the application: the number of allocated
connection(s) (.active) and the current usage of the connection pool
(.usage).

All such metrics share the 'datasource.' prefix. The prefix is further
qualified for each data source:

* 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 "datasource.primary"
* If the data source bean name ends with "dataSource", the prefix is
  the name of the bean without it (i.e. batchDataSource becomes batch)
* 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 customized version of
DataSourcePublicMetrics.

Additional DataSourceMetadata implementations for other data source
types can be added very easily, check
DataourceMetadataProvidersConfiguration for more details.

Fixes gh-1013
2014-08-29 11:22:11 +02:00
Dave Syer 330be01984 Merge branch '1.1.x'
Conflicts:
	spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
2014-08-13 08:23:43 -07:00
Dave Syer 481cf775d8 Refer explicitly to double asterix in metrics docs
Fixes gh-1358
2014-08-13 08:21:22 -07:00
Dave Syer e63bad3c4e Merge branch '1.1.x' 2014-08-13 08:19:33 -07:00
Dave Syer 0a3a00e9e5 Fix property keys in shell docs (consistent with appendix)
Fixes gh-1371
2014-08-13 08:18:42 -07:00
Phillip Webb 14c6243637 Refactor PublicMetrics registration
Rework flexible PublicMetrics registration introduced in 2be6b3e4 to
restore compatibility with v1.1 VanillaPublicMetrics. The new
MetricReaderPublicMetrics class now exposes metrics from a MetricReader
and VanillaPublicMetrics is deprecated. The MetricsEndpoint can now
exposes a collection of PublicMetric interface directly.

See gh-1094
2014-07-29 12:31:40 -07:00
Stephane Nicoll 2be6b3e419 Flexible registration of additional PublicMetrics
This commit permits the use of several PublicMetrics instances by
default. Previously, only one PublicMetrics service could be specified
and a user configuration would remove all the defaulting.

VanillaPublicMetrics now takes a collection of PublicMetrics and
invokes them in sequence to build the final collection of metrics.
The system-related metrics have been moved to SystemPublicMetrics and
are registered by default.

Also updated the documentation to mention this feature and how it
could be fully overridden.

Fixes gh-1094
2014-07-17 16:19:05 +02:00
Phillip Webb 62d2b4136a Polish documentation
Apply consistent styling and edit a few section for clarity.
2014-06-06 22:56:44 -07:00
Dave Syer c41fa08a80 Cross link Actuator and User Guide docs
Not having READMEs in github is a mistake IMO, so here's one
restored and with a link to the docs. Docs also updated to
more accurately reflect the location of the actuator features
in implementation.

See https://github.com/spring-guides/gs-actuator-service/pull/7
for the Getting started guide change

Fixes gh-1014
2014-06-04 14:27:29 +01:00
Christian Dupuis e104b34106 Fix HealthIndicator documentation
fixes #1018
2014-06-03 15:22:52 +02:00
Phillip Webb a3c359ab84 Remove trailing whitespace 2014-05-23 10:08:55 +01:00
Eric Dahl 3457cc4f39 Fix multiple typos in documentation, as well as "thread.deamon" typo in actuator 2014-05-22 21:18:08 -05:00
Christian Dupuis d20ed65c61 Update docs for new extended health support
fixes #930
2014-05-22 22:53:08 +02:00
Dave Syer 0dca2dd978 Small docs tweaks in metrics 2014-05-22 14:51:19 +01:00
Christian Dupuis 0402ed38f7 Update documentation to include note about RabbitMQ health support 2014-05-10 11:17:01 +02:00
Phillip Webb 1acffdf649 Polish 2014-05-09 08:52:11 +01:00
Christian Dupuis 893654bdd1 Update documentation for new HealthIndicator support 2014-05-08 16:21:06 +02:00
Stephane Nicoll a330cb9b8a Improve remote shell security documentation
Previous to this commit, the remote shell security configuration
described that a default password will be generated with no extra
configuration. Actually, when Spring Security is configured for the
application, the remote shell reuses that configuration by default.

It turns out that the default log message is confusing as it was
referring to "application endpoints". Updated that log to a more
generic log message and updated doc accordingly.

Fixes gh-779
2014-05-05 11:12:27 +02:00
Phillip Webb 6025f45aa0 Polish 2014-04-30 21:53:24 +01:00
Christian Dupuis a66fc3030e Add more runtime metrics like information about heap, class loading and threads to the metrics infrastructure 2014-04-30 15:22:56 +02:00
Dave Syer ef4e83a879 Move ErrorController to autoconfig 2014-04-29 15:23:29 +01:00
Phillip Webb fad5ce45db Polish 2014-04-23 12:35:33 +01:00
Lukasz Kryger 9907e70609 Minor documentation fixes 2014-04-16 10:48:36 +01:00
Dave Syer fb29a3c318 Expand Error Handling section in docs a bit
Fixes gh-513
2014-04-15 07:23:41 -07:00
Jakub Kubrynski 3ebaf11550 Extended documentation for applicaiton pid monitoring 2014-04-11 21:19:18 +02:00