SpringCloud/spring-cloud-bus
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs from master to gh-pages

Browse Source
This commit is contained in:
buildmaster
2019-09-10 15:55:28 +00:00
parent 8a7b27b756
commit 4a01443fd4
4 changed files with 302 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
reference/html/spring-cloud-bus.html
View File

@@ -96,23 +96,24 @@ $(addBlockSwitches);
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_quick_start">Quick Start</a></li>
<li><a href="#_bus_endpoints">Bus Endpoints</a>
<li><a href="#quick-start">1. Quick Start</a></li>
<li><a href="#bus-endpoints">2. Bus Endpoints</a>
<ul class="sectlevel2">
<li><a href="#_bus_refresh_endpoint">Bus Refresh Endpoint</a></li>
<li><a href="#_bus_env_endpoint">Bus Env Endpoint</a></li>
<li><a href="#bus-refresh-endpoint">2.1. Bus Refresh Endpoint</a></li>
<li><a href="#bus-env-endpoint">2.2. Bus Env Endpoint</a></li>
</ul>
</li>
<li><a href="#_addressing_an_instance">Addressing an Instance</a></li>
<li><a href="#_addressing_all_instances_of_a_service">Addressing All Instances of a Service</a></li>
<li><a href="#_service_id_must_be_unique">Service ID Must Be Unique</a></li>
<li><a href="#_customizing_the_message_broker">Customizing the Message Broker</a></li>
<li><a href="#_tracing_bus_events">Tracing Bus Events</a></li>
<li><a href="#_broadcasting_your_own_events">Broadcasting Your Own Events</a>
<li><a href="#addressing-an-instance">3. Addressing an Instance</a></li>
<li><a href="#addressing-all-instances-of-a-service">4. Addressing All Instances of a Service</a></li>
<li><a href="#service-id-must-be-unique">5. Service ID Must Be Unique</a></li>
<li><a href="#customizing-the-message-broker">6. Customizing the Message Broker</a></li>
<li><a href="#tracing-bus-events">7. Tracing Bus Events</a></li>
<li><a href="#broadcasting-your-own-events">8. Broadcasting Your Own Events</a>
<ul class="sectlevel2">
<li><a href="#_registering_events_in_custom_packages">Registering events in custom packages</a></li>
<li><a href="#registering-events-in-custom-packages">8.1. Registering events in custom packages</a></li>
</ul>
</li>
<li><a href="#configuration-properties">9. Configuration properties</a></li>
</ul>
</div>
</div>
@@ -134,7 +135,7 @@ either an AMQP broker or Kafka as the transport.</p>
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at <a href="https://github.com/spring-cloud/spring-cloud-config/tree/master/docs/src/main/asciidoc">github</a>.
Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at {docslink}[github].
</td>
</tr>
</table>
@@ -142,7 +143,7 @@ Spring Cloud is released under the non-restrictive Apache 2.0 license. If you wo
</div>
</div>
<div class="sect1">
<h2 id="_quick_start"><a class="link" href="#_quick_start">Quick Start</a></h2>
<h2 id="quick-start"><a class="anchor" href="#quick-start"></a><a class="link" href="#quick-start">1. Quick Start</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Spring Cloud Bus works by adding Spring Boot autconfiguration if it detects itself on the
@@ -189,7 +190,7 @@ works with <code>spring-cloud-bus</code>.
</div>
</div>
<div class="sect1">
<h2 id="_bus_endpoints"><a class="link" href="#_bus_endpoints">Bus Endpoints</a></h2>
<h2 id="bus-endpoints"><a class="anchor" href="#bus-endpoints"></a><a class="link" href="#bus-endpoints">2. Bus Endpoints</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Spring Cloud Bus provides two endpoints, <code>/actuator/bus-refresh</code> and <code>/actuator/bus-env</code>
@@ -197,7 +198,7 @@ that correspond to individual actuator endpoints in Spring Cloud Commons,
<code>/actuator/refresh</code> and <code>/actuator/env</code> respectively.</p>
</div>
<div class="sect2">
<h3 id="_bus_refresh_endpoint"><a class="link" href="#_bus_refresh_endpoint">Bus Refresh Endpoint</a></h3>
<h3 id="bus-refresh-endpoint"><a class="anchor" href="#bus-refresh-endpoint"></a><a class="link" href="#bus-refresh-endpoint">2.1. Bus Refresh Endpoint</a></h3>
<div class="paragraph">
<p>The <code>/actuator/bus-refresh</code> endpoint clears the <code>RefreshScope</code> cache and rebinds
<code>@ConfigurationProperties</code>. See the <a href="#refresh-scope">Refresh Scope</a> documentation for
@@ -214,7 +215,7 @@ application:</p>
</div>
</div>
<div class="sect2">
<h3 id="_bus_env_endpoint"><a class="link" href="#_bus_env_endpoint">Bus Env Endpoint</a></h3>
<h3 id="bus-env-endpoint"><a class="anchor" href="#bus-env-endpoint"></a><a class="link" href="#bus-env-endpoint">2.2. Bus Env Endpoint</a></h3>
<div class="paragraph">
<p>The <code>/actuator/bus-env</code> endpoint updates each instances environment with the specified
key/value pair across multiple instances.</p>
@@ -234,8 +235,8 @@ application:</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{
"name": "key1",
"value": "value1"
"name": "key1",
"value": "value1"
}</code></pre>
</div>
</div>
@@ -243,7 +244,7 @@ application:</p>
</div>
</div>
<div class="sect1">
<h2 id="_addressing_an_instance"><a class="link" href="#_addressing_an_instance">Addressing an Instance</a></h2>
<h2 id="addressing-an-instance"><a class="anchor" href="#addressing-an-instance"></a><a class="link" href="#addressing-an-instance">3. Addressing an Instance</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Each instance of the application has a service ID, whose value can be set with
@@ -276,7 +277,7 @@ ignore it.</p>
</div>
</div>
<div class="sect1">
<h2 id="_addressing_all_instances_of_a_service"><a class="link" href="#_addressing_all_instances_of_a_service">Addressing All Instances of a Service</a></h2>
<h2 id="addressing-all-instances-of-a-service"><a class="anchor" href="#addressing-all-instances-of-a-service"></a><a class="link" href="#addressing-all-instances-of-a-service">4. Addressing All Instances of a Service</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The &#8220;destination&#8221; parameter is used in a Spring <code>PathMatcher</code> (with the path separator
@@ -287,7 +288,7 @@ from earlier, <code>/bus-env/customers:**</code> targets all instances of the
</div>
</div>
<div class="sect1">
<h2 id="_service_id_must_be_unique"><a class="link" href="#_service_id_must_be_unique">Service ID Must Be Unique</a></h2>
<h2 id="service-id-must-be-unique"><a class="anchor" href="#service-id-must-be-unique"></a><a class="link" href="#service-id-must-be-unique">5. Service ID Must Be Unique</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The bus tries twice to eliminate processing an event&#8201;&#8212;&#8201;once from the original
@@ -301,7 +302,7 @@ something unique for each instance of a service.</p>
</div>
</div>
<div class="sect1">
<h2 id="_customizing_the_message_broker"><a class="link" href="#_customizing_the_message_broker">Customizing the Message Broker</a></h2>
<h2 id="customizing-the-message-broker"><a class="anchor" href="#customizing-the-message-broker"></a><a class="link" href="#customizing-the-message-broker">6. Customizing the Message Broker</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Spring Cloud Bus uses <a href="https://cloud.spring.io/spring-cloud-stream">Spring Cloud Stream</a> to
@@ -322,7 +323,7 @@ Stream documentation.</p>
</div>
</div>
<div class="sect1">
<h2 id="_tracing_bus_events"><a class="link" href="#_tracing_bus_events">Tracing Bus Events</a></h2>
<h2 id="tracing-bus-events"><a class="anchor" href="#tracing-bus-events"></a><a class="link" href="#tracing-bus-events">7. Tracing Bus Events</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Bus events (subclasses of <code>RemoteApplicationEvent</code>) can be traced by setting
@@ -392,7 +393,7 @@ queries on the data or forward it to a specialized tracing service.
</div>
</div>
<div class="sect1">
<h2 id="_broadcasting_your_own_events"><a class="link" href="#_broadcasting_your_own_events">Broadcasting Your Own Events</a></h2>
<h2 id="broadcasting-your-own-events"><a class="anchor" href="#broadcasting-your-own-events"></a><a class="link" href="#broadcasting-your-own-events">8. Broadcasting Your Own Events</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The Bus can carry any event of type <code>RemoteApplicationEvent</code>. The default transport is
@@ -417,7 +418,7 @@ Both the producer and the consumer need access to the class definition.
</table>
</div>
<div class="sect2">
<h3 id="_registering_events_in_custom_packages"><a class="link" href="#_registering_events_in_custom_packages">Registering events in custom packages</a></h3>
<h3 id="registering-events-in-custom-packages"><a class="anchor" href="#registering-events-in-custom-packages"></a><a class="link" href="#registering-events-in-custom-packages">8.1. Registering events in custom packages</a></h3>
<div class="paragraph">
<p>If you cannot or do not want to use a subpackage of <code>org.springframework.cloud.bus.event</code>
for your custom events, you must specify which packages to scan for events of type
@@ -493,6 +494,14 @@ You can specify multiple base packages to scan.
</div>
</div>
</div>
<div class="sect1">
<h2 id="configuration-properties"><a class="anchor" href="#configuration-properties"></a><a class="link" href="#configuration-properties">9. Configuration properties</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>To see the list of all Bus related configuration properties please check <a href="appendix.html">the Appendix page</a>.</p>
</div>
</div>
</div>
</div>
<script type="text/javascript" src="js/tocbot/tocbot.min.js"></script>
<script type="text/javascript" src="js/toc.js"></script>