Commit Graph

112 Commits

Author SHA1 Message Date
Phillip Webb a087dbc9c3 Add flyway and liquibase endpoint documentation
See gh-3434
2015-07-07 18:58:25 -07:00
Phillip Webb e8085016ba Polish Actuator hypermedia support 2015-07-05 22:28:04 -07:00
izeye 631a02b8bc Fix typo
Closes gh-3403
2015-07-02 07:02:54 -07:00
Dave Syer 74e9e0749b Add support for Spring HATEOAS hypermedia in Actuator endpoints
If spring-hateoas is on the classpath and an MvcEndpoint returns a
@ResponseBody it will be extended and wrapped into a Resource with links.
All the existing endpoints that return sensible JSON data can be extended
this way (i.e. not /logfile). The HAL browser will also be added as an
endpoint if available on the classpath. Finally, asciidocs for the
Actuator endpoints are available as a separate jar file, which if
included in an app will also generate a new (HTTP) endpoint.

Fixes gh-1390
2015-07-02 13:26:02 +01:00
Phillip Webb b5c435f8c4 Polish Actuator MVC customization support
See gh-3345
2015-06-30 22:09:38 -07:00
Dave Syer 1e464da248 Refactor the Actuator MVC configuration to allow more customization
There is a new spring.factories entry for
org.springframework.boot.actuate.autoconfigure.EndpointWebMvcConfiguration
which loads extra beans into the MVC config for the Actuator.
If the management context is a child context all the beans go in the
child (except the Spring Security filter still). A big bonus is that
you can add WebConfigurerAdapters to configure static resources etc.
A new component called ManagementContextResolver can be used to
locate the ApplicationContext for the MVC endpoints.

Fixes gh-3345
2015-06-30 09:42:58 +01:00
Phillip Webb d213cc05d5 Polish 2015-06-29 16:48:59 -07:00
Dave Syer 46fbca66a6 Fix typo 'a' -> 'an' 2015-06-29 06:43:25 +01:00
Dave Syer c39b9f7635 Tweak docs on /health endpoint to reflect secure/sensitive
Fixes gh-2816
2015-06-28 22:13:17 +01:00
izeye 4bc7919e04 Polish doc
Closes gh-3344
2015-06-28 06:33:52 -07:00
Stephane Nicoll af1afeaf48 Merge branch '1.2.x' 2015-06-24 17:20:49 +02:00
Stephane Nicoll 982b81c675 Fix datasource metrics doc
The maximum and minimum number of connections are no metrics so these
are not exposed. Fix the doc that stated the contrary.

Fixes gh-3319
2015-06-24 17:20:31 +02:00
Johannes Stelzer 308a5eaff5 Add /logfile MVC actuator endpoint
Add a `/logfile` endpoint which can be used to fetch the contents of
the log file (if one is being used).

Fixes gh-2137
Closes gh-2294
2015-06-23 17:14:40 -07:00
Stephane Nicoll bb4c89592d Merge branch '1.2.x' 2015-06-14 09:36:25 +02:00
Stephane Nicoll 01ba732a73 Consistent use of "=" for property key
Closes gh-3218
2015-06-14 09:36:10 +02:00
Phillip Webb c7677d10ca Polish documentation 2015-06-05 15:58:14 -07:00
izeye 9bac5b6455 Remove invalid parts of docs after refactoring 2015-06-05 17:02:12 +02:00
Dave Syer cc169c5009 Change the way the AggregateMetricReader works to make it easier
for users to get started. It also makes it more flexible if different
aggregation keys are needed depending on the environment. The most
important new feature is the
spring.metrics.export.redis.aggregateKeyPattern configuration, which
fits the *.redis.key and prefix defaults. The aggregate reader uses
a prefix based on the key by default, with a naming convention that
the key starts with "keys.".
2015-06-05 11:54:06 +01:00
Phillip Webb 312471f996 Polish documentation 2015-06-04 01:09:59 -07:00
Stephane Nicoll fbfdbce266 Add cache documentation
See gh-2633
2015-06-02 11:25:24 +02:00
Stephane Nicoll fc0eed97cf Fix build 2015-06-01 13:25:53 +02:00
Dave Syer 8a83bd12bd Refactor annotations for metric export
Users can add @ExportMetric[Reader,Writer] to readers and writers that
they want to participate in the default exporter. There is also still an
@ActuatorMetricWriter that is used for the legacy (non-Java8) Gauge and
CounterServices.
2015-05-31 12:51:07 +01:00
Dave Syer 80ff92919c Add redis properties as convenience in spring.metrics.export
The redis export and aggregate use case is a lot nicer with this
shared data between the two component types.

Also made MetricExportProperties itself a Trigger (so the default
delay etc. can be configured via spring.metrics.export.*).
2015-05-31 12:18:43 +01:00
Stephane Nicoll fc61f2e837 Improve documentation for JMX related keys
Closes gh-2747
2015-05-27 11:36:34 +02:00
Dave Syer 3fda744522 Add samples and tweak metrics reader/writers till they work 2015-05-13 13:56:02 +01:00
Dave Syer 60a4943520 Add support for metric export to OpenTSDB 2015-05-13 13:56:02 +01:00
Dave Syer 0bd845d183 Add support for Statsd metric export 2015-05-13 13:56:02 +01:00
Dave Syer 0fde04d325 Add AggregateMetricReader able to aggregate counters and gauges
Different physical sources for the same logical metric just need to
publish them with a period-separated prefix, and this reader will
aggregate (by truncating the metric names, dropping the prefix).

Very useful (for instance) if multiple application instances are
feeding to a central (e.g. redis) repository and you want to
display the results. Useful in conjunction with a
MetricReaderPublicMetrics for hooking up to the /metrics endpoint.
2015-05-13 13:56:01 +01:00
Dave Syer 53a61474aa Add counter and gauge services based on in-memory buffers
This seems pretty efficient (approx 12M write/s as opposed to 2M with
the DefaultCounterService). N.B. there is no need to change most of
the rest of the metrics stuff because metrics are write-often, read-
seldom, so we don't need high performance reads as much.

The Spring Integration configuration and Dropwizard support has changed
a bit. Functionally very similar and probably opaque to users, but now
the messaging operates as an Exporter on a @Scheduled method, and
Dropwizard is a replacement [Gauge,Counter]Service.

Metrics are all
collected live in-memory (and can be very fast with Java 8), buffered
there and shipped out to a MessageChannel (if one exists with id
"metricsChannel") in a background thread.

We can still use Java 8 library APIs (like LongAdder) but to compile
to java 7 compatible byte code we have to forgo the use of lambdas :-(
and shorthand generics (<>).

Fixes gh-2682, fixes gh-2513 (for Java 8 and Dropwizard users).
2015-05-13 13:56:01 +01:00
Andy Wilkinson 01b45d0c3a Merge branch '1.2.x' 2015-04-21 15:28:37 +01:00
izeye 68ed4dec9b Polish production ready features documentation
Closes gh-2832
2015-04-21 15:28:07 +01:00
Phillip Webb ed57adb5fe Update deployment documentation
Change the "cloud deployment" section to cover general "deployment" and
add documentation for init.d and systemd support.

Closes gh-1117
2015-04-09 10:57:40 -07:00
Phillip Webb 7c9ab5ced2 Minor documentation polish 2015-03-23 09:31:08 -07:00
Marcel Overdijk c0c67f2593 Update doc
Add note about escaping Spring property placeholders when using Gradle
automatic expansion.

Closes gh-2695
2015-03-22 10:07:44 +01:00
izeye 1493da1e03 Improve documentation
Closes gh-2553
2015-02-25 11:32:58 -08:00
Phillip Webb 56e31a8c6b Polish 2015-02-23 19:21:37 -08:00
StevenGeens dc97d56cb7 Update documentation on resources filtering
Add an explicit note about the spring-boot:run goal that prevents the use
of resources filtering by default.
2015-02-20 13:28:13 +01:00
Eric Dahl aa43f5e037 Update custom HealthIndicator documentation
Update the custom HealthIndicator documentation to use the build()
method rather than the old mechanism.

Fixes gh-2270
2014-12-31 18:53:58 -08:00
Stephane Nicoll 05d47c65db Fix wrong link
Closes gh-2223
2014-12-23 17:38:55 +01:00
John 62d3f73e24 Fix "heath" misspellings 2014-12-10 15:25:07 -08:00
Phillip Webb a27217ae43 Provide a way to opt-in to endpoint enablement
Update AbstractEndpoint so that the `enable` property is optional and
when it not specified the `endpoints.enabled` property will be used.

This allows users to switch the way that endpoints are enabled. Rather
than opting-out specific endpoint enablement the `endpoints.enabled`
property can be set to `false` and specific endpoints can be opted-in.

Fixes gh-2102
2014-12-10 12:39:34 -08:00
Phillip Webb 3e2433c842 Update health endpoint sensitive flag in docs 2014-12-10 12:39:34 -08:00
John 3343cd4c90 Fix typo in documentation 2014-12-10 07:49:13 -05:00
Phillip Webb e772174019 Update reference documentation for Spring Boot 1.2
Various updates and polish to prepare the reference documentation for
Spring Boot 1.2.

Fixes gh-1903
2014-12-10 00:56:41 -08:00
Phillip Webb e5295c0142 Update HealthInformation reference documentation
Clean and align with changes in Spring Boot 1.2

Fixes gh-2104
2014-12-10 00:51:30 -08:00
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